@aws-sdk/client-appconfig 3.288.0 → 3.290.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 (44) hide show
  1. package/dist-types/commands/CreateApplicationCommand.d.ts +26 -0
  2. package/dist-types/commands/CreateConfigurationProfileCommand.d.ts +33 -0
  3. package/dist-types/commands/CreateDeploymentStrategyCommand.d.ts +32 -0
  4. package/dist-types/commands/CreateEnvironmentCommand.d.ts +30 -0
  5. package/dist-types/commands/CreateExtensionAssociationCommand.d.ts +13 -0
  6. package/dist-types/commands/CreateExtensionCommand.d.ts +14 -0
  7. package/dist-types/commands/CreateHostedConfigurationVersionCommand.d.ts +43 -0
  8. package/dist-types/commands/DeleteApplicationCommand.d.ts +22 -0
  9. package/dist-types/commands/DeleteConfigurationProfileCommand.d.ts +26 -0
  10. package/dist-types/commands/DeleteDeploymentStrategyCommand.d.ts +21 -0
  11. package/dist-types/commands/DeleteEnvironmentCommand.d.ts +26 -0
  12. package/dist-types/commands/DeleteExtensionAssociationCommand.d.ts +10 -0
  13. package/dist-types/commands/DeleteExtensionCommand.d.ts +10 -0
  14. package/dist-types/commands/DeleteHostedConfigurationVersionCommand.d.ts +23 -0
  15. package/dist-types/commands/GetApplicationCommand.d.ts +27 -0
  16. package/dist-types/commands/GetConfigurationCommand.d.ts +30 -0
  17. package/dist-types/commands/GetConfigurationProfileCommand.d.ts +31 -0
  18. package/dist-types/commands/GetDeploymentCommand.d.ts +87 -0
  19. package/dist-types/commands/GetDeploymentStrategyCommand.d.ts +32 -0
  20. package/dist-types/commands/GetEnvironmentCommand.d.ts +30 -0
  21. package/dist-types/commands/GetExtensionAssociationCommand.d.ts +10 -0
  22. package/dist-types/commands/GetExtensionCommand.d.ts +10 -0
  23. package/dist-types/commands/GetHostedConfigurationVersionCommand.d.ts +31 -0
  24. package/dist-types/commands/ListApplicationsCommand.d.ts +31 -0
  25. package/dist-types/commands/ListConfigurationProfilesCommand.d.ts +33 -0
  26. package/dist-types/commands/ListDeploymentStrategiesCommand.d.ts +31 -0
  27. package/dist-types/commands/ListDeploymentsCommand.d.ts +41 -0
  28. package/dist-types/commands/ListEnvironmentsCommand.d.ts +33 -0
  29. package/dist-types/commands/ListExtensionAssociationsCommand.d.ts +7 -0
  30. package/dist-types/commands/ListExtensionsCommand.d.ts +7 -0
  31. package/dist-types/commands/ListHostedConfigurationVersionsCommand.d.ts +34 -0
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +28 -0
  33. package/dist-types/commands/StartDeploymentCommand.d.ts +58 -0
  34. package/dist-types/commands/StopDeploymentCommand.d.ts +32 -0
  35. package/dist-types/commands/TagResourceCommand.d.ts +24 -0
  36. package/dist-types/commands/UntagResourceCommand.d.ts +24 -0
  37. package/dist-types/commands/UpdateApplicationCommand.d.ts +30 -0
  38. package/dist-types/commands/UpdateConfigurationProfileCommand.d.ts +33 -0
  39. package/dist-types/commands/UpdateDeploymentStrategyCommand.d.ts +34 -0
  40. package/dist-types/commands/UpdateEnvironmentCommand.d.ts +32 -0
  41. package/dist-types/commands/UpdateExtensionAssociationCommand.d.ts +10 -0
  42. package/dist-types/commands/UpdateExtensionCommand.d.ts +14 -0
  43. package/dist-types/commands/ValidateConfigurationCommand.d.ts +23 -0
  44. package/package.json +29 -29
