Skip to content

Commit

Permalink
feat(clients): update clients as of 01/28/2022 (#3263)
Browse files Browse the repository at this point in the history
  • Loading branch information
@trivikr
trivikr authored Jan 28, 2022
1 parent fe8efe5 commit c207cf4
Show file tree
Hide file tree
Showing 230 changed files with 15,459 additions and 5,517 deletions.
14 changes: 7 additions & 7 deletions clients/client-amplify/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface AutoBranchCreationConfig {
environmentVariables?: { [key: string]: string };

/**
* <p> The basic authorization credentials for the autocreated branch. </p>
* <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>
*/
basicAuthCredentials?: string;

Expand Down Expand Up @@ -211,7 +211,7 @@ export interface CreateAppRequest {
enableBasicAuth?: boolean;

/**
* <p> The credentials for basic authorization for an Amplify app. </p>
* <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>
*/
basicAuthCredentials?: string;

Expand Down Expand Up @@ -383,7 +383,7 @@ export interface App {
enableBasicAuth: boolean | undefined;

/**
* <p> The basic authorization credentials for branches for the Amplify app. </p>
* <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>
*/
basicAuthCredentials?: string;

Expand Down Expand Up @@ -645,7 +645,7 @@ export interface CreateBranchRequest {
environmentVariables?: { [key: string]: string };

/**
* <p> The basic authorization credentials for the branch. </p>
* <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>
*/
basicAuthCredentials?: string;

Expand Down Expand Up @@ -803,7 +803,7 @@ export interface Branch {
thumbnailUrl?: string;

/**
* <p> The basic authorization credentials for a branch of an Amplify app. </p>
* <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>
*/
basicAuthCredentials?: string;

Expand Down Expand Up @@ -2794,7 +2794,7 @@ export interface UpdateAppRequest {
enableBasicAuth?: boolean;

/**
* <p> The basic authorization credentials for an Amplify app. </p>
* <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>
*/
basicAuthCredentials?: string;

Expand Down Expand Up @@ -2928,7 +2928,7 @@ export interface UpdateBranchRequest {
environmentVariables?: { [key: string]: string };

/**
* <p> The basic authorization credentials for the branch. </p>
* <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>
*/
basicAuthCredentials?: string;

Expand Down
16 changes: 8 additions & 8 deletions clients/client-appconfig/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ devices.</p>
systems where a simple typo could cause an unexpected outage, AppConfig includes
validators. A validator provides a syntactic or semantic check to ensure that the
configuration you want to deploy works as intended. To validate your application
configuration data, you provide a schema or a Lambda function that runs against the
configuration. The configuration deployment or update can only proceed when the
configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
the configuration. The configuration deployment or update can only proceed when the
configuration data is valid.</p>
<p>During a configuration deployment, AppConfig monitors the application to ensure that the
deployment is successful. If the system encounters an error, AppConfig rolls back the
Expand All @@ -29,15 +29,15 @@ triggers an alarm, AppConfig automatically rolls back to the previous version. <
<ul>
<li>
<p>
<b>Application tuning</b>: Use AppConfig to carefully
introduce changes to your application that can only be tested with production
traffic.</p>
<b>Feature flags</b>: Use AppConfig to turn on new
features that require a timely deployment, such as a product launch or announcement.
</p>
</li>
<li>
<p>
<b>Feature toggle</b>: Use AppConfig to turn on new
features that require a timely deployment, such as a product launch or announcement.
</p>
<b>Application tuning</b>: Use AppConfig to carefully
introduce changes to your application that can only be tested with production
traffic.</p>
</li>
<li>
<p>
Expand Down
63 changes: 42 additions & 21 deletions clients/client-appconfig/src/AppConfig.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ import {
* systems where a simple typo could cause an unexpected outage, AppConfig includes
* validators. A validator provides a syntactic or semantic check to ensure that the
* configuration you want to deploy works as intended. To validate your application
* configuration data, you provide a schema or a Lambda function that runs against the
* configuration. The configuration deployment or update can only proceed when the
* configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
* the configuration. The configuration deployment or update can only proceed when the
* configuration data is valid.</p>
* <p>During a configuration deployment, AppConfig monitors the application to ensure that the
* deployment is successful. If the system encounters an error, AppConfig rolls back the
Expand All @@ -186,15 +186,15 @@ import {
* <ul>
* <li>
* <p>
* <b>Application tuning</b>: Use AppConfig to carefully
* introduce changes to your application that can only be tested with production
* traffic.</p>
* <b>Feature flags</b>: Use AppConfig to turn on new
* features that require a timely deployment, such as a product launch or announcement.
* </p>
* </li>
* <li>
* <p>
* <b>Feature toggle</b>: Use AppConfig to turn on new
* features that require a timely deployment, such as a product launch or announcement.
* </p>
* <b>Application tuning</b>: Use AppConfig to carefully
* introduce changes to your application that can only be tested with production
* traffic.</p>
* </li>
* <li>
* <p>
Expand Down Expand Up @@ -264,7 +264,7 @@ export class AppConfig extends AppConfigClient {
* </li>
* <li>
* <p>A validator for the configuration data. Available validators include either a JSON
* Schema or an Lambda function.</p>
* Schema or an Amazon Web Services Lambda function.</p>
* </li>
* </ul>
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
Expand Down Expand Up @@ -604,18 +604,39 @@ export class AppConfig extends AppConfigClient {
}

/**
* <p>Retrieves information about a configuration.</p>
* @deprecated
*
* <p>Retrieves the latest deployed configuration.</p>
*
* <important>
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code> parameter to
* identify the configuration version on your clients. If you don’t send
* <code>ClientConfigurationVersion</code> with each call to
* <code>GetConfiguration</code>, your clients receive the current configuration. You
* are charged each time your clients receive a configuration.</p>
* <p>To avoid excess charges, we recommend that you include the
* <code>ClientConfigurationVersion</code> value with every call to
* <code>GetConfiguration</code>. This value must be saved on your client. Subsequent
* calls to <code>GetConfiguration</code> must pass this value by using the
* <code>ClientConfigurationVersion</code> parameter. </p>
* <p>Note the following important information.</p>
* <ul>
* <li>
* <p>This API action has been deprecated. Calls to receive configuration data should
* 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>
* </li>
* <li>
* <p>
* <code>GetConfiguration</code> is a priced call. For more information, see
* <a href="https://aws.amazon.com/systems-manager/pricing/">Pricing</a>.</p>
* </li>
* <li>
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code>
* parameter to identify the configuration version on your clients. If you don’t send
* <code>ClientConfigurationVersion</code> with each call to
* <code>GetConfiguration</code>, your clients receive the current configuration.
* You are charged each time your clients receive a configuration.</p>
* <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
* version on your behalf. If you choose to continue using
* <code>GetConfiguration</code>, we recommend that you include the
* <code>ClientConfigurationVersion</code> value with every call to
* <code>GetConfiguration</code>. The value to use for
* <code>ClientConfigurationVersion</code> comes from the
* <code>ConfigurationVersion</code> attribute returned by
* <code>GetConfiguration</code> when there is new or updated data, and should be
* saved for subsequent calls to <code>GetConfiguration</code>.</p>
* </li>
* </ul>
* </important>
*/
public getConfiguration(
Expand Down Expand Up @@ -880,7 +901,7 @@ export class AppConfig extends AppConfigClient {
}

/**
* <p>Lists the deployments for an environment.</p>
* <p>Lists the deployments for an environment in descending deployment number order.</p>
*/
public listDeployments(
args: ListDeploymentsCommandInput,
Expand Down
16 changes: 8 additions & 8 deletions clients/client-appconfig/src/AppConfigClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -366,8 +366,8 @@ export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedCo
* systems where a simple typo could cause an unexpected outage, AppConfig includes
* validators. A validator provides a syntactic or semantic check to ensure that the
* configuration you want to deploy works as intended. To validate your application
* configuration data, you provide a schema or a Lambda function that runs against the
* configuration. The configuration deployment or update can only proceed when the
* configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
* the configuration. The configuration deployment or update can only proceed when the
* configuration data is valid.</p>
* <p>During a configuration deployment, AppConfig monitors the application to ensure that the
* deployment is successful. If the system encounters an error, AppConfig rolls back the
Expand All @@ -379,15 +379,15 @@ export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedCo
* <ul>
* <li>
* <p>
* <b>Application tuning</b>: Use AppConfig to carefully
* introduce changes to your application that can only be tested with production
* traffic.</p>
* <b>Feature flags</b>: Use AppConfig to turn on new
* features that require a timely deployment, such as a product launch or announcement.
* </p>
* </li>
* <li>
* <p>
* <b>Feature toggle</b>: Use AppConfig to turn on new
* features that require a timely deployment, such as a product launch or announcement.
* </p>
* <b>Application tuning</b>: Use AppConfig to carefully
* introduce changes to your application that can only be tested with production
* traffic.</p>
* </li>
* <li>
* <p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-appconfig/src/commands/CreateConfigurationProfileCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr
* </li>
* <li>
* <p>A validator for the configuration data. Available validators include either a JSON
* Schema or an Lambda function.</p>
* Schema or an Amazon Web Services Lambda function.</p>
* </li>
* </ul>
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
Expand Down
43 changes: 32 additions & 11 deletions clients/client-appconfig/src/commands/GetConfigurationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,39 @@ export interface GetConfigurationCommandInput extends GetConfigurationRequest {}
export interface GetConfigurationCommandOutput extends Configuration, __MetadataBearer {}

/**
* <p>Retrieves information about a configuration.</p>
* @deprecated
*
* <p>Retrieves the latest deployed configuration.</p>
*
* <important>
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code> parameter to
* identify the configuration version on your clients. If you don’t send
* <code>ClientConfigurationVersion</code> with each call to
* <code>GetConfiguration</code>, your clients receive the current configuration. You
* are charged each time your clients receive a configuration.</p>
* <p>To avoid excess charges, we recommend that you include the
* <code>ClientConfigurationVersion</code> value with every call to
* <code>GetConfiguration</code>. This value must be saved on your client. Subsequent
* calls to <code>GetConfiguration</code> must pass this value by using the
* <code>ClientConfigurationVersion</code> parameter. </p>
* <p>Note the following important information.</p>
* <ul>
* <li>
* <p>This API action has been deprecated. Calls to receive configuration data should
* 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>
* </li>
* <li>
* <p>
* <code>GetConfiguration</code> is a priced call. For more information, see
* <a href="https://aws.amazon.com/systems-manager/pricing/">Pricing</a>.</p>
* </li>
* <li>
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code>
* parameter to identify the configuration version on your clients. If you don’t send
* <code>ClientConfigurationVersion</code> with each call to
* <code>GetConfiguration</code>, your clients receive the current configuration.
* You are charged each time your clients receive a configuration.</p>
* <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
* version on your behalf. If you choose to continue using
* <code>GetConfiguration</code>, we recommend that you include the
* <code>ClientConfigurationVersion</code> value with every call to
* <code>GetConfiguration</code>. The value to use for
* <code>ClientConfigurationVersion</code> comes from the
* <code>ConfigurationVersion</code> attribute returned by
* <code>GetConfiguration</code> when there is new or updated data, and should be
* saved for subsequent calls to <code>GetConfiguration</code>.</p>
* </li>
* </ul>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
2 changes: 1 addition & 1 deletion clients/client-appconfig/src/commands/ListDeploymentsCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface ListDeploymentsCommandInput extends ListDeploymentsRequest {}
export interface ListDeploymentsCommandOutput extends Deployments, __MetadataBearer {}

/**
* <p>Lists the deployments for an environment.</p>
* <p>Lists the deployments for an environment in descending deployment number order.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit c207cf4

Please sign in to comment.