@aws-sdk/client-appconfig 3.287.0 → 3.289.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist-types/commands/CreateApplicationCommand.d.ts +19 -0
  2. package/dist-types/commands/CreateConfigurationProfileCommand.d.ts +23 -0
  3. package/dist-types/commands/CreateDeploymentStrategyCommand.d.ts +25 -0
  4. package/dist-types/commands/CreateEnvironmentCommand.d.ts +20 -0
  5. package/dist-types/commands/CreateHostedConfigurationVersionCommand.d.ts +23 -0
  6. package/dist-types/commands/DeleteApplicationCommand.d.ts +12 -0
  7. package/dist-types/commands/DeleteConfigurationProfileCommand.d.ts +12 -0
  8. package/dist-types/commands/DeleteDeploymentStrategyCommand.d.ts +11 -0
  9. package/dist-types/commands/DeleteEnvironmentCommand.d.ts +12 -0
  10. package/dist-types/commands/DeleteHostedConfigurationVersionCommand.d.ts +13 -0
  11. package/dist-types/commands/GetApplicationCommand.d.ts +17 -0
  12. package/dist-types/commands/GetConfigurationCommand.d.ts +20 -0
  13. package/dist-types/commands/GetConfigurationProfileCommand.d.ts +21 -0
  14. package/dist-types/commands/GetDeploymentCommand.d.ts +77 -0
  15. package/dist-types/commands/GetDeploymentStrategyCommand.d.ts +22 -0
  16. package/dist-types/commands/GetEnvironmentCommand.d.ts +20 -0
  17. package/dist-types/commands/GetHostedConfigurationVersionCommand.d.ts +21 -0
  18. package/dist-types/commands/ListApplicationsCommand.d.ts +24 -0
  19. package/dist-types/commands/ListConfigurationProfilesCommand.d.ts +23 -0
  20. package/dist-types/commands/ListDeploymentStrategiesCommand.d.ts +24 -0
  21. package/dist-types/commands/ListDeploymentsCommand.d.ts +31 -0
  22. package/dist-types/commands/ListEnvironmentsCommand.d.ts +23 -0
  23. package/dist-types/commands/ListHostedConfigurationVersionsCommand.d.ts +24 -0
  24. package/dist-types/commands/ListTagsForResourceCommand.d.ts +18 -0
  25. package/dist-types/commands/StartDeploymentCommand.d.ts +44 -0
  26. package/dist-types/commands/StopDeploymentCommand.d.ts +22 -0
  27. package/dist-types/commands/TagResourceCommand.d.ts +14 -0
  28. package/dist-types/commands/UntagResourceCommand.d.ts +14 -0
  29. package/dist-types/commands/UpdateApplicationCommand.d.ts +20 -0
  30. package/dist-types/commands/UpdateConfigurationProfileCommand.d.ts +23 -0
  31. package/dist-types/commands/UpdateDeploymentStrategyCommand.d.ts +24 -0
  32. package/dist-types/commands/UpdateEnvironmentCommand.d.ts +22 -0
  33. package/dist-types/commands/ValidateConfigurationCommand.d.ts +13 -0
  34. package/package.json +29 -29
@@ -33,6 +33,25 @@ export interface CreateApplicationCommandOutput extends Application, __MetadataB
33
33
  * @see {@link CreateApplicationCommandOutput} for command's `response` shape.
34
34
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
35
35
  *
36
+ * @example To create an application
37
+ * ```javascript
38
+ * // The following create-application example creates an application in AWS AppConfig.
39
+ * const input = {
40
+ * "Description": "An application used for creating an example.",
41
+ * "Name": "example-application"
42
+ * };
43
+ * const command = new CreateApplicationCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "Description": "An application used for creating an example.",
48
+ * "Id": "339ohji",
49
+ * "Name": "example-application"
50
+ * }
51
+ * *\/
52
+ * // example id: to-create-an-application-1632264511615
53
+ * ```
54
+ *
36
55
  */
