@aws-sdk/client-appconfig 3.775.0 → 3.782.0

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

@@ -79,27 +79,27 @@ declare const GetEnvironmentCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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"
+ *   ApplicationId: "339ohji",
+ *   EnvironmentId: "54j1r29"
  * };
  * const command = new GetEnvironmentCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ApplicationId": "339ohji",
- *   "Id": "54j1r29",
- *   "Name": "Example-Environment",
- *   "State": "READY_FOR_DEPLOYMENT"
+ *   ApplicationId: "339ohji",
+ *   Id: "54j1r29",
+ *   Name: "Example-Environment",
+ *   State: "READY_FOR_DEPLOYMENT"
  * }
  * *\/
- * // example id: to-retrieve-environment-details-1632266924806
  * ```
  *
+ * @public
  */
 export declare class GetEnvironmentCommand extends GetEnvironmentCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -72,6 +72,7 @@ declare const GetExtensionAssociationCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
+ *
  * @public
  */
 export declare class GetExtensionAssociationCommand extends GetExtensionAssociationCommand_base {

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

@@ -85,6 +85,7 @@ declare const GetExtensionCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
+ *
  * @public
  */
 export declare class GetExtensionCommand extends GetExtensionCommand_base {

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

@@ -79,28 +79,28 @@ declare const GetHostedConfigurationVersionCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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
+ *   ApplicationId: "339ohji",
+ *   ConfigurationProfileId: "ur8hx2f",
+ *   VersionNumber: 1
  * };
  * const command = new GetHostedConfigurationVersionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ApplicationId": "339ohji",
- *   "ConfigurationProfileId": "ur8hx2f",
- *   "ContentType": "application/json",
- *   "VersionNumber": 1
+ *   ApplicationId: "339ohji",
+ *   ConfigurationProfileId: "ur8hx2f",
+ *   ContentType: "application/json",
+ *   VersionNumber: 1
  * }
  * *\/
- * // example id: to-retrieve-hosted-configuration-details-1632267003527
  * ```
  *
+ * @public
  */
 export declare class GetHostedConfigurationVersionCommand extends GetHostedConfigurationVersionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -68,31 +68,31 @@ declare const ListApplicationsCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @example To list the available applications
  * ```javascript
  * // The following list-applications example lists the available applications in your AWS account.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new ListApplicationsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Items": [
+ *   Items: [
  *     {
- *       "Description": "An application used for creating an example.",
- *       "Id": "339ohji",
- *       "Name": "test-application"
+ *       Description: "An application used for creating an example.",
+ *       Id: "339ohji",
+ *       Name: "test-application"
  *     },
  *     {
- *       "Id": "rwalwu7",
- *       "Name": "Test-Application"
+ *       Id: "rwalwu7",
+ *       Name: "Test-Application"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-list-the-available-applications-1632267111131
  * ```
  *
+ * @public
  */
 export declare class ListApplicationsCommand extends ListApplicationsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -78,30 +78,30 @@ declare const ListConfigurationProfilesCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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"
+ *   ApplicationId: "339ohji"
  * };
  * const command = new ListConfigurationProfilesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Items": [
