Skip to content

Commit c207cf4

Browse files
authored
feat(clients): update clients as of 01/28/2022 (#3263)
1 parent fe8efe5 commit c207cf4

File tree

230 files changed

+15459
-5517
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

230 files changed

+15459
-5517
lines changed

clients/client-amplify/src/models/models_0.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface AutoBranchCreationConfig {
4343
environmentVariables?: { [key: string]: string };
4444

4545
/**
46-
* <p> The basic authorization credentials for the autocreated branch. </p>
46+
* <p> The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>
4747
*/
4848
basicAuthCredentials?: string;
4949

@@ -211,7 +211,7 @@ export interface CreateAppRequest {
211211
enableBasicAuth?: boolean;
212212

213213
/**
214-
* <p> The credentials for basic authorization for an Amplify app. </p>
214+
* <p> The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>
215215
*/
216216
basicAuthCredentials?: string;
217217

@@ -383,7 +383,7 @@ export interface App {
383383
enableBasicAuth: boolean | undefined;
384384

385385
/**
386-
* <p> The basic authorization credentials for branches for the Amplify app. </p>
386+
* <p> The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>
387387
*/
388388
basicAuthCredentials?: string;
389389

@@ -645,7 +645,7 @@ export interface CreateBranchRequest {
645645
environmentVariables?: { [key: string]: string };
646646

647647
/**
648-
* <p> The basic authorization credentials for the branch. </p>
648+
* <p> The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>
649649
*/
650650
basicAuthCredentials?: string;
651651

@@ -803,7 +803,7 @@ export interface Branch {
803803
thumbnailUrl?: string;
804804

805805
/**
806-
* <p> The basic authorization credentials for a branch of an Amplify app. </p>
806+
* <p> The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>
807807
*/
808808
basicAuthCredentials?: string;
809809

@@ -2794,7 +2794,7 @@ export interface UpdateAppRequest {
27942794
enableBasicAuth?: boolean;
27952795

27962796
/**
2797-
* <p> The basic authorization credentials for an Amplify app. </p>
2797+
* <p> The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>
27982798
*/
27992799
basicAuthCredentials?: string;
28002800

@@ -2928,7 +2928,7 @@ export interface UpdateBranchRequest {
29282928
environmentVariables?: { [key: string]: string };
29292929

29302930
/**
2931-
* <p> The basic authorization credentials for the branch. </p>
2931+
* <p> The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>
29322932
*/
29332933
basicAuthCredentials?: string;
29342934

clients/client-appconfig/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ devices.</p>
1616
systems where a simple typo could cause an unexpected outage, AppConfig includes
1717
validators. A validator provides a syntactic or semantic check to ensure that the
1818
configuration you want to deploy works as intended. To validate your application
19-
configuration data, you provide a schema or a Lambda function that runs against the
20-
configuration. The configuration deployment or update can only proceed when the
19+
configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
20+
the configuration. The configuration deployment or update can only proceed when the
2121
configuration data is valid.</p>
2222
<p>During a configuration deployment, AppConfig monitors the application to ensure that the
2323
deployment is successful. If the system encounters an error, AppConfig rolls back the
@@ -29,15 +29,15 @@ triggers an alarm, AppConfig automatically rolls back to the previous version. <
2929
<ul>
3030
<li>
3131
<p>
32-
<b>Application tuning</b>: Use AppConfig to carefully
33-
introduce changes to your application that can only be tested with production
34-
traffic.</p>
32+
<b>Feature flags</b>: Use AppConfig to turn on new
33+
features that require a timely deployment, such as a product launch or announcement.
34+
</p>
3535
</li>
3636
<li>
3737
<p>
38-
<b>Feature toggle</b>: Use AppConfig to turn on new
39-
features that require a timely deployment, such as a product launch or announcement.
40-
</p>
38+
<b>Application tuning</b>: Use AppConfig to carefully
39+
introduce changes to your application that can only be tested with production
40+
traffic.</p>
4141
</li>
4242
<li>
4343
<p>

clients/client-appconfig/src/AppConfig.ts

Lines changed: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,8 @@ import {
173173
* systems where a simple typo could cause an unexpected outage, AppConfig includes
174174
* validators. A validator provides a syntactic or semantic check to ensure that the
175175
* configuration you want to deploy works as intended. To validate your application
176-
* configuration data, you provide a schema or a Lambda function that runs against the
177-
* configuration. The configuration deployment or update can only proceed when the
176+
* configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
177+
* the configuration. The configuration deployment or update can only proceed when the
178178
* configuration data is valid.</p>
179179
* <p>During a configuration deployment, AppConfig monitors the application to ensure that the
180180
* deployment is successful. If the system encounters an error, AppConfig rolls back the
@@ -186,15 +186,15 @@ import {
186186
* <ul>
187187
* <li>
188188
* <p>
189-
* <b>Application tuning</b>: Use AppConfig to carefully
190-
* introduce changes to your application that can only be tested with production
191-
* traffic.</p>
189+
* <b>Feature flags</b>: Use AppConfig to turn on new
190+
* features that require a timely deployment, such as a product launch or announcement.
191+
* </p>
192192
* </li>
193193
* <li>
194194
* <p>
195-
* <b>Feature toggle</b>: Use AppConfig to turn on new
196-
* features that require a timely deployment, such as a product launch or announcement.
197-
* </p>
195+
* <b>Application tuning</b>: Use AppConfig to carefully
196+
* introduce changes to your application that can only be tested with production
197+
* traffic.</p>
198198
* </li>
199199
* <li>
200200
* <p>
@@ -264,7 +264,7 @@ export class AppConfig extends AppConfigClient {
264264
* </li>
265265
* <li>
266266
* <p>A validator for the configuration data. Available validators include either a JSON
267-
* Schema or an Lambda function.</p>
267+
* Schema or an Amazon Web Services Lambda function.</p>
268268
* </li>
269269
* </ul>
270270
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
@@ -604,18 +604,39 @@ export class AppConfig extends AppConfigClient {
604604
}
605605

606606
/**
607-
* <p>Retrieves information about a configuration.</p>
607+
* @deprecated
608+
*
609+
* <p>Retrieves the latest deployed configuration.</p>
610+
*
608611
* <important>
609-
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code> parameter to
610-
* identify the configuration version on your clients. If you don’t send
611-
* <code>ClientConfigurationVersion</code> with each call to
612-
* <code>GetConfiguration</code>, your clients receive the current configuration. You
613-
* are charged each time your clients receive a configuration.</p>
614-
* <p>To avoid excess charges, we recommend that you include the
615-
* <code>ClientConfigurationVersion</code> value with every call to
616-
* <code>GetConfiguration</code>. This value must be saved on your client. Subsequent
617-
* calls to <code>GetConfiguration</code> must pass this value by using the
618-
* <code>ClientConfigurationVersion</code> parameter. </p>
612+
* <p>Note the following important information.</p>
613+
* <ul>
614+
* <li>
615+
* <p>This API action has been deprecated. Calls to receive configuration data should
616+
* use the <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html">StartConfigurationSession</a> and <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html">GetLatestConfiguration</a> APIs instead. </p>
617+
* </li>
618+
* <li>
619+
* <p>
620+
* <code>GetConfiguration</code> is a priced call. For more information, see
621+
* <a href="https://aws.amazon.com/systems-manager/pricing/">Pricing</a>.</p>
622+
* </li>
623+
* <li>
624+
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code>
625+
* parameter to identify the configuration version on your clients. If you don’t send
626+
* <code>ClientConfigurationVersion</code> with each call to
627+
* <code>GetConfiguration</code>, your clients receive the current configuration.
628+
* You are charged each time your clients receive a configuration.</p>
629+
* <p>To avoid excess charges, we recommend you use the <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html">StartConfigurationSession</a> and <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html">GetLatestConfiguration</a> APIs, which track the client configuration
630+
* version on your behalf. If you choose to continue using
631+
* <code>GetConfiguration</code>, we recommend that you include the
632+
* <code>ClientConfigurationVersion</code> value with every call to
633+
* <code>GetConfiguration</code>. The value to use for
634+
* <code>ClientConfigurationVersion</code> comes from the
635+
* <code>ConfigurationVersion</code> attribute returned by
636+
* <code>GetConfiguration</code> when there is new or updated data, and should be
637+
* saved for subsequent calls to <code>GetConfiguration</code>.</p>
638+
* </li>
639+
* </ul>
619640
* </important>
620641
*/
621642
public getConfiguration(
@@ -880,7 +901,7 @@ export class AppConfig extends AppConfigClient {
880901
}
881902

882903
/**
883-
* <p>Lists the deployments for an environment.</p>
904+
* <p>Lists the deployments for an environment in descending deployment number order.</p>
884905
*/
885906
public listDeployments(
886907
args: ListDeploymentsCommandInput,

clients/client-appconfig/src/AppConfigClient.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -366,8 +366,8 @@ export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedCo
366366
* systems where a simple typo could cause an unexpected outage, AppConfig includes
367367
* validators. A validator provides a syntactic or semantic check to ensure that the
368368
* configuration you want to deploy works as intended. To validate your application
369-
* configuration data, you provide a schema or a Lambda function that runs against the
370-
* configuration. The configuration deployment or update can only proceed when the
369+
* configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
370+
* the configuration. The configuration deployment or update can only proceed when the
371371
* configuration data is valid.</p>
372372
* <p>During a configuration deployment, AppConfig monitors the application to ensure that the
373373
* deployment is successful. If the system encounters an error, AppConfig rolls back the
@@ -379,15 +379,15 @@ export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedCo
379379
* <ul>
380380
* <li>
381381
* <p>
382-
* <b>Application tuning</b>: Use AppConfig to carefully
383-
* introduce changes to your application that can only be tested with production
384-
* traffic.</p>
382+
* <b>Feature flags</b>: Use AppConfig to turn on new
383+
* features that require a timely deployment, such as a product launch or announcement.
384+
* </p>
385385
* </li>
386386
* <li>
387387
* <p>
388-
* <b>Feature toggle</b>: Use AppConfig to turn on new
389-
* features that require a timely deployment, such as a product launch or announcement.
390-
* </p>
388+
* <b>Application tuning</b>: Use AppConfig to carefully
389+
* introduce changes to your application that can only be tested with production
390+
* traffic.</p>
391391
* </li>
392392
* <li>
393393
* <p>

clients/client-appconfig/src/commands/CreateConfigurationProfileCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr
3838
* </li>
3939
* <li>
4040
* <p>A validator for the configuration data. Available validators include either a JSON
41-
* Schema or an Lambda function.</p>
41+
* Schema or an Amazon Web Services Lambda function.</p>
4242
* </li>
4343
* </ul>
4444
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a

clients/client-appconfig/src/commands/GetConfigurationCommand.ts

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,39 @@ export interface GetConfigurationCommandInput extends GetConfigurationRequest {}
2222
export interface GetConfigurationCommandOutput extends Configuration, __MetadataBearer {}
2323

2424
/**
25-
* <p>Retrieves information about a configuration.</p>
25+
* @deprecated
26+
*
27+
* <p>Retrieves the latest deployed configuration.</p>
28+
*
2629
* <important>
27-
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code> parameter to
28-
* identify the configuration version on your clients. If you don’t send
29-
* <code>ClientConfigurationVersion</code> with each call to
30-
* <code>GetConfiguration</code>, your clients receive the current configuration. You
31-
* are charged each time your clients receive a configuration.</p>
32-
* <p>To avoid excess charges, we recommend that you include the
33-
* <code>ClientConfigurationVersion</code> value with every call to
34-
* <code>GetConfiguration</code>. This value must be saved on your client. Subsequent
35-
* calls to <code>GetConfiguration</code> must pass this value by using the
36-
* <code>ClientConfigurationVersion</code> parameter. </p>
30+
* <p>Note the following important information.</p>
31+
* <ul>
32+
* <li>
33+
* <p>This API action has been deprecated. Calls to receive configuration data should
34+
* use the <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html">StartConfigurationSession</a> and <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html">GetLatestConfiguration</a> APIs instead. </p>
35+
* </li>
36+
* <li>
37+
* <p>
38+
* <code>GetConfiguration</code> is a priced call. For more information, see
39+
* <a href="https://aws.amazon.com/systems-manager/pricing/">Pricing</a>.</p>
40+
* </li>
41+
* <li>
42+
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code>
43+
* parameter to identify the configuration version on your clients. If you don’t send
44+
* <code>ClientConfigurationVersion</code> with each call to
45+
* <code>GetConfiguration</code>, your clients receive the current configuration.
46+
* You are charged each time your clients receive a configuration.</p>
47+
* <p>To avoid excess charges, we recommend you use the <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html">StartConfigurationSession</a> and <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html">GetLatestConfiguration</a> APIs, which track the client configuration
48+
* version on your behalf. If you choose to continue using
49+
* <code>GetConfiguration</code>, we recommend that you include the
50+
* <code>ClientConfigurationVersion</code> value with every call to
51+
* <code>GetConfiguration</code>. The value to use for
52+
* <code>ClientConfigurationVersion</code> comes from the
53+
* <code>ConfigurationVersion</code> attribute returned by
54+
* <code>GetConfiguration</code> when there is new or updated data, and should be
55+
* saved for subsequent calls to <code>GetConfiguration</code>.</p>
56+
* </li>
57+
* </ul>
3758
* </important>
3859
* @example
3960
* Use a bare-bones client and the command you need to make an API call.

clients/client-appconfig/src/commands/ListDeploymentsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface ListDeploymentsCommandInput extends ListDeploymentsRequest {}
2222
export interface ListDeploymentsCommandOutput extends Deployments, __MetadataBearer {}
2323

2424
/**
25-
* <p>Lists the deployments for an environment.</p>
25+
* <p>Lists the deployments for an environment in descending deployment number order.</p>
2626
* @example
2727
* Use a bare-bones client and the command you need to make an API call.
2828
* ```javascript

0 commit comments

Comments
 (0)