37
56
  export declare class CreateApplicationCommand extends $Command<CreateApplicationCommandInput, CreateApplicationCommandOutput, AppConfigClientResolvedConfig> {
38
57
  readonly input: CreateApplicationCommandInput;
@@ -68,6 +68,29 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr
68
68
  * @see {@link CreateConfigurationProfileCommandOutput} for command's `response` shape.
69
69
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
70
70
  *
71
+ * @example To create a configuration profile
72
+ * ```javascript
73
+ * // The following create-configuration-profile example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager.
74
+ * const input = {
75
+ * "ApplicationId": "339ohji",
76
+ * "LocationUri": "ssm-parameter://Example-Parameter",
77
+ * "Name": "Example-Configuration-Profile",
78
+ * "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
79
+ * };
80
+ * const command = new CreateConfigurationProfileCommand(input);
81
+ * const response = await client.send(command);
82
+ * /* response ==
83
+ * {
84
+ * "ApplicationId": "339ohji",
85
+ * "Id": "ur8hx2f",
86
+ * "LocationUri": "ssm-parameter://Example-Parameter",
87
+ * "Name": "Example-Configuration-Profile",
88
+ * "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
89
+ * }
90
+ * *\/
91
+ * // example id: to-create-a-configuration-profile-1632264580336
92
+ * ```
93
+ *
71
94
  */
72
95
  export declare class CreateConfigurationProfileCommand extends $Command<CreateConfigurationProfileCommandInput, CreateConfigurationProfileCommandOutput, AppConfigClientResolvedConfig> {
73
96
  readonly input: CreateConfigurationProfileCommandInput;
@@ -32,6 +32,31 @@ export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrateg
32
32
  * @see {@link CreateDeploymentStrategyCommandOutput} for command's `response` shape.
33
33
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
34
34
  *
35
+ * @example To create a deployment strategy
36
+ * ```javascript
37
+ * // The following create-deployment-strategy example creates a deployment strategy called Example-Deployment that takes 15 minutes and deploys the configuration to 25% of the application at a time. The strategy is also copied to an SSM Document.
38
+ * const input = {
39
+ * "DeploymentDurationInMinutes": 15,
40
+ * "GrowthFactor": 25,
41
+ * "Name": "Example-Deployment",
42
+ * "ReplicateTo": "SSM_DOCUMENT"
43
+ * };
44
+ * const command = new CreateDeploymentStrategyCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "DeploymentDurationInMinutes": 15,
49
+ * "FinalBakeTimeInMinutes": 0,
50
+ * "GrowthFactor": 25,
51
+ * "GrowthType": "LINEAR",
52
+ * "Id": "1225qzk",
53
+ * "Name": "Example-Deployment",
54
+ * "ReplicateTo": "SSM_DOCUMENT"
55
+ * }
56
+ * *\/
57
+ * // example id: to-create-a-deployment-strategy-1632264783812
58
+ * ```
59
+ *
35
60
  */
36
61
  export declare class CreateDeploymentStrategyCommand extends $Command<CreateDeploymentStrategyCommandInput, CreateDeploymentStrategyCommandOutput, AppConfigClientResolvedConfig> {
37
62
  readonly input: CreateDeploymentStrategyCommandInput;
@@ -36,6 +36,26 @@ export interface CreateEnvironmentCommandOutput extends Environment, __MetadataB
36
36
  * @see {@link CreateEnvironmentCommandOutput} for command's `response` shape.
37
37
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
38
38
  *
39
+ * @example To create an environment
40
+ * ```javascript
41
+ * // The following create-environment example creates an AWS AppConfig environment named Example-Environment using the application you created using create-application
42
+ * const input = {
43
+ * "ApplicationId": "339ohji",
44
+ * "Name": "Example-Environment"
45
+ * };
46
+ * const command = new CreateEnvironmentCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "ApplicationId": "339ohji",
51
+ * "Id": "54j1r29",
52
+ * "Name": "Example-Environment",
53
+ * "State": "READY_FOR_DEPLOYMENT"
54
+ * }
55
+ * *\/
56
+ * // example id: to-create-an-environment-1632265124975
57
+ * ```
58
+ *
39
59
  */
40
60
  export declare class CreateEnvironmentCommand extends $Command<CreateEnvironmentCommandInput, CreateEnvironmentCommandOutput, AppConfigClientResolvedConfig> {
41
61
  readonly input: CreateEnvironmentCommandInput;
@@ -30,6 +30,29 @@ export interface CreateHostedConfigurationVersionCommandOutput extends HostedCon
30
30
  * @see {@link CreateHostedConfigurationVersionCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @example To create a hosted configuration version
34
+ * ```javascript
35
+ * // The following create-hosted-configuration-version example creates a new configuration in the AWS AppConfig configuration store.
36
+ * const input = {
37
+ * "ApplicationId": "339ohji",
38
+ * "ConfigurationProfileId": "ur8hx2f",
39
+ * "Content": "eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9",
40
+ * "ContentType": "text",
41
+ * "LatestVersionNumber": 1
42
+ * };
43
+ * const command = new CreateHostedConfigurationVersionCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "ApplicationId": "339ohji",
48
+ * "ConfigurationProfileId": "ur8hx2f",
49
+ * "ContentType": "text",
50
+ * "VersionNumber": 1
51
+ * }
52
+ * *\/
53
+ * // example id: to-create-a-hosted-configuration-version-1632265196980
54
+ * ```
55
+ *
33
56
  */
34
57
  export declare class CreateHostedConfigurationVersionCommand extends $Command<CreateHostedConfigurationVersionCommandInput, CreateHostedConfigurationVersionCommandOutput, AppConfigClientResolvedConfig> {
35
58
  readonly input: CreateHostedConfigurationVersionCommandInput;
@@ -30,6 +30,18 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {
30
30
  * @see {@link DeleteApplicationCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @example To delete an application
34
+ * ```javascript
35
+ * // The following delete-application example deletes the specified application.
36
+ * //
37
+ * const input = {
38
+ * "ApplicationId": "339ohji"
39
+ * };
40
+ * const command = new DeleteApplicationCommand(input);
41
+ * await client.send(command);
42
+ * // example id: to-delete-an-application-1632265343951
43
+ * ```
44
+ *
33
45
  */
34
46
  export declare class DeleteApplicationCommand extends $Command<DeleteApplicationCommandInput, DeleteApplicationCommandOutput, AppConfigClientResolvedConfig> {
35
47
  readonly input: DeleteApplicationCommandInput;
@@ -30,6 +30,18 @@ export interface DeleteConfigurationProfileCommandOutput extends __MetadataBeare
30
30
  * @see {@link DeleteConfigurationProfileCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @example To delete a configuration profile
34
+ * ```javascript
35
+ * // The following delete-configuration-profile example deletes the specified configuration profile.
36
+ * const input = {
37
+ * "ApplicationId": "339ohji",
38
+ * "ConfigurationProfileId": "ur8hx2f"
39
+ * };
40
+ * const command = new DeleteConfigurationProfileCommand(input);
41
+ * await client.send(command);
42
+ * // example id: to-delete-a-configuration-profile-1632265401308
43
+ * ```
44
+ *
33
45
  */
34
46
  export declare class DeleteConfigurationProfileCommand extends $Command<DeleteConfigurationProfileCommandInput, DeleteConfigurationProfileCommandOutput, AppConfigClientResolvedConfig> {
35
47
  readonly input: DeleteConfigurationProfileCommandInput;
@@ -30,6 +30,17 @@ export interface DeleteDeploymentStrategyCommandOutput extends __MetadataBearer
30
30
  * @see {@link DeleteDeploymentStrategyCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @example To delete a deployment strategy
34
+ * ```javascript
35
+ * // The following delete-deployment-strategy example deletes the specified deployment strategy.
36
+ * const input = {
37
+ * "DeploymentStrategyId": "1225qzk"
38
+ * };
39
+ * const command = new DeleteDeploymentStrategyCommand(input);
40
+ * await client.send(command);
41
+ * // example id: to-delete-a-deployment-strategy-1632265473708
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteDeploymentStrategyCommand extends $Command<DeleteDeploymentStrategyCommandInput, DeleteDeploymentStrategyCommandOutput, AppConfigClientResolvedConfig> {
35
46
  readonly input: DeleteDeploymentStrategyCommandInput;
@@ -30,6 +30,18 @@ export interface DeleteEnvironmentCommandOutput extends __MetadataBearer {
30
30
  * @see {@link DeleteEnvironmentCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @example To delete an environment
34
+ * ```javascript
35
+ * // The following delete-environment example deletes the specified application environment.
36
+ * const input = {
37
+ * "ApplicationId": "339ohji",
38
+ * "EnvironmentId": "54j1r29"
39
+ * };
40
+ * const command = new DeleteEnvironmentCommand(input);
41
+ * await client.send(command);
42
+ * // example id: to-delete-an-environment-1632265641044
43
+ * ```
44
+ *
33
45
  */
34
46
  export declare class DeleteEnvironmentCommand extends $Command<DeleteEnvironmentCommandInput, DeleteEnvironmentCommandOutput, AppConfigClientResolvedConfig> {
35
47
  readonly input: DeleteEnvironmentCommandInput;
@@ -30,6 +30,19 @@ export interface DeleteHostedConfigurationVersionCommandOutput extends __Metadat
30
30
  * @see {@link DeleteHostedConfigurationVersionCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @example To delete a hosted configuration version
34
+ * ```javascript
35
+ * // The following delete-hosted-configuration-version example deletes a configuration version hosted in the AWS AppConfig configuration store.
36
+ * const input = {
37
+ * "ApplicationId": "339ohji",
38
+ * "ConfigurationProfileId": "ur8hx2f",
39
+ * "VersionNumber": 1
40
+ * };
41
+ * const command = new DeleteHostedConfigurationVersionCommand(input);
42
+ * await client.send(command);
43
+ * // example id: to-delete-a-hosted-configuration-version-1632265720740
44
+ * ```
45
+ *
33
46
  */
34
47
  export declare class DeleteHostedConfigurationVersionCommand extends $Command<DeleteHostedConfigurationVersionCommandInput, DeleteHostedConfigurationVersionCommandOutput, AppConfigClientResolvedConfig> {
35
48
  readonly input: DeleteHostedConfigurationVersionCommandInput;
@@ -29,6 +29,23 @@ export interface GetApplicationCommandOutput extends Application, __MetadataBear
29
29
  * @see {@link GetApplicationCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To list details of an application
33
+ * ```javascript
34
+ * // The following get-application example lists the details of the specified application.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji"
37
+ * };
38
+ * const command = new GetApplicationCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "Id": "339ohji",
43
+ * "Name": "example-application"
44
+ * }
45
+ * *\/
46
+ * // example id: to-list-details-of-an-application-1632265864702
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class GetApplicationCommand extends $Command<GetApplicationCommandInput, GetApplicationCommandOutput, AppConfigClientResolvedConfig> {
34
51
  readonly input: GetApplicationCommandInput;
@@ -45,6 +45,26 @@ export interface GetConfigurationCommandOutput extends Configuration, __Metadata
45
45
  * @see {@link GetConfigurationCommandOutput} for command's `response` shape.
46
46
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
47
47
  *
48
+ * @example To retrieve configuration details
49
+ * ```javascript
50
+ * // The following get-configuration example returns the configuration details of the example application. On subsequent calls to get-configuration, use the client-configuration-version parameter to only update the configuration of your application if the version has changed. Only updating the configuration when the version has changed avoids excess charges incurred by calling get-configuration.
51
+ * const input = {
52
+ * "Application": "example-application",
53
+ * "ClientId": "example-id",
54
+ * "Configuration": "Example-Configuration-Profile",
55
+ * "Environment": "Example-Environment"
56
+ * };
57
+ * const command = new GetConfigurationCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "ConfigurationVersion": "1",
62
+ * "ContentType": "application/octet-stream"
63
+ * }
64
+ * *\/
65
+ * // example id: to-retrieve-configuration-details-1632265954314
66
+ * ```
67
+ *
48
68
  */
49
69
  export declare class GetConfigurationCommand extends $Command<GetConfigurationCommandInput, GetConfigurationCommandOutput, AppConfigClientResolvedConfig> {
50
70
  readonly input: GetConfigurationCommandInput;
@@ -29,6 +29,27 @@ export interface GetConfigurationProfileCommandOutput extends ConfigurationProfi
29
29
  * @see {@link GetConfigurationProfileCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To retrieve configuration profile details
33
+ * ```javascript
34
+ * // The following get-configuration-profile example returns the details of the specified configuration profile.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji",
37
+ * "ConfigurationProfileId": "ur8hx2f"
38
+ * };
39
+ * const command = new GetConfigurationProfileCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "ApplicationId": "339ohji",
44
+ * "Id": "ur8hx2f",
45
+ * "LocationUri": "ssm-parameter://Example-Parameter",
46
+ * "Name": "Example-Configuration-Profile",
47
+ * "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
48
+ * }
49
+ * *\/
50
+ * // example id: to-retrieve-configuration-profile-details-1632266081013
51
+ * ```
52
+ *
32
53
  */
33
54
  export declare class GetConfigurationProfileCommand extends $Command<GetConfigurationProfileCommandInput, GetConfigurationProfileCommandOutput, AppConfigClientResolvedConfig> {
34
55
  readonly input: GetConfigurationProfileCommandInput;
@@ -29,6 +29,83 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer
29
29
  * @see {@link GetDeploymentCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To retrieve deployment details
33
+ * ```javascript
34
+ * // The following get-deployment example lists details of the deployment to the application in the specified environment and deployment.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji",
37
+ * "DeploymentNumber": 1,
38
+ * "EnvironmentId": "54j1r29"
39
+ * };
40
+ * const command = new GetDeploymentCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "ApplicationId": "339ohji",
45
+ * "CompletedAt": "2021-09-17T21:59:03.888000+00:00",
46
+ * "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
47
+ * "ConfigurationName": "Example-Configuration-Profile",
48
+ * "ConfigurationProfileId": "ur8hx2f",
49
+ * "ConfigurationVersion": "1",
50
+ * "DeploymentDurationInMinutes": 15,
51
+ * "DeploymentNumber": 1,
52
+ * "DeploymentStrategyId": "1225qzk",
53
+ * "EnvironmentId": "54j1r29",
54
+ * "EventLog": [
55
+ * {
56
+ * "Description": "Deployment completed",
57
+ * "EventType": "DEPLOYMENT_COMPLETED",
58
+ * "OccurredAt": "2021-09-17T21:59:03.888000+00:00",
59
+ * "TriggeredBy": "APPCONFIG"
60
+ * },
61
+ * {
62
+ * "Description": "Deployment bake time started",
63
+ * "EventType": "BAKE_TIME_STARTED",
64
+ * "OccurredAt": "2021-09-17T21:58:57.722000+00:00",
65
+ * "TriggeredBy": "APPCONFIG"
66
+ * },
67
+ * {
68
+ * "Description": "Configuration available to 100.00% of clients",
69
+ * "EventType": "PERCENTAGE_UPDATED",
70
+ * "OccurredAt": "2021-09-17T21:55:56.816000+00:00",
71
+ * "TriggeredBy": "APPCONFIG"
72
+ * },
73
+ * {
74
+ * "Description": "Configuration available to 75.00% of clients",
75
+ * "EventType": "PERCENTAGE_UPDATED",
76
+ * "OccurredAt": "2021-09-17T21:52:56.567000+00:00",
77
+ * "TriggeredBy": "APPCONFIG"
78
+ * },
79
+ * {
80
+ * "Description": "Configuration available to 50.00% of clients",
81
+ * "EventType": "PERCENTAGE_UPDATED",
82
+ * "OccurredAt": "2021-09-17T21:49:55.737000+00:00",
83
+ * "TriggeredBy": "APPCONFIG"
84
+ * },
85
+ * {
86
+ * "Description": "Configuration available to 25.00% of clients",
87
+ * "EventType": "PERCENTAGE_UPDATED",
88
+ * "OccurredAt": "2021-09-17T21:46:55.187000+00:00",
89
+ * "TriggeredBy": "APPCONFIG"
90
+ * },
91
+ * {
92
+ * "Description": "Deployment started",
93
+ * "EventType": "DEPLOYMENT_STARTED",
94
+ * "OccurredAt": "2021-09-17T21:43:54.205000+00:00",
95
+ * "TriggeredBy": "USER"
96
+ * }
97
+ * ],
98
+ * "FinalBakeTimeInMinutes": 0,
99
+ * "GrowthFactor": 25,
100
+ * "GrowthType": "LINEAR",
101
+ * "PercentageComplete": 100,
102
+ * "StartedAt": "2021-09-17T21:43:54.205000+00:00",
103
+ * "State": "COMPLETE"
104
+ * }
105
+ * *\/
106
+ * // example id: to-retrieve-deployment-details-1633976766883
107
+ * ```
108
+ *
32
109
  */
33
110
  export declare class GetDeploymentCommand extends $Command<GetDeploymentCommandInput, GetDeploymentCommandOutput, AppConfigClientResolvedConfig> {
34
111
  readonly input: GetDeploymentCommandInput;
@@ -33,6 +33,28 @@ export interface GetDeploymentStrategyCommandOutput extends DeploymentStrategy,
33
33
  * @see {@link GetDeploymentStrategyCommandOutput} for command's `response` shape.
34
34
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
35
35
  *
36
+ * @example To retrieve details of a deployment strategy
37
+ * ```javascript
38
+ * // The following get-deployment-strategy example lists the details of the specified deployment strategy.
39
+ * const input = {
40
+ * "DeploymentStrategyId": "1225qzk"
41
+ * };
42
+ * const command = new GetDeploymentStrategyCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "DeploymentDurationInMinutes": 15,
47
+ * "FinalBakeTimeInMinutes": 0,
48
+ * "GrowthFactor": 25,
49
+ * "GrowthType": "LINEAR",
50
+ * "Id": "1225qzk",
51
+ * "Name": "Example-Deployment",
52
+ * "ReplicateTo": "SSM_DOCUMENT"
53
+ * }
54
+ * *\/
55
+ * // example id: to-retrieve-details-of-a-deployment-strategy-1632266385805
56
+ * ```
57
+ *
36
58
  */
37
59
  export declare class GetDeploymentStrategyCommand extends $Command<GetDeploymentStrategyCommandInput, GetDeploymentStrategyCommandOutput, AppConfigClientResolvedConfig> {
38
60
  readonly input: GetDeploymentStrategyCommandInput;
@@ -34,6 +34,26 @@ export interface GetEnvironmentCommandOutput extends Environment, __MetadataBear
34
34
  * @see {@link GetEnvironmentCommandOutput} for command's `response` shape.
35
35
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
36
36
  *
37
+ * @example To retrieve environment details
38
+ * ```javascript
39
+ * // The following get-environment example returns the details and state of the specified environment.
40
+ * const input = {
41
+ * "ApplicationId": "339ohji",
42
+ * "EnvironmentId": "54j1r29"
43
+ * };
44
+ * const command = new GetEnvironmentCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "ApplicationId": "339ohji",
49
+ * "Id": "54j1r29",
50
+ * "Name": "Example-Environment",
51
+ * "State": "READY_FOR_DEPLOYMENT"
52
+ * }
53
+ * *\/
54
+ * // example id: to-retrieve-environment-details-1632266924806
55
+ * ```
56
+ *
37
57
  */
38
58
  export declare class GetEnvironmentCommand extends $Command<GetEnvironmentCommandInput, GetEnvironmentCommandOutput, AppConfigClientResolvedConfig> {
39
59
  readonly input: GetEnvironmentCommandInput;
@@ -29,6 +29,27 @@ export interface GetHostedConfigurationVersionCommandOutput extends HostedConfig
29
29
  * @see {@link GetHostedConfigurationVersionCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To retrieve hosted configuration details
33
+ * ```javascript
34
+ * // The following get-hosted-configuration-version example retrieves the configuration details of the AWS AppConfig hosted configuration.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji",
37
+ * "ConfigurationProfileId": "ur8hx2f",
38
+ * "VersionNumber": 1
39
+ * };
40
+ * const command = new GetHostedConfigurationVersionCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "ApplicationId": "339ohji",
45
+ * "ConfigurationProfileId": "ur8hx2f",
46
+ * "ContentType": "application/json",
47
+ * "VersionNumber": 1
48
+ * }
49
+ * *\/
50
+ * // example id: to-retrieve-hosted-configuration-details-1632267003527
51
+ * ```
52
+ *
32
53
  */
33
54
  export declare class GetHostedConfigurationVersionCommand extends $Command<GetHostedConfigurationVersionCommandInput, GetHostedConfigurationVersionCommandOutput, AppConfigClientResolvedConfig> {
34
55
  readonly input: GetHostedConfigurationVersionCommandInput;
@@ -29,6 +29,30 @@ export interface ListApplicationsCommandOutput extends Applications, __MetadataB
29
29
  * @see {@link ListApplicationsCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To list the available applications
33
+ * ```javascript
34
+ * // The following list-applications example lists the available applications in your AWS account.
35
+ * const input = {};
36
+ * const command = new ListApplicationsCommand(input);
37
+ * const response = await client.send(command);
38
+ * /* response ==
39
+ * {
40
+ * "Items": [
41
+ * {
42
+ * "Description": "An application used for creating an example.",
43
+ * "Id": "339ohji",
44
+ * "Name": "test-application"
45
+ * },
46
+ * {
47
+ * "Id": "rwalwu7",
48
+ * "Name": "Test-Application"
49
+ * }
50
+ * ]
51
+ * }
52
+ * *\/
53
+ * // example id: to-list-the-available-applications-1632267111131
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class ListApplicationsCommand extends $Command<ListApplicationsCommandInput, ListApplicationsCommandOutput, AppConfigClientResolvedConfig> {
34
58
  readonly input: ListApplicationsCommandInput;
@@ -29,6 +29,29 @@ export interface ListConfigurationProfilesCommandOutput extends ConfigurationPro
29
29
  * @see {@link ListConfigurationProfilesCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To list the available configuration profiles
33
+ * ```javascript
34
+ * // The following list-configuration-profiles example lists the available configuration profiles for the specified application.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji"
37
+ * };
38
+ * const command = new ListConfigurationProfilesCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "Items": [
43
+ * {
44
+ * "ApplicationId": "339ohji",
45
+ * "Id": "ur8hx2f",
46
+ * "LocationUri": "ssm-parameter://Example-Parameter",
47
+ * "Name": "Example-Configuration-Profile"
48
+ * }
49
+ * ]
50
+ * }
51
+ * *\/
52
+ * // example id: to-list-the-available-configuration-profiles-1632267193265
53
+ * ```
54
+ *
32
55
  */
33
56
  export declare class ListConfigurationProfilesCommand extends $Command<ListConfigurationProfilesCommandInput, ListConfigurationProfilesCommandOutput, AppConfigClientResolvedConfig> {
34
57
  readonly input: ListConfigurationProfilesCommandInput;
@@ -29,6 +29,30 @@ export interface ListDeploymentStrategiesCommandOutput extends DeploymentStrateg
29
29
  * @see {@link ListDeploymentStrategiesCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To list the available deployment strategies
33
+ * ```javascript
34
+ * // The following list-deployment-strategies example lists the available deployment strategies in your AWS account.
35
+ * const input = {};
36
+ * const command = new ListDeploymentStrategiesCommand(input);
37
+ * const response = await client.send(command);
38
+ * /* response ==
39
+ * {
40
+ * "Items": [
41
+ * {
42
+ * "DeploymentDurationInMinutes": 15,
43
+ * "FinalBakeTimeInMinutes": 0,
44
+ * "GrowthFactor": 25,
45
+ * "GrowthType": "LINEAR",
46
+ * "Id": "1225qzk",
47
+ * "Name": "Example-Deployment",
48
+ * "ReplicateTo": "SSM_DOCUMENT"
49
+ * }
50
+ * ]
51
+ * }
52
+ * *\/
53
+ * // example id: to-list-the-available-deployment-strategies-1632267364180
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class ListDeploymentStrategiesCommand extends $Command<ListDeploymentStrategiesCommandInput, ListDeploymentStrategiesCommandOutput, AppConfigClientResolvedConfig> {
34
58
  readonly input: ListDeploymentStrategiesCommandInput;
@@ -29,6 +29,37 @@ export interface ListDeploymentsCommandOutput extends Deployments, __MetadataBea
29
29
  * @see {@link ListDeploymentsCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To list the available deployments
33
+ * ```javascript
34
+ * // The following list-deployments example lists the available deployments in your AWS account for the specified application and environment.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji",
37
+ * "EnvironmentId": "54j1r29"
38
+ * };
39
+ * const command = new ListDeploymentsCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Items": [
44
+ * {
45
+ * "CompletedAt": "2021-09-17T21:59:03.888000+00:00",
46
+ * "ConfigurationName": "Example-Configuration-Profile",
47
+ * "ConfigurationVersion": "1",
48
+ * "DeploymentDurationInMinutes": 15,
49
+ * "DeploymentNumber": 1,
50
+ * "FinalBakeTimeInMinutes": 0,
51
+ * "GrowthFactor": 25,
52
+ * "GrowthType": "LINEAR",
53
+ * "PercentageComplete": 100,
54
+ * "StartedAt": "2021-09-17T21:43:54.205000+00:00",
55
+ * "State": "COMPLETE"
56
+ * }
57
+ * ]
58
+ * }
59
+ * *\/
60
+ * // example id: to-list-the-available-deployments-1632267282025
61
+ * ```
62
+ *
32
63
  */
33
64
  export declare class ListDeploymentsCommand extends $Command<ListDeploymentsCommandInput, ListDeploymentsCommandOutput, AppConfigClientResolvedConfig> {
34
65
  readonly input: ListDeploymentsCommandInput;
@@ -29,6 +29,29 @@ export interface ListEnvironmentsCommandOutput extends Environments, __MetadataB
29
29
  * @see {@link ListEnvironmentsCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To list the available environments
33
+ * ```javascript
34
+ * // The following list-environments example lists the available environments in your AWS account for the specified application.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji"
37
+ * };
38
+ * const command = new ListEnvironmentsCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "Items": [
43
+ * {
44
+ * "ApplicationId": "339ohji",
45
+ * "Id": "54j1r29",
46
+ * "Name": "Example-Environment",
47
+ * "State": "READY_FOR_DEPLOYMENT"
48
+ * }
49
+ * ]
50
+ * }
51
+ * *\/
52
+ * // example id: to-list-the-available-environments-1632267474389
53
+ * ```
54
+ *
32
55
  */
33
56
  export declare class ListEnvironmentsCommand extends $Command<ListEnvironmentsCommandInput, ListEnvironmentsCommandOutput, AppConfigClientResolvedConfig> {
34
57
  readonly input: ListEnvironmentsCommandInput;
@@ -30,6 +30,30 @@ export interface ListHostedConfigurationVersionsCommandOutput extends HostedConf
30
30
  * @see {@link ListHostedConfigurationVersionsCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @example To list the available hosted configuration versions
34
+ * ```javascript
35
+ * // 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.
36
+ * const input = {
37
+ * "ApplicationId": "339ohji",
38
+ * "ConfigurationProfileId": "ur8hx2f"
39
+ * };
40
+ * const command = new ListHostedConfigurationVersionsCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "Items": [
45
+ * {
46
+ * "ApplicationId": "339ohji",
47
+ * "ConfigurationProfileId": "ur8hx2f",
48
+ * "ContentType": "application/json",
49
+ * "VersionNumber": 1
50
+ * }
51
+ * ]
52
+ * }
53
+ * *\/
54
+ * // example id: to-list-the-available-hosted-configuration-versions-1632267647667
55
+ * ```
56
+ *
33
57
  */
34
58
  export declare class ListHostedConfigurationVersionsCommand extends $Command<ListHostedConfigurationVersionsCommandInput, ListHostedConfigurationVersionsCommandOutput, AppConfigClientResolvedConfig> {
35
59
  readonly input: ListHostedConfigurationVersionsCommandInput;
@@ -29,6 +29,24 @@ export interface ListTagsForResourceCommandOutput extends ResourceTags, __Metada
29
29
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To list the tags of an application
33
+ * ```javascript
34
+ * // The following list-tags-for-resource example lists the tags of a specified application.
35
+ * const input = {
36
+ * "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji"
37
+ * };
38
+ * const command = new ListTagsForResourceCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "Tags": {
43
+ * "group1": "1"
44
+ * }
45
+ * }
46
+ * *\/
47
+ * // example id: to-list-the-tags-of-an-application-1632328796560
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, AppConfigClientResolvedConfig> {
34
52
  readonly input: ListTagsForResourceCommandInput;
@@ -29,6 +29,50 @@ export interface StartDeploymentCommandOutput extends Deployment, __MetadataBear
29
29
  * @see {@link StartDeploymentCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To start a configuration deployment
33
+ * ```javascript
34
+ * // The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji",
37
+ * "ConfigurationProfileId": "ur8hx2f",
38
+ * "ConfigurationVersion": "1",
39
+ * "DeploymentStrategyId": "1225qzk",
40
+ * "Description": "",
41
+ * "EnvironmentId": "54j1r29",
42
+ * "Tags": {}
43
+ * };
44
+ * const command = new StartDeploymentCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "ApplicationId": "339ohji",
49
+ * "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
50
+ * "ConfigurationName": "Example-Configuration-Profile",
51
+ * "ConfigurationProfileId": "ur8hx2f",
52
+ * "ConfigurationVersion": "1",
53
+ * "DeploymentDurationInMinutes": 15,
54
+ * "DeploymentNumber": 1,
55
+ * "DeploymentStrategyId": "1225qzk",
56
+ * "EnvironmentId": "54j1r29",
57
+ * "EventLog": [
58
+ * {
59
+ * "Description": "Deployment started",
60
+ * "EventType": "DEPLOYMENT_STARTED",
61
+ * "OccurredAt": "2021-09-17T21:43:54.205000+00:00",
62
+ * "TriggeredBy": "USER"
63
+ * }
64
+ * ],
65
+ * "FinalBakeTimeInMinutes": 0,
66
+ * "GrowthFactor": 25,
67
+ * "GrowthType": "LINEAR",
68
+ * "PercentageComplete": 1,
69
+ * "StartedAt": "2021-09-17T21:43:54.205000+00:00",
70
+ * "State": "DEPLOYING"
71
+ * }
72
+ * *\/
73
+ * // example id: to-start-a-configuration-deployment-1632328956790
74
+ * ```
75
+ *
32
76
  */
33
77
  export declare class StartDeploymentCommand extends $Command<StartDeploymentCommandInput, StartDeploymentCommandOutput, AppConfigClientResolvedConfig> {
34
78
  readonly input: StartDeploymentCommandInput;
@@ -31,6 +31,28 @@ export interface StopDeploymentCommandOutput extends Deployment, __MetadataBeare
31
31
  * @see {@link StopDeploymentCommandOutput} for command's `response` shape.
32
32
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
33
33
  *
34
+ * @example To stop configuration deployment
35
+ * ```javascript
36
+ * // The following stop-deployment example stops the deployment of an application configuration to the specified environment.
37
+ * const input = {
38
+ * "ApplicationId": "339ohji",
39
+ * "DeploymentNumber": 2,
40
+ * "EnvironmentId": "54j1r29"
41
+ * };
42
+ * const command = new StopDeploymentCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "DeploymentDurationInMinutes": 15,
47
+ * "DeploymentNumber": 2,
48
+ * "FinalBakeTimeInMinutes": 0,
49
+ * "GrowthFactor": 25,
50
+ * "PercentageComplete": 1
51
+ * }
52
+ * *\/
53
+ * // example id: to-stop-configuration-deployment-1632329139126
54
+ * ```
55
+ *
34
56
  */
35
57
  export declare class StopDeploymentCommand extends $Command<StopDeploymentCommandInput, StopDeploymentCommandOutput, AppConfigClientResolvedConfig> {
36
58
  readonly input: StopDeploymentCommandInput;
@@ -31,6 +31,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
31
31
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
32
32
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
33
33
  *
34
+ * @example To tag an application
35
+ * ```javascript
36
+ * // The following tag-resource example tags an application resource.
37
+ * const input = {
38
+ * "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji",
39
+ * "Tags": {
40
+ * "group1": "1"
41
+ * }
42
+ * };
43
+ * const command = new TagResourceCommand(input);
44
+ * await client.send(command);
45
+ * // example id: to-tag-an-application-1632330350645
46
+ * ```
47
+ *
34
48
  */
35
49
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, AppConfigClientResolvedConfig> {
36
50
  readonly input: TagResourceCommandInput;
@@ -29,6 +29,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
29
29
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To remove a tag from an application
33
+ * ```javascript
34
+ * // The following untag-resource example removes the group1 tag from the specified application.
35
+ * const input = {
36
+ * "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji",
37
+ * "TagKeys": [
38
+ * "group1"
39
+ * ]
40
+ * };
41
+ * const command = new UntagResourceCommand(input);
42
+ * await client.send(command);
43
+ * // example id: to-remove-a-tag-from-an-application-1632330429881
44
+ * ```
45
+ *
32
46
  */
33
47
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, AppConfigClientResolvedConfig> {
34
48
  readonly input: UntagResourceCommandInput;
@@ -29,6 +29,26 @@ export interface UpdateApplicationCommandOutput extends Application, __MetadataB
29
29
  * @see {@link UpdateApplicationCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To update an application
33
+ * ```javascript
34
+ * // The following update-application example updates the name of the specified application.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji",
37
+ * "Description": "",
38
+ * "Name": "Example-Application"
39
+ * };
40
+ * const command = new UpdateApplicationCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "Description": "An application used for creating an example.",
45
+ * "Id": "339ohji",
46
+ * "Name": "Example-Application"
47
+ * }
48
+ * *\/
49
+ * // example id: to-update-an-application-1632330585893
50
+ * ```
51
+ *
32
52
  */
33
53
  export declare class UpdateApplicationCommand extends $Command<UpdateApplicationCommandInput, UpdateApplicationCommandOutput, AppConfigClientResolvedConfig> {
34
54
  readonly input: UpdateApplicationCommandInput;
@@ -29,6 +29,29 @@ export interface UpdateConfigurationProfileCommandOutput extends ConfigurationPr
29
29
  * @see {@link UpdateConfigurationProfileCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To update a configuration profile
33
+ * ```javascript
34
+ * // The following update-configuration-profile example updates the description of the specified configuration profile.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji",
37
+ * "ConfigurationProfileId": "ur8hx2f",
38
+ * "Description": "Configuration profile used for examples."
39
+ * };
40
+ * const command = new UpdateConfigurationProfileCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "ApplicationId": "339ohji",
45
+ * "Description": "Configuration profile used for examples.",
46
+ * "Id": "ur8hx2f",
47
+ * "LocationUri": "ssm-parameter://Example-Parameter",
48
+ * "Name": "Example-Configuration-Profile",
49
+ * "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
50
+ * }
51
+ * *\/
52
+ * // example id: to-update-a-configuration-profile-1632330721974
53
+ * ```
54
+ *
32
55
  */
33
56
  export declare class UpdateConfigurationProfileCommand extends $Command<UpdateConfigurationProfileCommandInput, UpdateConfigurationProfileCommandOutput, AppConfigClientResolvedConfig> {
34
57
  readonly input: UpdateConfigurationProfileCommandInput;
@@ -29,6 +29,30 @@ export interface UpdateDeploymentStrategyCommandOutput extends DeploymentStrateg
29
29
  * @see {@link UpdateDeploymentStrategyCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To update a deployment strategy
33
+ * ```javascript
34
+ * // The following update-deployment-strategy example updates final bake time to 20 minutes in the specified deployment strategy. ::
35
+ * //
36
+ * const input = {
37
+ * "DeploymentStrategyId": "1225qzk",
38
+ * "FinalBakeTimeInMinutes": 20
39
+ * };
40
+ * const command = new UpdateDeploymentStrategyCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "DeploymentDurationInMinutes": 15,
45
+ * "FinalBakeTimeInMinutes": 20,
46
+ * "GrowthFactor": 25,
47
+ * "GrowthType": "LINEAR",
48
+ * "Id": "1225qzk",
49
+ * "Name": "Example-Deployment",
50
+ * "ReplicateTo": "SSM_DOCUMENT"
51
+ * }
52
+ * *\/
53
+ * // example id: to-update-a-deployment-strategy-1632330896602
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class UpdateDeploymentStrategyCommand extends $Command<UpdateDeploymentStrategyCommandInput, UpdateDeploymentStrategyCommandOutput, AppConfigClientResolvedConfig> {
34
58
  readonly input: UpdateDeploymentStrategyCommandInput;
@@ -29,6 +29,28 @@ export interface UpdateEnvironmentCommandOutput extends Environment, __MetadataB
29
29
  * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To update an environment
33
+ * ```javascript
34
+ * // The following update-environment example updates an environment's description.
35
+ * const input = {
36
+ * "ApplicationId": "339ohji",
37
+ * "Description": "An environment for examples.",
38
+ * "EnvironmentId": "54j1r29"
39
+ * };
40
+ * const command = new UpdateEnvironmentCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "ApplicationId": "339ohji",
45
+ * "Description": "An environment for examples.",
46
+ * "Id": "54j1r29",
47
+ * "Name": "Example-Environment",
48
+ * "State": "ROLLED_BACK"
49
+ * }
50
+ * *\/
51
+ * // example id: to-update-an-environment-1632331382428
52
+ * ```
53
+ *
32
54
  */
33
55
  export declare class UpdateEnvironmentCommand extends $Command<UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput, AppConfigClientResolvedConfig> {
34
56
  readonly input: UpdateEnvironmentCommandInput;
@@ -29,6 +29,19 @@ export interface ValidateConfigurationCommandOutput extends __MetadataBearer {
29
29
  * @see {@link ValidateConfigurationCommandOutput} for command's `response` shape.
30
30
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
31
31
  *
32
+ * @example To validate a configuration
33
+ * ```javascript
34
+ * // The following validate-configuration example uses the validators in a configuration profile to validate a configuration.
35
+ * const input = {
36
+ * "ApplicationId": "abc1234",
37
+ * "ConfigurationProfileId": "ur8hx2f",
38
+ * "ConfigurationVersion": "1"
39
+ * };
40
+ * const command = new ValidateConfigurationCommand(input);
41
+ * await client.send(command);
42
+ * // example id: to-validate-a-configuration-1632331491365
43
+ * ```
44
+ *
32
45
  */
33
46
  export declare class ValidateConfigurationCommand extends $Command<ValidateConfigurationCommandInput, ValidateConfigurationCommandOutput, AppConfigClientResolvedConfig> {
34
47
  readonly input: ValidateConfigurationCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-appconfig",
3
3
  "description": "AWS SDK for JavaScript Appconfig Client for Node.js, Browser and React Native",
4
- "version": "3.287.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.287.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.287.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.287.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
55
  "tslib": "^2.3.1"
56
56
  },