@aws-sdk/client-appconfig 3.288.0 → 3.290.0

package/dist-types/commands/GetDeploymentStrategyCommand.d.ts

@@ -33,6 +33,38 @@ export interface GetDeploymentStrategyCommandOutput extends DeploymentStrategy,
  * @see {@link GetDeploymentStrategyCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To retrieve details of a deployment strategy
+ * ```javascript
+ * // The following get-deployment-strategy example lists the details of the specified deployment strategy.
+ * const input = {
+ *   "DeploymentStrategyId": "1225qzk"
+ * };
+ * const command = new GetDeploymentStrategyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DeploymentDurationInMinutes": 15,
+ *   "FinalBakeTimeInMinutes": 0,
+ *   "GrowthFactor": 25,
+ *   "GrowthType": "LINEAR",
+ *   "Id": "1225qzk",
+ *   "Name": "Example-Deployment",
+ *   "ReplicateTo": "SSM_DOCUMENT"
+ * }
+ * *\/
+ * // example id: to-retrieve-details-of-a-deployment-strategy-1632266385805
+ * ```
+ *
  */
 export declare class GetDeploymentStrategyCommand extends $Command<GetDeploymentStrategyCommandInput, GetDeploymentStrategyCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: GetDeploymentStrategyCommandInput;

package/dist-types/commands/GetEnvironmentCommand.d.ts

@@ -34,6 +34,36 @@ export interface GetEnvironmentCommandOutput extends Environment, __MetadataBear
  * @see {@link GetEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To retrieve environment details
+ * ```javascript
+ * // The following get-environment example returns the details and state of the specified environment.
+ * const input = {
+ *   "ApplicationId": "339ohji",
+ *   "EnvironmentId": "54j1r29"
+ * };
+ * const command = new GetEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationId": "339ohji",
+ *   "Id": "54j1r29",
+ *   "Name": "Example-Environment",
+ *   "State": "READY_FOR_DEPLOYMENT"
+ * }
+ * *\/
+ * // example id: to-retrieve-environment-details-1632266924806
+ * ```
+ *
  */
 export declare class GetEnvironmentCommand extends $Command<GetEnvironmentCommandInput, GetEnvironmentCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: GetEnvironmentCommandInput;

package/dist-types/commands/GetExtensionAssociationCommand.d.ts

@@ -32,6 +32,16 @@ export interface GetExtensionAssociationCommandOutput extends ExtensionAssociati
  * @see {@link GetExtensionAssociationCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
  */
 export declare class GetExtensionAssociationCommand extends $Command<GetExtensionAssociationCommandInput, GetExtensionAssociationCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: GetExtensionAssociationCommandInput;

package/dist-types/commands/GetExtensionCommand.d.ts

@@ -29,6 +29,16 @@ export interface GetExtensionCommandOutput extends Extension, __MetadataBearer {
  * @see {@link GetExtensionCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
  */
 export declare class GetExtensionCommand extends $Command<GetExtensionCommandInput, GetExtensionCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: GetExtensionCommandInput;

package/dist-types/commands/GetHostedConfigurationVersionCommand.d.ts

@@ -29,6 +29,37 @@ export interface GetHostedConfigurationVersionCommandOutput extends HostedConfig
  * @see {@link GetHostedConfigurationVersionCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To retrieve hosted configuration details
+ * ```javascript
+ * // The following get-hosted-configuration-version example retrieves the configuration details of the AWS AppConfig hosted configuration.
+ * const input = {
+ *   "ApplicationId": "339ohji",
+ *   "ConfigurationProfileId": "ur8hx2f",
+ *   "VersionNumber": 1
+ * };
+ * const command = new GetHostedConfigurationVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationId": "339ohji",
+ *   "ConfigurationProfileId": "ur8hx2f",
+ *   "ContentType": "application/json",
+ *   "VersionNumber": 1
+ * }
+ * *\/
+ * // example id: to-retrieve-hosted-configuration-details-1632267003527
+ * ```
+ *
  */
 export declare class GetHostedConfigurationVersionCommand extends $Command<GetHostedConfigurationVersionCommandInput, GetHostedConfigurationVersionCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: GetHostedConfigurationVersionCommandInput;

package/dist-types/commands/ListApplicationsCommand.d.ts

@@ -29,6 +29,37 @@ export interface ListApplicationsCommandOutput extends Applications, __MetadataB
  * @see {@link ListApplicationsCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ *
+ * @example To list the available applications
+ * ```javascript
+ * // The following list-applications example lists the available applications in your AWS account.
+ * const input = {};
+ * const command = new ListApplicationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Items": [
+ *     {
+ *       "Description": "An application used for creating an example.",
+ *       "Id": "339ohji",
+ *       "Name": "test-application"
+ *     },
+ *     {
+ *       "Id": "rwalwu7",
+ *       "Name": "Test-Application"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-available-applications-1632267111131
+ * ```
+ *
  */
 export declare class ListApplicationsCommand extends $Command<ListApplicationsCommandInput, ListApplicationsCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListApplicationsCommandInput;

package/dist-types/commands/ListConfigurationProfilesCommand.d.ts

@@ -29,6 +29,39 @@ export interface ListConfigurationProfilesCommandOutput extends ConfigurationPro
  * @see {@link ListConfigurationProfilesCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To list the available configuration profiles
+ * ```javascript
+ * // The following list-configuration-profiles example lists the available configuration profiles for the specified application.
+ * const input = {
+ *   "ApplicationId": "339ohji"
+ * };
+ * const command = new ListConfigurationProfilesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Items": [
+ *     {
+ *       "ApplicationId": "339ohji",
+ *       "Id": "ur8hx2f",
+ *       "LocationUri": "ssm-parameter://Example-Parameter",
+ *       "Name": "Example-Configuration-Profile"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-available-configuration-profiles-1632267193265
+ * ```
+ *
  */
 export declare class ListConfigurationProfilesCommand extends $Command<ListConfigurationProfilesCommandInput, ListConfigurationProfilesCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListConfigurationProfilesCommandInput;

package/dist-types/commands/ListDeploymentStrategiesCommand.d.ts

@@ -29,6 +29,37 @@ export interface ListDeploymentStrategiesCommandOutput extends DeploymentStrateg
  * @see {@link ListDeploymentStrategiesCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ *
+ * @example To list the available deployment strategies
+ * ```javascript
+ * // The following list-deployment-strategies example lists the available deployment strategies in your AWS account.
+ * const input = {};
+ * const command = new ListDeploymentStrategiesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Items": [
+ *     {
+ *       "DeploymentDurationInMinutes": 15,
+ *       "FinalBakeTimeInMinutes": 0,
+ *       "GrowthFactor": 25,
+ *       "GrowthType": "LINEAR",
+ *       "Id": "1225qzk",
+ *       "Name": "Example-Deployment",
+ *       "ReplicateTo": "SSM_DOCUMENT"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-available-deployment-strategies-1632267364180
+ * ```
+ *
  */
 export declare class ListDeploymentStrategiesCommand extends $Command<ListDeploymentStrategiesCommandInput, ListDeploymentStrategiesCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListDeploymentStrategiesCommandInput;

package/dist-types/commands/ListDeploymentsCommand.d.ts

@@ -29,6 +29,47 @@ export interface ListDeploymentsCommandOutput extends Deployments, __MetadataBea
  * @see {@link ListDeploymentsCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To list the available deployments
+ * ```javascript
+ * // The following list-deployments example lists the available deployments in your AWS account for the specified application and environment.
+ * const input = {
+ *   "ApplicationId": "339ohji",
+ *   "EnvironmentId": "54j1r29"
+ * };
+ * const command = new ListDeploymentsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Items": [
+ *     {
+ *       "CompletedAt": "2021-09-17T21:59:03.888000+00:00",
+ *       "ConfigurationName": "Example-Configuration-Profile",
+ *       "ConfigurationVersion": "1",
+ *       "DeploymentDurationInMinutes": 15,
+ *       "DeploymentNumber": 1,
+ *       "FinalBakeTimeInMinutes": 0,
+ *       "GrowthFactor": 25,
+ *       "GrowthType": "LINEAR",
+ *       "PercentageComplete": 100,
+ *       "StartedAt": "2021-09-17T21:43:54.205000+00:00",
+ *       "State": "COMPLETE"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-available-deployments-1632267282025
+ * ```
+ *
  */
 export declare class ListDeploymentsCommand extends $Command<ListDeploymentsCommandInput, ListDeploymentsCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListDeploymentsCommandInput;

package/dist-types/commands/ListEnvironmentsCommand.d.ts

@@ -29,6 +29,39 @@ export interface ListEnvironmentsCommandOutput extends Environments, __MetadataB
  * @see {@link ListEnvironmentsCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To list the available environments
+ * ```javascript
+ * // The following list-environments example lists the available environments in your AWS account for the specified application.
+ * const input = {
+ *   "ApplicationId": "339ohji"
+ * };
+ * const command = new ListEnvironmentsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Items": [
+ *     {
+ *       "ApplicationId": "339ohji",
+ *       "Id": "54j1r29",
+ *       "Name": "Example-Environment",
+ *       "State": "READY_FOR_DEPLOYMENT"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-available-environments-1632267474389
+ * ```
+ *
  */
 export declare class ListEnvironmentsCommand extends $Command<ListEnvironmentsCommandInput, ListEnvironmentsCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListEnvironmentsCommandInput;

package/dist-types/commands/ListExtensionAssociationsCommand.d.ts

@@ -32,6 +32,13 @@ export interface ListExtensionAssociationsCommandOutput extends ExtensionAssocia
  * @see {@link ListExtensionAssociationsCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ *
  */
 export declare class ListExtensionAssociationsCommand extends $Command<ListExtensionAssociationsCommandInput, ListExtensionAssociationsCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListExtensionAssociationsCommandInput;

package/dist-types/commands/ListExtensionsCommand.d.ts

@@ -32,6 +32,13 @@ export interface ListExtensionsCommandOutput extends Extensions, __MetadataBeare
  * @see {@link ListExtensionsCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ *
  */
 export declare class ListExtensionsCommand extends $Command<ListExtensionsCommandInput, ListExtensionsCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListExtensionsCommandInput;

package/dist-types/commands/ListHostedConfigurationVersionsCommand.d.ts

@@ -30,6 +30,40 @@ export interface ListHostedConfigurationVersionsCommandOutput extends HostedConf
  * @see {@link ListHostedConfigurationVersionsCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To list the available hosted configuration versions
+ * ```javascript
+ * // The following list-hosted-configuration-versions example lists the configurations versions hosted in the AWS AppConfig hosted configuration store for the specified application and configuration profile.
+ * const input = {
+ *   "ApplicationId": "339ohji",
+ *   "ConfigurationProfileId": "ur8hx2f"
+ * };
+ * const command = new ListHostedConfigurationVersionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Items": [
+ *     {
+ *       "ApplicationId": "339ohji",
+ *       "ConfigurationProfileId": "ur8hx2f",
+ *       "ContentType": "application/json",
+ *       "VersionNumber": 1
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-available-hosted-configuration-versions-1632267647667
+ * ```
+ *
  */
 export declare class ListHostedConfigurationVersionsCommand extends $Command<ListHostedConfigurationVersionsCommandInput, ListHostedConfigurationVersionsCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListHostedConfigurationVersionsCommandInput;

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -29,6 +29,34 @@ export interface ListTagsForResourceCommandOutput extends ResourceTags, __Metada
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To list the tags of an application
+ * ```javascript
+ * // The following list-tags-for-resource example lists the tags of a specified application.
+ * const input = {
+ *   "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Tags": {
+ *     "group1": "1"
+ *   }
+ * }
+ * *\/
+ * // example id: to-list-the-tags-of-an-application-1632328796560
+ * ```
+ *
  */
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;

package/dist-types/commands/StartDeploymentCommand.d.ts

@@ -29,6 +29,64 @@ export interface StartDeploymentCommandOutput extends Deployment, __MetadataBear
  * @see {@link StartDeploymentCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request could not be processed because of conflict in the current state of the
+ *          resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To start a configuration deployment
+ * ```javascript
+ * // The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile.
+ * const input = {
+ *   "ApplicationId": "339ohji",
+ *   "ConfigurationProfileId": "ur8hx2f",
+ *   "ConfigurationVersion": "1",
+ *   "DeploymentStrategyId": "1225qzk",
+ *   "Description": "",
+ *   "EnvironmentId": "54j1r29",
+ *   "Tags": {}
+ * };
+ * const command = new StartDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationId": "339ohji",
+ *   "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
+ *   "ConfigurationName": "Example-Configuration-Profile",
+ *   "ConfigurationProfileId": "ur8hx2f",
+ *   "ConfigurationVersion": "1",
+ *   "DeploymentDurationInMinutes": 15,
+ *   "DeploymentNumber": 1,
+ *   "DeploymentStrategyId": "1225qzk",
+ *   "EnvironmentId": "54j1r29",
+ *   "EventLog": [
+ *     {
+ *       "Description": "Deployment started",
+ *       "EventType": "DEPLOYMENT_STARTED",
+ *       "OccurredAt": "2021-09-17T21:43:54.205000+00:00",
+ *       "TriggeredBy": "USER"
+ *     }
+ *   ],
+ *   "FinalBakeTimeInMinutes": 0,
+ *   "GrowthFactor": 25,
+ *   "GrowthType": "LINEAR",
+ *   "PercentageComplete": 1,
+ *   "StartedAt": "2021-09-17T21:43:54.205000+00:00",
+ *   "State": "DEPLOYING"
+ * }
+ * *\/
+ * // example id: to-start-a-configuration-deployment-1632328956790
+ * ```
+ *
  */
 export declare class StartDeploymentCommand extends $Command<StartDeploymentCommandInput, StartDeploymentCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: StartDeploymentCommandInput;

package/dist-types/commands/StopDeploymentCommand.d.ts

@@ -31,6 +31,38 @@ export interface StopDeploymentCommandOutput extends Deployment, __MetadataBeare
  * @see {@link StopDeploymentCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To stop configuration deployment
+ * ```javascript
+ * // The following stop-deployment example stops the deployment of an application configuration to the specified environment.
+ * const input = {
+ *   "ApplicationId": "339ohji",
+ *   "DeploymentNumber": 2,
+ *   "EnvironmentId": "54j1r29"
+ * };
+ * const command = new StopDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DeploymentDurationInMinutes": 15,
+ *   "DeploymentNumber": 2,
+ *   "FinalBakeTimeInMinutes": 0,
+ *   "GrowthFactor": 25,
+ *   "PercentageComplete": 1
+ * }
+ * *\/
+ * // example id: to-stop-configuration-deployment-1632329139126
+ * ```
+ *
  */
 export declare class StopDeploymentCommand extends $Command<StopDeploymentCommandInput, StopDeploymentCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: StopDeploymentCommandInput;

package/dist-types/commands/TagResourceCommand.d.ts

@@ -31,6 +31,30 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To tag an application
+ * ```javascript
+ * // The following tag-resource example tags an application resource.
+ * const input = {
+ *   "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji",
+ *   "Tags": {
+ *     "group1": "1"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * await client.send(command);
+ * // example id: to-tag-an-application-1632330350645
+ * ```
+ *
  */
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: TagResourceCommandInput;

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -29,6 +29,30 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
  *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ *
+ * @example To remove a tag from an application
+ * ```javascript
+ * // The following untag-resource example removes the group1 tag from the specified application.
+ * const input = {
+ *   "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji",
+ *   "TagKeys": [
+ *     "group1"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * await client.send(command);
+ * // example id: to-remove-a-tag-from-an-application-1632330429881
+ * ```
+ *
  */
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, AppConfigClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;