+ *   Items: [
  *     {
- *       "ApplicationId": "339ohji",
- *       "Id": "ur8hx2f",
- *       "LocationUri": "ssm-parameter://Example-Parameter",
- *       "Name": "Example-Configuration-Profile"
+ *       ApplicationId: "339ohji",
+ *       Id: "ur8hx2f",
+ *       LocationUri: "ssm-parameter://Example-Parameter",
+ *       Name: "Example-Configuration-Profile"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-list-the-available-configuration-profiles-1632267193265
  * ```
  *
+ * @public
  */
 export declare class ListConfigurationProfilesCommand extends ListConfigurationProfilesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -73,31 +73,31 @@ declare const ListDeploymentStrategiesCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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 input = { /* empty *\/ };
  * const command = new ListDeploymentStrategiesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Items": [
+ *   Items: [
  *     {
- *       "DeploymentDurationInMinutes": 15,
- *       "FinalBakeTimeInMinutes": 0,
- *       "GrowthFactor": 25,
- *       "GrowthType": "LINEAR",
- *       "Id": "1225qzk",
- *       "Name": "Example-Deployment",
- *       "ReplicateTo": "SSM_DOCUMENT"
+ *       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
  * ```
  *
+ * @public
  */
 export declare class ListDeploymentStrategiesCommand extends ListDeploymentStrategiesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -82,38 +82,8 @@ declare const ListDeploymentsCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
- * @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
- * ```
  *
+ * @public
  */
 export declare class ListDeploymentsCommand extends ListDeploymentsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -80,30 +80,30 @@ declare const ListEnvironmentsCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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"
+ *   ApplicationId: "339ohji"
  * };
  * const command = new ListEnvironmentsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Items": [
+ *   Items: [
  *     {
- *       "ApplicationId": "339ohji",
- *       "Id": "54j1r29",
- *       "Name": "Example-Environment",
- *       "State": "READY_FOR_DEPLOYMENT"
+ *       ApplicationId: "339ohji",
+ *       Id: "54j1r29",
+ *       Name: "Example-Environment",
+ *       State: "READY_FOR_DEPLOYMENT"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-list-the-available-environments-1632267474389
  * ```
  *
+ * @public
  */
 export declare class ListEnvironmentsCommand extends ListEnvironmentsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -73,6 +73,7 @@ declare const ListExtensionAssociationsCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
+ *
  * @public
  */
 export declare class ListExtensionAssociationsCommand extends ListExtensionAssociationsCommand_base {

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

@@ -73,6 +73,7 @@ declare const ListExtensionsCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
+ *
  * @public
  */
 export declare class ListExtensionsCommand extends ListExtensionsCommand_base {

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

@@ -79,31 +79,31 @@ declare const ListHostedConfigurationVersionsCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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"
+ *   ApplicationId: "339ohji",
+ *   ConfigurationProfileId: "ur8hx2f"
  * };
  * const command = new ListHostedConfigurationVersionsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Items": [
+ *   Items: [
  *     {
- *       "ApplicationId": "339ohji",
- *       "ConfigurationProfileId": "ur8hx2f",
- *       "ContentType": "application/json",
- *       "VersionNumber": 1
+ *       ApplicationId: "339ohji",
+ *       ConfigurationProfileId: "ur8hx2f",
+ *       ContentType: "application/json",
+ *       VersionNumber: 1
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-list-the-available-hosted-configuration-versions-1632267647667
  * ```
  *
+ * @public
  */
 export declare class ListHostedConfigurationVersionsCommand extends ListHostedConfigurationVersionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -65,25 +65,25 @@ declare const ListTagsForResourceCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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"
+ *   ResourceArn: "arn:aws:appconfig:us-east-1:111122223333:application/339ohji"
  * };
  * const command = new ListTagsForResourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Tags": {
- *     "group1": "1"
+ *   Tags: {
+ *     group1: "1"
  *   }
  * }
  * *\/
- * // example id: to-list-the-tags-of-an-application-1632328796560
  * ```
  *
+ * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -127,51 +127,8 @@ declare const StartDeploymentCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
- * @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
- * ```
  *
+ * @public
  */
 export declare class StartDeploymentCommand extends StartDeploymentCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -119,29 +119,29 @@ declare const StopDeploymentCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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"
+ *   ApplicationId: "339ohji",
+ *   DeploymentNumber: 2,
+ *   EnvironmentId: "54j1r29"
  * };
  * const command = new StopDeploymentCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "DeploymentDurationInMinutes": 15,
- *   "DeploymentNumber": 2,
- *   "FinalBakeTimeInMinutes": 0,
- *   "GrowthFactor": 25,
- *   "PercentageComplete": 1
+ *   DeploymentDurationInMinutes: 15,
+ *   DeploymentNumber: 2,
+ *   FinalBakeTimeInMinutes: 0,
+ *   GrowthFactor: 25.0,
+ *   PercentageComplete: 1.0
  * }
  * *\/
- * // example id: to-stop-configuration-deployment-1632329139126
  * ```
  *
+ * @public
  */
 export declare class StopDeploymentCommand extends StopDeploymentCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -66,21 +66,24 @@ declare const TagResourceCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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"
+ *   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
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -64,21 +64,24 @@ declare const UntagResourceCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @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": [
+ *   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
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -66,6 +66,7 @@ declare const UpdateAccountSettingsCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
+ *
  * @public
  */
 export declare class UpdateAccountSettingsCommand extends UpdateAccountSettingsCommand_base {

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

@@ -67,27 +67,27 @@ declare const UpdateApplicationCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @example To update an application
  * ```javascript
  * // The following update-application example updates the name of the specified application.
  * const input = {
- *   "ApplicationId": "339ohji",
- *   "Description": "",
- *   "Name": "Example-Application"
+ *   ApplicationId: "339ohji",
+ *   Description: "",
+ *   Name: "Example-Application"
  * };
  * const command = new UpdateApplicationCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Description": "An application used for creating an example.",
- *   "Id": "339ohji",
- *   "Name": "Example-Application"
+ *   Description: "An application used for creating an example.",
+ *   Id: "339ohji",
+ *   Name: "Example-Application"
  * }
  * *\/
- * // example id: to-update-an-application-1632330585893
  * ```
  *
+ * @public
  */
 export declare class UpdateApplicationCommand extends UpdateApplicationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -88,30 +88,30 @@ declare const UpdateConfigurationProfileCommand_base: {
  * @throws {@link AppConfigServiceException}
  * <p>Base exception class for all service exceptions from AppConfig service.</p>
  *
- * @public
+ *
  * @example To update a configuration profile
  * ```javascript
  * // The following update-configuration-profile example updates the description of the specified configuration profile.
  * const input = {
- *   "ApplicationId": "339ohji",
- *   "ConfigurationProfileId": "ur8hx2f",
- *   "Description": "Configuration profile used for examples."
+ *   ApplicationId: "339ohji",
+ *   ConfigurationProfileId: "ur8hx2f",
+ *   Description: "Configuration profile used for examples."
  * };
  * const command = new UpdateConfigurationProfileCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ApplicationId": "339ohji",
- *   "Description": "Configuration profile used for examples.",
- *   "Id": "ur8hx2f",
- *   "LocationUri": "ssm-parameter://Example-Parameter",
- *   "Name": "Example-Configuration-Profile",
- *   "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
+ *   ApplicationId: "339ohji",
+ *   Description: "Configuration profile used for examples.",
+ *   Id: "ur8hx2f",
+ *   LocationUri: "ssm-parameter://Example-Parameter",
+ *   Name: "Example-Configuration-Profile",
+ *   RetrievalRoleArn: "arn:aws:iam::111122223333:role/Example-App-Config-Role"
  * }
  * *\/
- * // example id: to-update-a-configuration-profile-1632330721974
  * ```
  *
+ * @public
  */
 export declare class UpdateConfigurationProfileCommand extends UpdateConfigurationProfileCommand_base {
     /** @internal type navigation helper, not in runtime. */