Skip to content

Commit

Permalink
feat(clients): update clients as of 11/28/2021 (#3072)
Browse files Browse the repository at this point in the history
  • Loading branch information
trivikr committed Nov 29, 2021
1 parent 51480df commit 2ad1622
Show file tree
Hide file tree
Showing 825 changed files with 111,348 additions and 13,441 deletions.
43 changes: 19 additions & 24 deletions clients/client-appconfig/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,25 @@

AWS SDK for JavaScript AppConfig Client for Node.js, Browser and React Native.

<fullname>AWS AppConfig</fullname>

<p>Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy
application configurations. AppConfig supports controlled deployments to applications of any
size and includes built-in validation checks and monitoring. You can use AppConfig with
applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT
<p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
application configurations. AppConfig supports controlled deployments to applications of
any size and includes built-in validation checks and monitoring. You can use AppConfig with
applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
devices.</p>

<p>To prevent errors when deploying application configurations, especially for production
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 is
valid.</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 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 change
to minimize impact for your application users. You can configure a deployment strategy for
each application or environment that includes deployment criteria, including velocity, bake
time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an
alarm, AppConfig automatically rolls back to the previous version. </p>

<p>AppConfig supports multiple use cases. Here are some examples.</p>
deployment is successful. If the system encounters an error, AppConfig rolls back the
change to minimize impact for your application users. You can configure a deployment
strategy for each application or environment that includes deployment criteria, including
velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
<p>AppConfig supports multiple use cases. Here are some examples:</p>
<ul>
<li>
<p>
Expand All @@ -51,12 +46,12 @@ subscribers to access paid content. </p>
</li>
<li>
<p>
<b>Operational issues</b>: Use AppConfig to reduce stress
on your application when a dependency or other external factor impacts the
<b>Operational issues</b>: Use AppConfig to reduce
stress on your application when a dependency or other external factor impacts the
system.</p>
</li>
</ul>
<p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html">AWS AppConfig User Guide</a>.</p>
<p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User Guide</a>.</p>

## Installing

Expand Down
145 changes: 75 additions & 70 deletions clients/client-appconfig/src/AppConfig.ts

Large diffs are not rendered by default.

42 changes: 19 additions & 23 deletions clients/client-appconfig/src/AppConfigClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -351,29 +351,25 @@ type AppConfigClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHan
export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedConfigType {}

/**
* <fullname>AWS AppConfig</fullname>
* <p>Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy
* application configurations. AppConfig supports controlled deployments to applications of any
* size and includes built-in validation checks and monitoring. You can use AppConfig with
* applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT
* <p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
* application configurations. AppConfig supports controlled deployments to applications of
* any size and includes built-in validation checks and monitoring. You can use AppConfig with
* applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
* devices.</p>
*
* <p>To prevent errors when deploying application configurations, especially for production
* 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 is
* valid.</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 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 change
* to minimize impact for your application users. You can configure a deployment strategy for
* each application or environment that includes deployment criteria, including velocity, bake
* time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an
* alarm, AppConfig automatically rolls back to the previous version. </p>
*
* <p>AppConfig supports multiple use cases. Here are some examples.</p>
* deployment is successful. If the system encounters an error, AppConfig rolls back the
* change to minimize impact for your application users. You can configure a deployment
* strategy for each application or environment that includes deployment criteria, including
* velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
* triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
* <p>AppConfig supports multiple use cases. Here are some examples:</p>
* <ul>
* <li>
* <p>
Expand All @@ -394,12 +390,12 @@ export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedCo
* </li>
* <li>
* <p>
* <b>Operational issues</b>: Use AppConfig to reduce stress
* on your application when a dependency or other external factor impacts the
* <b>Operational issues</b>: Use AppConfig to reduce
* stress on your application when a dependency or other external factor impacts the
* system.</p>
* </li>
* </ul>
* <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html">AWS AppConfig User Guide</a>.</p>
* <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User Guide</a>.</p>
*/
export class AppConfigClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ export interface CreateApplicationCommandInput extends CreateApplicationRequest
export interface CreateApplicationCommandOutput extends Application, __MetadataBearer {}

/**
* <p>An application in AppConfig is a logical unit of code that provides capabilities for your
* customers. For example, an application can be a microservice that runs on Amazon EC2 instances,
* a mobile application installed by your users, a serverless application using Amazon API
* Gateway and AWS Lambda, or any system you run on behalf of others.</p>
* <p>Creates an application. An application in AppConfig is a logical unit of code that
* provides capabilities for your customers. For example, an application can be a microservice
* that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless
* application using Amazon API Gateway and Lambda, or any system you run on behalf of
* others.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,28 @@ export interface CreateConfigurationProfileCommandInput extends CreateConfigurat
export interface CreateConfigurationProfileCommandOutput extends ConfigurationProfile, __MetadataBearer {}

/**
* <p>Information that enables AppConfig to access the configuration source. Valid
* configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and
* Amazon S3 objects. A configuration profile includes the following information.</p>
* <p>Creates a configuration profile, which is information that enables AppConfig to access
* the configuration source. Valid configuration sources include the AppConfig hosted
* configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3
* objects, or any <a href="http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source">integration source
* action</a> supported by CodePipeline. A configuration profile includes the following
* information:</p>
*
* <ul>
* <li>
* <p>The Uri location of the configuration data.</p>
* <p>The URI location of the configuration data.</p>
* </li>
* <li>
* <p>The AWS Identity and Access Management (IAM) role that provides access to the configuration data.</p>
* <p>The Identity and Access Management (IAM) role that provides access to the configuration data.</p>
* </li>
* <li>
* <p>A validator for the configuration data. Available validators include either a JSON
* Schema or an AWS Lambda function.</p>
* Schema or an Lambda function.</p>
* </li>
* </ul>
* <p>For more information, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
* Configuration and a Configuration Profile</a> in the
* <i>AWS AppConfig User Guide</i>.</p>
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
* Configuration and a Configuration Profile</a> in the <i>AppConfig User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ export interface CreateDeploymentStrategyCommandInput extends CreateDeploymentSt
export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrategy, __MetadataBearer {}

/**
* <p>A deployment strategy defines important criteria for rolling out your configuration to
* the designated targets. A deployment strategy includes: the overall duration required, a
* percentage of targets to receive the deployment during each interval, an algorithm that
* defines how percentage grows, and bake time.</p>
* <p>Creates a deployment strategy that defines important criteria for rolling out your
* configuration to the designated targets. A deployment strategy includes the overall
* duration required, a percentage of targets to receive the deployment during each interval,
* an algorithm that defines how percentage grows, and bake time.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,14 @@ export interface CreateEnvironmentCommandInput extends CreateEnvironmentRequest
export interface CreateEnvironmentCommandOutput extends Environment, __MetadataBearer {}

/**
* <p>For each application, you define one or more environments. An environment is a logical
* deployment group of AppConfig targets, such as applications in a <code>Beta</code> or
* <code>Production</code> environment. You can also define environments for application
* subcomponents such as the <code>Web</code>, <code>Mobile</code> and <code>Back-end</code>
* components for your application. You can configure Amazon CloudWatch alarms for each environment.
* The system monitors alarms during a configuration deployment. If an alarm is triggered, the
* system rolls back the configuration.</p>
* <p>Creates an environment. For each application, you define one or more environments. An
* environment is a logical deployment group of AppConfig targets, such as applications in a
* <code>Beta</code> or <code>Production</code> environment. You can also define
* environments for application subcomponents such as the <code>Web</code>,
* <code>Mobile</code> and <code>Back-end</code> components for your application. You can
* configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a
* configuration deployment. If an alarm is triggered, the system rolls back the
* configuration.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface CreateHostedConfigurationVersionCommandInput extends CreateHost
export interface CreateHostedConfigurationVersionCommandOutput extends HostedConfigurationVersion, __MetadataBearer {}

/**
* <p>Create a new configuration in the AppConfig configuration store.</p>
* <p>Creates a new configuration in the AppConfig hosted configuration store.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface DeleteApplicationCommandInput extends DeleteApplicationRequest
export interface DeleteApplicationCommandOutput extends __MetadataBearer {}

/**
* <p>Delete an application. Deleting an application does not delete a configuration from a
* <p>Deletes an application. Deleting an application does not delete a configuration from a
* host.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface DeleteConfigurationProfileCommandInput extends DeleteConfigurat
export interface DeleteConfigurationProfileCommandOutput extends __MetadataBearer {}

/**
* <p>Delete a configuration profile. Deleting a configuration profile does not delete a
* <p>Deletes a configuration profile. Deleting a configuration profile does not delete a
* configuration from a host.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface DeleteDeploymentStrategyCommandInput extends DeleteDeploymentSt
export interface DeleteDeploymentStrategyCommandOutput extends __MetadataBearer {}

/**
* <p>Delete a deployment strategy. Deleting a deployment strategy does not delete a
* <p>Deletes a deployment strategy. Deleting a deployment strategy does not delete a
* configuration from a host.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface DeleteEnvironmentCommandInput extends DeleteEnvironmentRequest
export interface DeleteEnvironmentCommandOutput extends __MetadataBearer {}

/**
* <p>Delete an environment. Deleting an environment does not delete a configuration from a
* <p>Deletes an environment. Deleting an environment does not delete a configuration from a
* host.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ export interface DeleteHostedConfigurationVersionCommandInput extends DeleteHost
export interface DeleteHostedConfigurationVersionCommandOutput extends __MetadataBearer {}

/**
* <p>Delete a version of a configuration from the AppConfig configuration store.</p>
* <p>Deletes a version of a configuration from the AppConfig hosted configuration
* store.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface GetApplicationCommandInput extends GetApplicationRequest {}
export interface GetApplicationCommandOutput extends Application, __MetadataBearer {}

/**
* <p>Retrieve information about an application.</p>
* <p>Retrieves information about an application.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ export interface GetConfigurationCommandInput extends GetConfigurationRequest {}
export interface GetConfigurationCommandOutput extends Configuration, __MetadataBearer {}

/**
* <p>Receive information about a configuration.</p>
* <p>Retrieves information about a configuration.</p>
* <important>
* <p>AWS AppConfig uses the value of the <code>ClientConfigurationVersion</code> parameter
* to identify the configuration version on your clients. If you don’t send
* <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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface GetConfigurationProfileCommandInput extends GetConfigurationPro
export interface GetConfigurationProfileCommandOutput extends ConfigurationProfile, __MetadataBearer {}

/**
* <p>Retrieve information about a configuration profile.</p>
* <p>Retrieves information about a configuration profile.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface GetDeploymentCommandInput extends GetDeploymentRequest {}
export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer {}

/**
* <p>Retrieve information about a configuration deployment.</p>
* <p>Retrieves information about a configuration deployment.</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 2ad1622

Please sign in to comment.