Skip to content

Commit 2ad1622

Browse files
authored
feat(clients): update clients as of 11/28/2021 (#3072)
1 parent 51480df commit 2ad1622

File tree

825 files changed

+111348
-13441
lines changed

Some content is hidden

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

825 files changed

+111348
-13441
lines changed

clients/client-appconfig/README.md

+19-24
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,25 @@
77

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

10-
<fullname>AWS AppConfig</fullname>
11-
12-
<p>Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy
13-
application configurations. AppConfig supports controlled deployments to applications of any
14-
size and includes built-in validation checks and monitoring. You can use AppConfig with
15-
applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT
10+
<p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
11+
application configurations. AppConfig supports controlled deployments to applications of
12+
any size and includes built-in validation checks and monitoring. You can use AppConfig with
13+
applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
1614
devices.</p>
17-
1815
<p>To prevent errors when deploying application configurations, especially for production
19-
systems where a simple typo could cause an unexpected outage, AppConfig includes validators.
20-
A validator provides a syntactic or semantic check to ensure that the configuration you
21-
want to deploy works as intended. To validate your application configuration data, you
22-
provide a schema or a Lambda function that runs against the configuration. The
23-
configuration deployment or update can only proceed when the configuration data is
24-
valid.</p>
25-
16+
systems where a simple typo could cause an unexpected outage, AppConfig includes
17+
validators. A validator provides a syntactic or semantic check to ensure that the
18+
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
21+
configuration data is valid.</p>
2622
<p>During a configuration deployment, AppConfig monitors the application to ensure that the
27-
deployment is successful. If the system encounters an error, AppConfig rolls back the change
28-
to minimize impact for your application users. You can configure a deployment strategy for
29-
each application or environment that includes deployment criteria, including velocity, bake
30-
time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an
31-
alarm, AppConfig automatically rolls back to the previous version. </p>
32-
33-
<p>AppConfig supports multiple use cases. Here are some examples.</p>
23+
deployment is successful. If the system encounters an error, AppConfig rolls back the
24+
change to minimize impact for your application users. You can configure a deployment
25+
strategy for each application or environment that includes deployment criteria, including
26+
velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
27+
triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
28+
<p>AppConfig supports multiple use cases. Here are some examples:</p>
3429
<ul>
3530
<li>
3631
<p>
@@ -51,12 +46,12 @@ subscribers to access paid content. </p>
5146
</li>
5247
<li>
5348
<p>
54-
<b>Operational issues</b>: Use AppConfig to reduce stress
55-
on your application when a dependency or other external factor impacts the
49+
<b>Operational issues</b>: Use AppConfig to reduce
50+
stress on your application when a dependency or other external factor impacts the
5651
system.</p>
5752
</li>
5853
</ul>
59-
<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>
54+
<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>
6055

6156
## Installing
6257

clients/client-appconfig/src/AppConfig.ts

+75-70
Large diffs are not rendered by default.

clients/client-appconfig/src/AppConfigClient.ts

+19-23
Original file line numberDiff line numberDiff line change
@@ -351,29 +351,25 @@ type AppConfigClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHan
351351
export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedConfigType {}
352352

353353
/**
354-
* <fullname>AWS AppConfig</fullname>
355-
* <p>Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy
356-
* application configurations. AppConfig supports controlled deployments to applications of any
357-
* size and includes built-in validation checks and monitoring. You can use AppConfig with
358-
* applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT
354+
* <p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
355+
* application configurations. AppConfig supports controlled deployments to applications of
356+
* any size and includes built-in validation checks and monitoring. You can use AppConfig with
357+
* applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
359358
* devices.</p>
360-
*
361359
* <p>To prevent errors when deploying application configurations, especially for production
362-
* systems where a simple typo could cause an unexpected outage, AppConfig includes validators.
363-
* A validator provides a syntactic or semantic check to ensure that the configuration you
364-
* want to deploy works as intended. To validate your application configuration data, you
365-
* provide a schema or a Lambda function that runs against the configuration. The
366-
* configuration deployment or update can only proceed when the configuration data is
367-
* valid.</p>
368-
*
360+
* systems where a simple typo could cause an unexpected outage, AppConfig includes
361+
* validators. A validator provides a syntactic or semantic check to ensure that the
362+
* configuration you want to deploy works as intended. To validate your application
363+
* configuration data, you provide a schema or a Lambda function that runs against the
364+
* configuration. The configuration deployment or update can only proceed when the
365+
* configuration data is valid.</p>
369366
* <p>During a configuration deployment, AppConfig monitors the application to ensure that the
370-
* deployment is successful. If the system encounters an error, AppConfig rolls back the change
371-
* to minimize impact for your application users. You can configure a deployment strategy for
372-
* each application or environment that includes deployment criteria, including velocity, bake
373-
* time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an
374-
* alarm, AppConfig automatically rolls back to the previous version. </p>
375-
*
376-
* <p>AppConfig supports multiple use cases. Here are some examples.</p>
367+
* deployment is successful. If the system encounters an error, AppConfig rolls back the
368+
* change to minimize impact for your application users. You can configure a deployment
369+
* strategy for each application or environment that includes deployment criteria, including
370+
* velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
371+
* triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
372+
* <p>AppConfig supports multiple use cases. Here are some examples:</p>
377373
* <ul>
378374
* <li>
379375
* <p>
@@ -394,12 +390,12 @@ export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedCo
394390
* </li>
395391
* <li>
396392
* <p>
397-
* <b>Operational issues</b>: Use AppConfig to reduce stress
398-
* on your application when a dependency or other external factor impacts the
393+
* <b>Operational issues</b>: Use AppConfig to reduce
394+
* stress on your application when a dependency or other external factor impacts the
399395
* system.</p>
400396
* </li>
401397
* </ul>
402-
* <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>
398+
* <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>
403399
*/
404400
export class AppConfigClient extends __Client<
405401
__HttpHandlerOptions,

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

+5-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@ export interface CreateApplicationCommandInput extends CreateApplicationRequest
2222
export interface CreateApplicationCommandOutput extends Application, __MetadataBearer {}
2323

2424
/**
25-
* <p>An application in AppConfig is a logical unit of code that provides capabilities for your
26-
* customers. For example, an application can be a microservice that runs on Amazon EC2 instances,
27-
* a mobile application installed by your users, a serverless application using Amazon API
28-
* Gateway and AWS Lambda, or any system you run on behalf of others.</p>
25+
* <p>Creates an application. An application in AppConfig is a logical unit of code that
26+
* provides capabilities for your customers. For example, an application can be a microservice
27+
* that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless
28+
* application using Amazon API Gateway and Lambda, or any system you run on behalf of
29+
* others.</p>
2930
* @example
3031
* Use a bare-bones client and the command you need to make an API call.
3132
* ```javascript

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

+13-9
Original file line numberDiff line numberDiff line change
@@ -22,24 +22,28 @@ export interface CreateConfigurationProfileCommandInput extends CreateConfigurat
2222
export interface CreateConfigurationProfileCommandOutput extends ConfigurationProfile, __MetadataBearer {}
2323

2424
/**
25-
* <p>Information that enables AppConfig to access the configuration source. Valid
26-
* configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and
27-
* Amazon S3 objects. A configuration profile includes the following information.</p>
25+
* <p>Creates a configuration profile, which is information that enables AppConfig to access
26+
* the configuration source. Valid configuration sources include the AppConfig hosted
27+
* configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3
28+
* objects, or any <a href="http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source">integration source
29+
* action</a> supported by CodePipeline. A configuration profile includes the following
30+
* information:</p>
31+
*
2832
* <ul>
2933
* <li>
30-
* <p>The Uri location of the configuration data.</p>
34+
* <p>The URI location of the configuration data.</p>
3135
* </li>
3236
* <li>
33-
* <p>The AWS Identity and Access Management (IAM) role that provides access to the configuration data.</p>
37+
* <p>The Identity and Access Management (IAM) role that provides access to the configuration data.</p>
3438
* </li>
3539
* <li>
3640
* <p>A validator for the configuration data. Available validators include either a JSON
37-
* Schema or an AWS Lambda function.</p>
41+
* Schema or an Lambda function.</p>
3842
* </li>
3943
* </ul>
40-
* <p>For more information, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
41-
* Configuration and a Configuration Profile</a> in the
42-
* <i>AWS AppConfig User Guide</i>.</p>
44+
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
45+
* Configuration and a Configuration Profile</a> in the <i>AppConfig User
46+
* Guide</i>.</p>
4347
* @example
4448
* Use a bare-bones client and the command you need to make an API call.
4549
* ```javascript

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ export interface CreateDeploymentStrategyCommandInput extends CreateDeploymentSt
2222
export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrategy, __MetadataBearer {}
2323

2424
/**
25-
* <p>A deployment strategy defines important criteria for rolling out your configuration to
26-
* the designated targets. A deployment strategy includes: the overall duration required, a
27-
* percentage of targets to receive the deployment during each interval, an algorithm that
28-
* defines how percentage grows, and bake time.</p>
25+
* <p>Creates a deployment strategy that defines important criteria for rolling out your
26+
* configuration to the designated targets. A deployment strategy includes the overall
27+
* duration required, a percentage of targets to receive the deployment during each interval,
28+
* an algorithm that defines how percentage grows, and bake time.</p>
2929
* @example
3030
* Use a bare-bones client and the command you need to make an API call.
3131
* ```javascript

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

+8-7
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,14 @@ export interface CreateEnvironmentCommandInput extends CreateEnvironmentRequest
2222
export interface CreateEnvironmentCommandOutput extends Environment, __MetadataBearer {}
2323

2424
/**
25-
* <p>For each application, you define one or more environments. An environment is a logical
26-
* deployment group of AppConfig targets, such as applications in a <code>Beta</code> or
27-
* <code>Production</code> environment. You can also define environments for application
28-
* subcomponents such as the <code>Web</code>, <code>Mobile</code> and <code>Back-end</code>
29-
* components for your application. You can configure Amazon CloudWatch alarms for each environment.
30-
* The system monitors alarms during a configuration deployment. If an alarm is triggered, the
31-
* system rolls back the configuration.</p>
25+
* <p>Creates an environment. For each application, you define one or more environments. An
26+
* environment is a logical deployment group of AppConfig targets, such as applications in a
27+
* <code>Beta</code> or <code>Production</code> environment. You can also define
28+
* environments for application subcomponents such as the <code>Web</code>,
29+
* <code>Mobile</code> and <code>Back-end</code> components for your application. You can
30+
* configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a
31+
* configuration deployment. If an alarm is triggered, the system rolls back the
32+
* configuration.</p>
3233
* @example
3334
* Use a bare-bones client and the command you need to make an API call.
3435
* ```javascript

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface CreateHostedConfigurationVersionCommandInput extends CreateHost
2222
export interface CreateHostedConfigurationVersionCommandOutput extends HostedConfigurationVersion, __MetadataBearer {}
2323

2424
/**
25-
* <p>Create a new configuration in the AppConfig configuration store.</p>
25+
* <p>Creates a new configuration in the AppConfig hosted configuration store.</p>
2626
* @example
2727
* Use a bare-bones client and the command you need to make an API call.
2828
* ```javascript

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface DeleteApplicationCommandInput extends DeleteApplicationRequest
2222
export interface DeleteApplicationCommandOutput extends __MetadataBearer {}
2323

2424
/**
25-
* <p>Delete an application. Deleting an application does not delete a configuration from a
25+
* <p>Deletes an application. Deleting an application does not delete a configuration from a
2626
* host.</p>
2727
* @example
2828
* Use a bare-bones client and the command you need to make an API call.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface DeleteConfigurationProfileCommandInput extends DeleteConfigurat
2222
export interface DeleteConfigurationProfileCommandOutput extends __MetadataBearer {}
2323

2424
/**
25-
* <p>Delete a configuration profile. Deleting a configuration profile does not delete a
25+
* <p>Deletes a configuration profile. Deleting a configuration profile does not delete a
2626
* configuration from a host.</p>
2727
* @example
2828
* Use a bare-bones client and the command you need to make an API call.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface DeleteDeploymentStrategyCommandInput extends DeleteDeploymentSt
2222
export interface DeleteDeploymentStrategyCommandOutput extends __MetadataBearer {}
2323

2424
/**
25-
* <p>Delete a deployment strategy. Deleting a deployment strategy does not delete a
25+
* <p>Deletes a deployment strategy. Deleting a deployment strategy does not delete a
2626
* configuration from a host.</p>
2727
* @example
2828
* Use a bare-bones client and the command you need to make an API call.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface DeleteEnvironmentCommandInput extends DeleteEnvironmentRequest
2222
export interface DeleteEnvironmentCommandOutput extends __MetadataBearer {}
2323

2424
/**
25-
* <p>Delete an environment. Deleting an environment does not delete a configuration from a
25+
* <p>Deletes an environment. Deleting an environment does not delete a configuration from a
2626
* host.</p>
2727
* @example
2828
* Use a bare-bones client and the command you need to make an API call.

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ export interface DeleteHostedConfigurationVersionCommandInput extends DeleteHost
2222
export interface DeleteHostedConfigurationVersionCommandOutput extends __MetadataBearer {}
2323

2424
/**
25-
* <p>Delete a version of a configuration from the AppConfig configuration store.</p>
25+
* <p>Deletes a version of a configuration from the AppConfig hosted configuration
26+
* store.</p>
2627
* @example
2728
* Use a bare-bones client and the command you need to make an API call.
2829
* ```javascript

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface GetApplicationCommandInput extends GetApplicationRequest {}
2222
export interface GetApplicationCommandOutput extends Application, __MetadataBearer {}
2323

2424
/**
25-
* <p>Retrieve information about an application.</p>
25+
* <p>Retrieves information about an application.</p>
2626
* @example
2727
* Use a bare-bones client and the command you need to make an API call.
2828
* ```javascript

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ export interface GetConfigurationCommandInput extends GetConfigurationRequest {}
2222
export interface GetConfigurationCommandOutput extends Configuration, __MetadataBearer {}
2323

2424
/**
25-
* <p>Receive information about a configuration.</p>
25+
* <p>Retrieves information about a configuration.</p>
2626
* <important>
27-
* <p>AWS AppConfig uses the value of the <code>ClientConfigurationVersion</code> parameter
28-
* to identify the configuration version on your clients. If you don’t send
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
2929
* <code>ClientConfigurationVersion</code> with each call to
3030
* <code>GetConfiguration</code>, your clients receive the current configuration. You
3131
* are charged each time your clients receive a configuration.</p>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface GetConfigurationProfileCommandInput extends GetConfigurationPro
2222
export interface GetConfigurationProfileCommandOutput extends ConfigurationProfile, __MetadataBearer {}
2323

2424
/**
25-
* <p>Retrieve information about a configuration profile.</p>
25+
* <p>Retrieves information about a configuration profile.</p>
2626
* @example
2727
* Use a bare-bones client and the command you need to make an API call.
2828
* ```javascript

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface GetDeploymentCommandInput extends GetDeploymentRequest {}
2222
export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer {}
2323

2424
/**
25-
* <p>Retrieve information about a configuration deployment.</p>
25+
* <p>Retrieves information about a configuration deployment.</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)