@@ -33,6 +33,32 @@ 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
+ * @throws {@link BadRequestException} (client fault)
37
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
38
+ *
39
+ * @throws {@link InternalServerException} (server fault)
40
+ * <p>There was an internal failure in the AppConfig service.</p>
41
+ *
42
+ *
43
+ * @example To create an application
44
+ * ```javascript
45
+ * // The following create-application example creates an application in AWS AppConfig.
46
+ * const input = {
47
+ * "Description": "An application used for creating an example.",
48
+ * "Name": "example-application"
49
+ * };
50
+ * const command = new CreateApplicationCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "Description": "An application used for creating an example.",
55
+ * "Id": "339ohji",
56
+ * "Name": "example-application"
57
+ * }
58
+ * *\/
59
+ * // example id: to-create-an-application-1632264511615
60
+ * ```
61
+ *
36
62
  */
37
63
  export declare class CreateApplicationCommand extends $Command<CreateApplicationCommandInput, CreateApplicationCommandOutput, AppConfigClientResolvedConfig> {
38
64
  readonly input: CreateApplicationCommandInput;
@@ -68,6 +68,39 @@ 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
+ * @throws {@link BadRequestException} (client fault)
72
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
73
+ *
74
+ * @throws {@link InternalServerException} (server fault)
75
+ * <p>There was an internal failure in the AppConfig service.</p>
76
+ *
77
+ * @throws {@link ResourceNotFoundException} (client fault)
78
+ * <p>The requested resource could not be found.</p>
79
+ *
80
+ *
81
+ * @example To create a configuration profile
82
+ * ```javascript
83
+ * // The following create-configuration-profile example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager.
84
+ * const input = {
85
+ * "ApplicationId": "339ohji",
86
+ * "LocationUri": "ssm-parameter://Example-Parameter",
87
+ * "Name": "Example-Configuration-Profile",
88
+ * "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
89
+ * };
90
+ * const command = new CreateConfigurationProfileCommand(input);
91
+ * const response = await client.send(command);
92
+ * /* response ==
93
+ * {
94
+ * "ApplicationId": "339ohji",
95
+ * "Id": "ur8hx2f",
96
+ * "LocationUri": "ssm-parameter://Example-Parameter",
97
+ * "Name": "Example-Configuration-Profile",
98
+ * "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
99
+ * }
100
+ * *\/
101
+ * // example id: to-create-a-configuration-profile-1632264580336
102
+ * ```
103
+ *
71
104
  */
72
105
  export declare class CreateConfigurationProfileCommand extends $Command<CreateConfigurationProfileCommandInput, CreateConfigurationProfileCommandOutput, AppConfigClientResolvedConfig> {
73
106
  readonly input: CreateConfigurationProfileCommandInput;
@@ -32,6 +32,38 @@ 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
+ * @throws {@link BadRequestException} (client fault)
36
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
37
+ *
38
+ * @throws {@link InternalServerException} (server fault)
39
+ * <p>There was an internal failure in the AppConfig service.</p>
40
+ *
41
+ *
42
+ * @example To create a deployment strategy
43
+ * ```javascript
44
+ * // 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.
45
+ * const input = {
46
+ * "DeploymentDurationInMinutes": 15,
47
+ * "GrowthFactor": 25,
48
+ * "Name": "Example-Deployment",
49
+ * "ReplicateTo": "SSM_DOCUMENT"
50
+ * };
51
+ * const command = new CreateDeploymentStrategyCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "DeploymentDurationInMinutes": 15,
56
+ * "FinalBakeTimeInMinutes": 0,
57
+ * "GrowthFactor": 25,
58
+ * "GrowthType": "LINEAR",
59
+ * "Id": "1225qzk",
60
+ * "Name": "Example-Deployment",
61
+ * "ReplicateTo": "SSM_DOCUMENT"
62
+ * }
63
+ * *\/
64
+ * // example id: to-create-a-deployment-strategy-1632264783812
65
+ * ```
66
+ *
35
67
  */
36
68
  export declare class CreateDeploymentStrategyCommand extends $Command<CreateDeploymentStrategyCommandInput, CreateDeploymentStrategyCommandOutput, AppConfigClientResolvedConfig> {
37
69
  readonly input: CreateDeploymentStrategyCommandInput;
@@ -36,6 +36,36 @@ 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
+ * @throws {@link BadRequestException} (client fault)
40
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
41
+ *
42
+ * @throws {@link InternalServerException} (server fault)
43
+ * <p>There was an internal failure in the AppConfig service.</p>
44
+ *
45
+ * @throws {@link ResourceNotFoundException} (client fault)
46
+ * <p>The requested resource could not be found.</p>
47
+ *
48
+ *
49
+ * @example To create an environment
50
+ * ```javascript
51
+ * // The following create-environment example creates an AWS AppConfig environment named Example-Environment using the application you created using create-application
52
+ * const input = {
53
+ * "ApplicationId": "339ohji",
54
+ * "Name": "Example-Environment"
55
+ * };
56
+ * const command = new CreateEnvironmentCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "ApplicationId": "339ohji",
61
+ * "Id": "54j1r29",
62
+ * "Name": "Example-Environment",
63
+ * "State": "READY_FOR_DEPLOYMENT"
64
+ * }
65
+ * *\/
66
+ * // example id: to-create-an-environment-1632265124975
67
+ * ```
68
+ *
39
69
  */
40
70
  export declare class CreateEnvironmentCommand extends $Command<CreateEnvironmentCommandInput, CreateEnvironmentCommandOutput, AppConfigClientResolvedConfig> {
41
71
  readonly input: CreateEnvironmentCommandInput;
@@ -41,6 +41,19 @@ export interface CreateExtensionAssociationCommandOutput extends ExtensionAssoci
41
41
  * @see {@link CreateExtensionAssociationCommandOutput} for command's `response` shape.
42
42
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
43
43
  *
44
+ * @throws {@link BadRequestException} (client fault)
45
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
46
+ *
47
+ * @throws {@link InternalServerException} (server fault)
48
+ * <p>There was an internal failure in the AppConfig service.</p>
49
+ *
50
+ * @throws {@link ResourceNotFoundException} (client fault)
51
+ * <p>The requested resource could not be found.</p>
52
+ *
53
+ * @throws {@link ServiceQuotaExceededException} (client fault)
54
+ * <p>The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.</p>
55
+ *
56
+ *
44
57
  */
45
58
  export declare class CreateExtensionAssociationCommand extends $Command<CreateExtensionAssociationCommandInput, CreateExtensionAssociationCommandOutput, AppConfigClientResolvedConfig> {
46
59
  readonly input: CreateExtensionAssociationCommandInput;
@@ -37,6 +37,20 @@ export interface CreateExtensionCommandOutput extends Extension, __MetadataBeare
37
37
  * @see {@link CreateExtensionCommandOutput} for command's `response` shape.
38
38
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
39
39
  *
40
+ * @throws {@link BadRequestException} (client fault)
41
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
42
+ *
43
+ * @throws {@link ConflictException} (client fault)
44
+ * <p>The request could not be processed because of conflict in the current state of the
45
+ * resource.</p>
46
+ *
47
+ * @throws {@link InternalServerException} (server fault)
48
+ * <p>There was an internal failure in the AppConfig service.</p>
49
+ *
50
+ * @throws {@link ServiceQuotaExceededException} (client fault)
51
+ * <p>The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.</p>
52
+ *
53
+ *
40
54
  */
41
55
  export declare class CreateExtensionCommand extends $Command<CreateExtensionCommandInput, CreateExtensionCommandOutput, AppConfigClientResolvedConfig> {
42
56
  readonly input: CreateExtensionCommandInput;
@@ -30,6 +30,49 @@ 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
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
35
+ *
36
+ * @throws {@link ConflictException} (client fault)
37
+ * <p>The request could not be processed because of conflict in the current state of the
38
+ * resource.</p>
39
+ *
40
+ * @throws {@link InternalServerException} (server fault)
41
+ * <p>There was an internal failure in the AppConfig service.</p>
42
+ *
43
+ * @throws {@link PayloadTooLargeException} (client fault)
44
+ * <p>The configuration size is too large.</p>
45
+ *
46
+ * @throws {@link ResourceNotFoundException} (client fault)
47
+ * <p>The requested resource could not be found.</p>
48
+ *
49
+ * @throws {@link ServiceQuotaExceededException} (client fault)
50
+ * <p>The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.</p>
51
+ *
52
+ *
53
+ * @example To create a hosted configuration version
54
+ * ```javascript
55
+ * // The following create-hosted-configuration-version example creates a new configuration in the AWS AppConfig configuration store.
56
+ * const input = {
57
+ * "ApplicationId": "339ohji",
58
+ * "ConfigurationProfileId": "ur8hx2f",
59
+ * "Content": "eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9",
60
+ * "ContentType": "text",
61
+ * "LatestVersionNumber": 1
62
+ * };
63
+ * const command = new CreateHostedConfigurationVersionCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "ApplicationId": "339ohji",
68
+ * "ConfigurationProfileId": "ur8hx2f",
69
+ * "ContentType": "text",
70
+ * "VersionNumber": 1
71
+ * }
72
+ * *\/
73
+ * // example id: to-create-a-hosted-configuration-version-1632265196980
74
+ * ```
75
+ *
33
76
  */
34
77
  export declare class CreateHostedConfigurationVersionCommand extends $Command<CreateHostedConfigurationVersionCommandInput, CreateHostedConfigurationVersionCommandOutput, AppConfigClientResolvedConfig> {
35
78
  readonly input: CreateHostedConfigurationVersionCommandInput;
@@ -30,6 +30,28 @@ 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
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>There was an internal failure in the AppConfig service.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>The requested resource could not be found.</p>
41
+ *
42
+ *
43
+ * @example To delete an application
44
+ * ```javascript
45
+ * // The following delete-application example deletes the specified application.
46
+ * //
47
+ * const input = {
48
+ * "ApplicationId": "339ohji"
49
+ * };
50
+ * const command = new DeleteApplicationCommand(input);
51
+ * await client.send(command);
52
+ * // example id: to-delete-an-application-1632265343951
53
+ * ```
54
+ *
33
55
  */
34
56
  export declare class DeleteApplicationCommand extends $Command<DeleteApplicationCommandInput, DeleteApplicationCommandOutput, AppConfigClientResolvedConfig> {
35
57
  readonly input: DeleteApplicationCommandInput;
@@ -30,6 +30,32 @@ 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
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
35
+ *
36
+ * @throws {@link ConflictException} (client fault)
37
+ * <p>The request could not be processed because of conflict in the current state of the
38
+ * resource.</p>
39
+ *
40
+ * @throws {@link InternalServerException} (server fault)
41
+ * <p>There was an internal failure in the AppConfig service.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>The requested resource could not be found.</p>
45
+ *
46
+ *
47
+ * @example To delete a configuration profile
48
+ * ```javascript
49
+ * // The following delete-configuration-profile example deletes the specified configuration profile.
50
+ * const input = {
51
+ * "ApplicationId": "339ohji",
52
+ * "ConfigurationProfileId": "ur8hx2f"
53
+ * };
54
+ * const command = new DeleteConfigurationProfileCommand(input);
55
+ * await client.send(command);
56
+ * // example id: to-delete-a-configuration-profile-1632265401308
57
+ * ```
58
+ *
33
59
  */
34
60
  export declare class DeleteConfigurationProfileCommand extends $Command<DeleteConfigurationProfileCommandInput, DeleteConfigurationProfileCommandOutput, AppConfigClientResolvedConfig> {
35
61
  readonly input: DeleteConfigurationProfileCommandInput;
@@ -30,6 +30,27 @@ 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
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>There was an internal failure in the AppConfig service.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>The requested resource could not be found.</p>
41
+ *
42
+ *
43
+ * @example To delete a deployment strategy
44
+ * ```javascript
45
+ * // The following delete-deployment-strategy example deletes the specified deployment strategy.
46
+ * const input = {
47
+ * "DeploymentStrategyId": "1225qzk"
48
+ * };
49
+ * const command = new DeleteDeploymentStrategyCommand(input);
50
+ * await client.send(command);
51
+ * // example id: to-delete-a-deployment-strategy-1632265473708
52
+ * ```
53
+ *
33
54
  */
34
55
  export declare class DeleteDeploymentStrategyCommand extends $Command<DeleteDeploymentStrategyCommandInput, DeleteDeploymentStrategyCommandOutput, AppConfigClientResolvedConfig> {
35
56
  readonly input: DeleteDeploymentStrategyCommandInput;
@@ -30,6 +30,32 @@ 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
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
35
+ *
36
+ * @throws {@link ConflictException} (client fault)
37
+ * <p>The request could not be processed because of conflict in the current state of the
38
+ * resource.</p>
39
+ *
40
+ * @throws {@link InternalServerException} (server fault)
41
+ * <p>There was an internal failure in the AppConfig service.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>The requested resource could not be found.</p>
45
+ *
46
+ *
47
+ * @example To delete an environment
48
+ * ```javascript
49
+ * // The following delete-environment example deletes the specified application environment.
50
+ * const input = {
51
+ * "ApplicationId": "339ohji",
52
+ * "EnvironmentId": "54j1r29"
53
+ * };
54
+ * const command = new DeleteEnvironmentCommand(input);
55
+ * await client.send(command);
56
+ * // example id: to-delete-an-environment-1632265641044
57
+ * ```
58
+ *
33
59
  */
34
60
  export declare class DeleteEnvironmentCommand extends $Command<DeleteEnvironmentCommandInput, DeleteEnvironmentCommandOutput, AppConfigClientResolvedConfig> {
35
61
  readonly input: DeleteEnvironmentCommandInput;
@@ -30,6 +30,16 @@ export interface DeleteExtensionAssociationCommandOutput extends __MetadataBeare
30
30
  * @see {@link DeleteExtensionAssociationCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>There was an internal failure in the AppConfig service.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>The requested resource could not be found.</p>
41
+ *
42
+ *
33
43
  */
34
44
  export declare class DeleteExtensionAssociationCommand extends $Command<DeleteExtensionAssociationCommandInput, DeleteExtensionAssociationCommandOutput, AppConfigClientResolvedConfig> {
35
45
  readonly input: DeleteExtensionAssociationCommandInput;
@@ -30,6 +30,16 @@ export interface DeleteExtensionCommandOutput extends __MetadataBearer {
30
30
  * @see {@link DeleteExtensionCommandOutput} for command's `response` shape.
31
31
  * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
32
32
  *
33
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>There was an internal failure in the AppConfig service.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>The requested resource could not be found.</p>
41
+ *
42
+ *
33
43
  */
34
44
  export declare class DeleteExtensionCommand extends $Command<DeleteExtensionCommandInput, DeleteExtensionCommandOutput, AppConfigClientResolvedConfig> {
35
45
  readonly input: DeleteExtensionCommandInput;
@@ -30,6 +30,29 @@ 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
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>There was an internal failure in the AppConfig service.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>The requested resource could not be found.</p>
41
+ *
42
+ *
43
+ * @example To delete a hosted configuration version
44
+ * ```javascript
45
+ * // The following delete-hosted-configuration-version example deletes a configuration version hosted in the AWS AppConfig configuration store.
46
+ * const input = {
47
+ * "ApplicationId": "339ohji",
48
+ * "ConfigurationProfileId": "ur8hx2f",
49
+ * "VersionNumber": 1
50
+ * };
51
+ * const command = new DeleteHostedConfigurationVersionCommand(input);
52
+ * await client.send(command);
53
+ * // example id: to-delete-a-hosted-configuration-version-1632265720740
54
+ * ```
55
+ *
33
56
  */
34
57
  export declare class DeleteHostedConfigurationVersionCommand extends $Command<DeleteHostedConfigurationVersionCommandInput, DeleteHostedConfigurationVersionCommandOutput, AppConfigClientResolvedConfig> {
35
58
  readonly input: DeleteHostedConfigurationVersionCommandInput;
@@ -29,6 +29,33 @@ 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
+ * @throws {@link BadRequestException} (client fault)
33
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>There was an internal failure in the AppConfig service.</p>
37
+ *
38
+ * @throws {@link ResourceNotFoundException} (client fault)
39
+ * <p>The requested resource could not be found.</p>
40
+ *
41
+ *
42
+ * @example To list details of an application
43
+ * ```javascript
44
+ * // The following get-application example lists the details of the specified application.
45
+ * const input = {
46
+ * "ApplicationId": "339ohji"
47
+ * };
48
+ * const command = new GetApplicationCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Id": "339ohji",
53
+ * "Name": "example-application"
54
+ * }
55
+ * *\/
56
+ * // example id: to-list-details-of-an-application-1632265864702
57
+ * ```
58
+ *
32
59
  */
33
60
  export declare class GetApplicationCommand extends $Command<GetApplicationCommandInput, GetApplicationCommandOutput, AppConfigClientResolvedConfig> {
34
61
  readonly input: GetApplicationCommandInput;
@@ -45,6 +45,36 @@ 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
+ * @throws {@link BadRequestException} (client fault)
49
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
50
+ *
51
+ * @throws {@link InternalServerException} (server fault)
52
+ * <p>There was an internal failure in the AppConfig service.</p>
53
+ *
54
+ * @throws {@link ResourceNotFoundException} (client fault)
55
+ * <p>The requested resource could not be found.</p>
56
+ *
57
+ *
58
+ * @example To retrieve configuration details
59
+ * ```javascript
60
+ * // 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.
61
+ * const input = {
62
+ * "Application": "example-application",
63
+ * "ClientId": "example-id",
64
+ * "Configuration": "Example-Configuration-Profile",
65
+ * "Environment": "Example-Environment"
66
+ * };
67
+ * const command = new GetConfigurationCommand(input);
68
+ * const response = await client.send(command);
69
+ * /* response ==
70
+ * {
71
+ * "ConfigurationVersion": "1",
72
+ * "ContentType": "application/octet-stream"
73
+ * }
74
+ * *\/
75
+ * // example id: to-retrieve-configuration-details-1632265954314
76
+ * ```
77
+ *
48
78
  */
49
79
  export declare class GetConfigurationCommand extends $Command<GetConfigurationCommandInput, GetConfigurationCommandOutput, AppConfigClientResolvedConfig> {
50
80
  readonly input: GetConfigurationCommandInput;
@@ -29,6 +29,37 @@ 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
+ * @throws {@link BadRequestException} (client fault)
33
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>There was an internal failure in the AppConfig service.</p>
37
+ *
38
+ * @throws {@link ResourceNotFoundException} (client fault)
39
+ * <p>The requested resource could not be found.</p>
40
+ *
41
+ *
42
+ * @example To retrieve configuration profile details
43
+ * ```javascript
44
+ * // The following get-configuration-profile example returns the details of the specified configuration profile.
45
+ * const input = {
46
+ * "ApplicationId": "339ohji",
47
+ * "ConfigurationProfileId": "ur8hx2f"
48
+ * };
49
+ * const command = new GetConfigurationProfileCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "ApplicationId": "339ohji",
54
+ * "Id": "ur8hx2f",
55
+ * "LocationUri": "ssm-parameter://Example-Parameter",
56
+ * "Name": "Example-Configuration-Profile",
57
+ * "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
58
+ * }
59
+ * *\/
60
+ * // example id: to-retrieve-configuration-profile-details-1632266081013
61
+ * ```
62
+ *
32
63
  */
33
64
  export declare class GetConfigurationProfileCommand extends $Command<GetConfigurationProfileCommandInput, GetConfigurationProfileCommandOutput, AppConfigClientResolvedConfig> {
34
65
  readonly input: GetConfigurationProfileCommandInput;
@@ -29,6 +29,93 @@ 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
+ * @throws {@link BadRequestException} (client fault)
33
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>There was an internal failure in the AppConfig service.</p>
37
+ *
38
+ * @throws {@link ResourceNotFoundException} (client fault)
39
+ * <p>The requested resource could not be found.</p>
40
+ *
41
+ *
42
+ * @example To retrieve deployment details
43
+ * ```javascript
44
+ * // The following get-deployment example lists details of the deployment to the application in the specified environment and deployment.
45
+ * const input = {
46
+ * "ApplicationId": "339ohji",
47
+ * "DeploymentNumber": 1,
48
+ * "EnvironmentId": "54j1r29"
49
+ * };
50
+ * const command = new GetDeploymentCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "ApplicationId": "339ohji",
55
+ * "CompletedAt": "2021-09-17T21:59:03.888000+00:00",
56
+ * "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
57
+ * "ConfigurationName": "Example-Configuration-Profile",
58
+ * "ConfigurationProfileId": "ur8hx2f",
59
+ * "ConfigurationVersion": "1",
60
+ * "DeploymentDurationInMinutes": 15,
61
+ * "DeploymentNumber": 1,
62
+ * "DeploymentStrategyId": "1225qzk",
63
+ * "EnvironmentId": "54j1r29",
64
+ * "EventLog": [
65
+ * {
66
+ * "Description": "Deployment completed",
67
+ * "EventType": "DEPLOYMENT_COMPLETED",
68
+ * "OccurredAt": "2021-09-17T21:59:03.888000+00:00",
69
+ * "TriggeredBy": "APPCONFIG"
70
+ * },
71
+ * {
72
+ * "Description": "Deployment bake time started",
73
+ * "EventType": "BAKE_TIME_STARTED",
74
+ * "OccurredAt": "2021-09-17T21:58:57.722000+00:00",
75
+ * "TriggeredBy": "APPCONFIG"
76
+ * },
77
+ * {
78
+ * "Description": "Configuration available to 100.00% of clients",
79
+ * "EventType": "PERCENTAGE_UPDATED",
80
+ * "OccurredAt": "2021-09-17T21:55:56.816000+00:00",
81
+ * "TriggeredBy": "APPCONFIG"
82
+ * },
83
+ * {
84
+ * "Description": "Configuration available to 75.00% of clients",
85
+ * "EventType": "PERCENTAGE_UPDATED",
86
+ * "OccurredAt": "2021-09-17T21:52:56.567000+00:00",
87
+ * "TriggeredBy": "APPCONFIG"
88
+ * },
89
+ * {
90
+ * "Description": "Configuration available to 50.00% of clients",
91
+ * "EventType": "PERCENTAGE_UPDATED",
92
+ * "OccurredAt": "2021-09-17T21:49:55.737000+00:00",
93
+ * "TriggeredBy": "APPCONFIG"
94
+ * },
95
+ * {
96
+ * "Description": "Configuration available to 25.00% of clients",
97
+ * "EventType": "PERCENTAGE_UPDATED",
98
+ * "OccurredAt": "2021-09-17T21:46:55.187000+00:00",
99
+ * "TriggeredBy": "APPCONFIG"
100
+ * },
101
+ * {
102
+ * "Description": "Deployment started",
103
+ * "EventType": "DEPLOYMENT_STARTED",
104
+ * "OccurredAt": "2021-09-17T21:43:54.205000+00:00",
105
+ * "TriggeredBy": "USER"
106
+ * }
107
+ * ],
108
+ * "FinalBakeTimeInMinutes": 0,
109
+ * "GrowthFactor": 25,
110
+ * "GrowthType": "LINEAR",
111
+ * "PercentageComplete": 100,
112
+ * "StartedAt": "2021-09-17T21:43:54.205000+00:00",
113
+ * "State": "COMPLETE"
114
+ * }
115
+ * *\/
116
+ * // example id: to-retrieve-deployment-details-1633976766883
117
+ * ```
118
+ *
32
119
  */
33
120
  export declare class GetDeploymentCommand extends $Command<GetDeploymentCommandInput, GetDeploymentCommandOutput, AppConfigClientResolvedConfig> {
34
121
  readonly input: GetDeploymentCommandInput;