@aws-sdk/client-appconfig 3.325.0 → 3.327.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 +8 -0
  2. package/dist-types/commands/CreateConfigurationProfileCommand.d.ts +18 -0
  3. package/dist-types/commands/CreateDeploymentStrategyCommand.d.ts +13 -0
  4. package/dist-types/commands/CreateEnvironmentCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateExtensionAssociationCommand.d.ts +13 -0
  6. package/dist-types/commands/CreateExtensionCommand.d.ts +26 -0
  7. package/dist-types/commands/CreateHostedConfigurationVersionCommand.d.ts +12 -0
  8. package/dist-types/commands/DeleteApplicationCommand.d.ts +4 -0
  9. package/dist-types/commands/DeleteConfigurationProfileCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteDeploymentStrategyCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteEnvironmentCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteExtensionAssociationCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteExtensionCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteHostedConfigurationVersionCommand.d.ts +4 -0
  15. package/dist-types/commands/GetApplicationCommand.d.ts +8 -0
  16. package/dist-types/commands/GetConfigurationCommand.d.ts +8 -0
  17. package/dist-types/commands/GetConfigurationProfileCommand.d.ts +18 -0
  18. package/dist-types/commands/GetDeploymentCommand.d.ts +53 -0
  19. package/dist-types/commands/GetDeploymentStrategyCommand.d.ts +13 -0
  20. package/dist-types/commands/GetEnvironmentCommand.d.ts +16 -0
  21. package/dist-types/commands/GetExtensionAssociationCommand.d.ts +13 -0
  22. package/dist-types/commands/GetExtensionCommand.d.ts +26 -0
  23. package/dist-types/commands/GetHostedConfigurationVersionCommand.d.ts +12 -0
  24. package/dist-types/commands/ListApplicationsCommand.d.ts +13 -0
  25. package/dist-types/commands/ListConfigurationProfilesCommand.d.ts +18 -0
  26. package/dist-types/commands/ListDeploymentStrategiesCommand.d.ts +18 -0
  27. package/dist-types/commands/ListDeploymentsCommand.d.ts +21 -0
  28. package/dist-types/commands/ListEnvironmentsCommand.d.ts +21 -0
  29. package/dist-types/commands/ListExtensionAssociationsCommand.d.ts +13 -0
  30. package/dist-types/commands/ListExtensionsCommand.d.ts +15 -0
  31. package/dist-types/commands/ListHostedConfigurationVersionsCommand.d.ts +16 -0
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  33. package/dist-types/commands/StartDeploymentCommand.d.ts +53 -0
  34. package/dist-types/commands/StopDeploymentCommand.d.ts +53 -0
  35. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  36. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  37. package/dist-types/commands/UpdateApplicationCommand.d.ts +8 -0
  38. package/dist-types/commands/UpdateConfigurationProfileCommand.d.ts +18 -0
  39. package/dist-types/commands/UpdateDeploymentStrategyCommand.d.ts +13 -0
  40. package/dist-types/commands/UpdateEnvironmentCommand.d.ts +16 -0
  41. package/dist-types/commands/UpdateExtensionAssociationCommand.d.ts +13 -0
  42. package/dist-types/commands/UpdateExtensionCommand.d.ts +26 -0
  43. package/dist-types/commands/ValidateConfigurationCommand.d.ts +4 -0
  44. package/package.json +7 -7
@@ -39,6 +39,12 @@ export interface CreateApplicationCommandOutput extends Application, __MetadataB
39
39
  * };
40
40
  * const command = new CreateApplicationCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // Application
43
+ * // Id: "STRING_VALUE",
44
+ * // Name: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // };
47
+ *
42
48
  * ```
43
49
  *
44
50
  * @param CreateApplicationCommandInput - {@link CreateApplicationCommandInput}
@@ -53,6 +59,8 @@ export interface CreateApplicationCommandOutput extends Application, __MetadataB
53
59
  * @throws {@link InternalServerException} (server fault)
54
60
  * <p>There was an internal failure in the AppConfig service.</p>
55
61
  *
62
+ * @throws {@link AppConfigServiceException}
63
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
56
64
  *
57
65
  * @example To create an application
58
66
  * ```javascript
@@ -84,6 +84,22 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr
84
84
  * };
85
85
  * const command = new CreateConfigurationProfileCommand(input);
86
86
  * const response = await client.send(command);
87
+ * // { // ConfigurationProfile
88
+ * // ApplicationId: "STRING_VALUE",
89
+ * // Id: "STRING_VALUE",
90
+ * // Name: "STRING_VALUE",
91
+ * // Description: "STRING_VALUE",
92
+ * // LocationUri: "STRING_VALUE",
93
+ * // RetrievalRoleArn: "STRING_VALUE",
94
+ * // Validators: [ // ValidatorList
95
+ * // { // Validator
96
+ * // Type: "JSON_SCHEMA" || "LAMBDA", // required
97
+ * // Content: "STRING_VALUE", // required
98
+ * // },
99
+ * // ],
100
+ * // Type: "STRING_VALUE",
101
+ * // };
102
+ *
87
103
  * ```
88
104
  *
89
105
  * @param CreateConfigurationProfileCommandInput - {@link CreateConfigurationProfileCommandInput}
@@ -101,6 +117,8 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr
101
117
  * @throws {@link ResourceNotFoundException} (client fault)
102
118
  * <p>The requested resource could not be found.</p>
103
119
  *
120
+ * @throws {@link AppConfigServiceException}
121
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
104
122
  *
105
123
  * @example To create a configuration profile
106
124
  * ```javascript
@@ -43,6 +43,17 @@ export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrateg
43
43
  * };
44
44
  * const command = new CreateDeploymentStrategyCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // DeploymentStrategy
47
+ * // Id: "STRING_VALUE",
48
+ * // Name: "STRING_VALUE",
49
+ * // Description: "STRING_VALUE",
50
+ * // DeploymentDurationInMinutes: Number("int"),
51
+ * // GrowthType: "LINEAR" || "EXPONENTIAL",
52
+ * // GrowthFactor: Number("float"),
53
+ * // FinalBakeTimeInMinutes: Number("int"),
54
+ * // ReplicateTo: "NONE" || "SSM_DOCUMENT",
55
+ * // };
56
+ *
46
57
  * ```
47
58
  *
48
59
  * @param CreateDeploymentStrategyCommandInput - {@link CreateDeploymentStrategyCommandInput}
@@ -57,6 +68,8 @@ export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrateg
57
68
  * @throws {@link InternalServerException} (server fault)
58
69
  * <p>There was an internal failure in the AppConfig service.</p>
59
70
  *
71
+ * @throws {@link AppConfigServiceException}
72
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
60
73
  *
61
74
  * @example To create a deployment strategy
62
75
  * ```javascript
@@ -49,6 +49,20 @@ export interface CreateEnvironmentCommandOutput extends Environment, __MetadataB
49
49
  * };
50
50
  * const command = new CreateEnvironmentCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // Environment
53
+ * // ApplicationId: "STRING_VALUE",
54
+ * // Id: "STRING_VALUE",
55
+ * // Name: "STRING_VALUE",
56
+ * // Description: "STRING_VALUE",
57
+ * // State: "READY_FOR_DEPLOYMENT" || "DEPLOYING" || "ROLLING_BACK" || "ROLLED_BACK",
58
+ * // Monitors: [ // MonitorList
59
+ * // { // Monitor
60
+ * // AlarmArn: "STRING_VALUE", // required
61
+ * // AlarmRoleArn: "STRING_VALUE",
62
+ * // },
63
+ * // ],
64
+ * // };
65
+ *
52
66
  * ```
53
67
  *
54
68
  * @param CreateEnvironmentCommandInput - {@link CreateEnvironmentCommandInput}
@@ -66,6 +80,8 @@ export interface CreateEnvironmentCommandOutput extends Environment, __MetadataB
66
80
  * @throws {@link ResourceNotFoundException} (client fault)
67
81
  * <p>The requested resource could not be found.</p>
68
82
  *
83
+ * @throws {@link AppConfigServiceException}
84
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
69
85
  *
70
86
  * @example To create an environment
71
87
  * ```javascript
@@ -51,6 +51,17 @@ export interface CreateExtensionAssociationCommandOutput extends ExtensionAssoci
51
51
  * };
52
52
  * const command = new CreateExtensionAssociationCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // ExtensionAssociation
55
+ * // Id: "STRING_VALUE",
56
+ * // ExtensionArn: "STRING_VALUE",
57
+ * // ResourceArn: "STRING_VALUE",
58
+ * // Arn: "STRING_VALUE",
59
+ * // Parameters: { // ParameterValueMap
60
+ * // "<keys>": "STRING_VALUE",
61
+ * // },
62
+ * // ExtensionVersionNumber: Number("int"),
63
+ * // };
64
+ *
54
65
  * ```
55
66
  *
56
67
  * @param CreateExtensionAssociationCommandInput - {@link CreateExtensionAssociationCommandInput}
@@ -71,6 +82,8 @@ export interface CreateExtensionAssociationCommandOutput extends ExtensionAssoci
71
82
  * @throws {@link ServiceQuotaExceededException} (client fault)
72
83
  * <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>
73
84
  *
85
+ * @throws {@link AppConfigServiceException}
86
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
74
87
  *
75
88
  */
76
89
  export declare class CreateExtensionAssociationCommand extends $Command<CreateExtensionAssociationCommandInput, CreateExtensionAssociationCommandOutput, AppConfigClientResolvedConfig> {
@@ -60,6 +60,30 @@ export interface CreateExtensionCommandOutput extends Extension, __MetadataBeare
60
60
  * };
61
61
  * const command = new CreateExtensionCommand(input);
62
62
  * const response = await client.send(command);
63
+ * // { // Extension
64
+ * // Id: "STRING_VALUE",
65
+ * // Name: "STRING_VALUE",
66
+ * // VersionNumber: Number("int"),
67
+ * // Arn: "STRING_VALUE",
68
+ * // Description: "STRING_VALUE",
69
+ * // Actions: { // ActionsMap
70
+ * // "<keys>": [ // ActionList
71
+ * // { // Action
72
+ * // Name: "STRING_VALUE",
73
+ * // Description: "STRING_VALUE",
74
+ * // Uri: "STRING_VALUE",
75
+ * // RoleArn: "STRING_VALUE",
76
+ * // },
77
+ * // ],
78
+ * // },
79
+ * // Parameters: { // ParameterMap
80
+ * // "<keys>": { // Parameter
81
+ * // Description: "STRING_VALUE",
82
+ * // Required: true || false,
83
+ * // },
84
+ * // },
85
+ * // };
86
+ *
63
87
  * ```
64
88
  *
65
89
  * @param CreateExtensionCommandInput - {@link CreateExtensionCommandInput}
@@ -81,6 +105,8 @@ export interface CreateExtensionCommandOutput extends Extension, __MetadataBeare
81
105
  * @throws {@link ServiceQuotaExceededException} (client fault)
82
106
  * <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>
83
107
  *
108
+ * @throws {@link AppConfigServiceException}
109
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
84
110
  *
85
111
  */
86
112
  export declare class CreateExtensionCommand extends $Command<CreateExtensionCommandInput, CreateExtensionCommandOutput, AppConfigClientResolvedConfig> {
@@ -38,6 +38,16 @@ export interface CreateHostedConfigurationVersionCommandOutput extends HostedCon
38
38
  * };
39
39
  * const command = new CreateHostedConfigurationVersionCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // HostedConfigurationVersion
42
+ * // ApplicationId: "STRING_VALUE",
43
+ * // ConfigurationProfileId: "STRING_VALUE",
44
+ * // VersionNumber: Number("int"),
45
+ * // Description: "STRING_VALUE",
46
+ * // Content: "BLOB_VALUE",
47
+ * // ContentType: "STRING_VALUE",
48
+ * // VersionLabel: "STRING_VALUE",
49
+ * // };
50
+ *
41
51
  * ```
42
52
  *
43
53
  * @param CreateHostedConfigurationVersionCommandInput - {@link CreateHostedConfigurationVersionCommandInput}
@@ -65,6 +75,8 @@ export interface CreateHostedConfigurationVersionCommandOutput extends HostedCon
65
75
  * @throws {@link ServiceQuotaExceededException} (client fault)
66
76
  * <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>
67
77
  *
78
+ * @throws {@link AppConfigServiceException}
79
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
68
80
  *
69
81
  * @example To create a hosted configuration version
70
82
  * ```javascript
@@ -32,6 +32,8 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteApplicationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteApplicationCommandInput - {@link DeleteApplicationCommandInput}
@@ -49,6 +51,8 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {
49
51
  * @throws {@link ResourceNotFoundException} (client fault)
50
52
  * <p>The requested resource could not be found.</p>
51
53
  *
54
+ * @throws {@link AppConfigServiceException}
55
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
52
56
  *
53
57
  * @example To delete an application
54
58
  * ```javascript
@@ -33,6 +33,8 @@ export interface DeleteConfigurationProfileCommandOutput extends __MetadataBeare
33
33
  * };
34
34
  * const command = new DeleteConfigurationProfileCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteConfigurationProfileCommandInput - {@link DeleteConfigurationProfileCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteConfigurationProfileCommandOutput extends __MetadataBeare
54
56
  * @throws {@link ResourceNotFoundException} (client fault)
55
57
  * <p>The requested resource could not be found.</p>
56
58
  *
59
+ * @throws {@link AppConfigServiceException}
60
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
57
61
  *
58
62
  * @example To delete a configuration profile
59
63
  * ```javascript
@@ -32,6 +32,8 @@ export interface DeleteDeploymentStrategyCommandOutput extends __MetadataBearer
32
32
  * };
33
33
  * const command = new DeleteDeploymentStrategyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteDeploymentStrategyCommandInput - {@link DeleteDeploymentStrategyCommandInput}
@@ -49,6 +51,8 @@ export interface DeleteDeploymentStrategyCommandOutput extends __MetadataBearer
49
51
  * @throws {@link ResourceNotFoundException} (client fault)
50
52
  * <p>The requested resource could not be found.</p>
51
53
  *
54
+ * @throws {@link AppConfigServiceException}
55
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
52
56
  *
53
57
  * @example To delete a deployment strategy
54
58
  * ```javascript
@@ -33,6 +33,8 @@ export interface DeleteEnvironmentCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteEnvironmentCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteEnvironmentCommandInput - {@link DeleteEnvironmentCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteEnvironmentCommandOutput extends __MetadataBearer {
54
56
  * @throws {@link ResourceNotFoundException} (client fault)
55
57
  * <p>The requested resource could not be found.</p>
56
58
  *
59
+ * @throws {@link AppConfigServiceException}
60
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
57
61
  *
58
62
  * @example To delete an environment
59
63
  * ```javascript
@@ -32,6 +32,8 @@ export interface DeleteExtensionAssociationCommandOutput extends __MetadataBeare
32
32
  * };
33
33
  * const command = new DeleteExtensionAssociationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteExtensionAssociationCommandInput - {@link DeleteExtensionAssociationCommandInput}
@@ -49,6 +51,8 @@ export interface DeleteExtensionAssociationCommandOutput extends __MetadataBeare
49
51
  * @throws {@link ResourceNotFoundException} (client fault)
50
52
  * <p>The requested resource could not be found.</p>
51
53
  *
54
+ * @throws {@link AppConfigServiceException}
55
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
52
56
  *
53
57
  */
54
58
  export declare class DeleteExtensionAssociationCommand extends $Command<DeleteExtensionAssociationCommandInput, DeleteExtensionAssociationCommandOutput, AppConfigClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteExtensionCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteExtensionCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteExtensionCommandInput - {@link DeleteExtensionCommandInput}
@@ -50,6 +52,8 @@ export interface DeleteExtensionCommandOutput extends __MetadataBearer {
50
52
  * @throws {@link ResourceNotFoundException} (client fault)
51
53
  * <p>The requested resource could not be found.</p>
52
54
  *
55
+ * @throws {@link AppConfigServiceException}
56
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
53
57
  *
54
58
  */
55
59
  export declare class DeleteExtensionCommand extends $Command<DeleteExtensionCommandInput, DeleteExtensionCommandOutput, AppConfigClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteHostedConfigurationVersionCommandOutput extends __Metadat
34
34
  * };
35
35
  * const command = new DeleteHostedConfigurationVersionCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteHostedConfigurationVersionCommandInput - {@link DeleteHostedConfigurationVersionCommandInput}
@@ -51,6 +53,8 @@ export interface DeleteHostedConfigurationVersionCommandOutput extends __Metadat
51
53
  * @throws {@link ResourceNotFoundException} (client fault)
52
54
  * <p>The requested resource could not be found.</p>
53
55
  *
56
+ * @throws {@link AppConfigServiceException}
57
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
54
58
  *
55
59
  * @example To delete a hosted configuration version
56
60
  * ```javascript
@@ -31,6 +31,12 @@ export interface GetApplicationCommandOutput extends Application, __MetadataBear
31
31
  * };
32
32
  * const command = new GetApplicationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // Application
35
+ * // Id: "STRING_VALUE",
36
+ * // Name: "STRING_VALUE",
37
+ * // Description: "STRING_VALUE",
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param GetApplicationCommandInput - {@link GetApplicationCommandInput}
@@ -48,6 +54,8 @@ export interface GetApplicationCommandOutput extends Application, __MetadataBear
48
54
  * @throws {@link ResourceNotFoundException} (client fault)
49
55
  * <p>The requested resource could not be found.</p>
50
56
  *
57
+ * @throws {@link AppConfigServiceException}
58
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
51
59
  *
52
60
  * @example To list details of an application
53
61
  * ```javascript
@@ -51,6 +51,12 @@ export interface GetConfigurationCommandOutput extends Configuration, __Metadata
51
51
  * };
52
52
  * const command = new GetConfigurationCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // Configuration
55
+ * // Content: "BLOB_VALUE",
56
+ * // ConfigurationVersion: "STRING_VALUE",
57
+ * // ContentType: "STRING_VALUE",
58
+ * // };
59
+ *
54
60
  * ```
55
61
  *
56
62
  * @param GetConfigurationCommandInput - {@link GetConfigurationCommandInput}
@@ -68,6 +74,8 @@ export interface GetConfigurationCommandOutput extends Configuration, __Metadata
68
74
  * @throws {@link ResourceNotFoundException} (client fault)
69
75
  * <p>The requested resource could not be found.</p>
70
76
  *
77
+ * @throws {@link AppConfigServiceException}
78
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
71
79
  *
72
80
  * @example To retrieve configuration details
73
81
  * ```javascript
@@ -32,6 +32,22 @@ export interface GetConfigurationProfileCommandOutput extends ConfigurationProfi
32
32
  * };
33
33
  * const command = new GetConfigurationProfileCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ConfigurationProfile
36
+ * // ApplicationId: "STRING_VALUE",
37
+ * // Id: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // Description: "STRING_VALUE",
40
+ * // LocationUri: "STRING_VALUE",
41
+ * // RetrievalRoleArn: "STRING_VALUE",
42
+ * // Validators: [ // ValidatorList
43
+ * // { // Validator
44
+ * // Type: "JSON_SCHEMA" || "LAMBDA", // required
45
+ * // Content: "STRING_VALUE", // required
46
+ * // },
47
+ * // ],
48
+ * // Type: "STRING_VALUE",
49
+ * // };
50
+ *
35
51
  * ```
36
52
  *
37
53
  * @param GetConfigurationProfileCommandInput - {@link GetConfigurationProfileCommandInput}
@@ -49,6 +65,8 @@ export interface GetConfigurationProfileCommandOutput extends ConfigurationProfi
49
65
  * @throws {@link ResourceNotFoundException} (client fault)
50
66
  * <p>The requested resource could not be found.</p>
51
67
  *
68
+ * @throws {@link AppConfigServiceException}
69
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
52
70
  *
53
71
  * @example To retrieve configuration profile details
54
72
  * ```javascript
@@ -33,6 +33,57 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer
33
33
  * };
34
34
  * const command = new GetDeploymentCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // Deployment
37
+ * // ApplicationId: "STRING_VALUE",
38
+ * // EnvironmentId: "STRING_VALUE",
39
+ * // DeploymentStrategyId: "STRING_VALUE",
40
+ * // ConfigurationProfileId: "STRING_VALUE",
41
+ * // DeploymentNumber: Number("int"),
42
+ * // ConfigurationName: "STRING_VALUE",
43
+ * // ConfigurationLocationUri: "STRING_VALUE",
44
+ * // ConfigurationVersion: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // DeploymentDurationInMinutes: Number("int"),
47
+ * // GrowthType: "LINEAR" || "EXPONENTIAL",
48
+ * // GrowthFactor: Number("float"),
49
+ * // FinalBakeTimeInMinutes: Number("int"),
50
+ * // State: "BAKING" || "VALIDATING" || "DEPLOYING" || "COMPLETE" || "ROLLING_BACK" || "ROLLED_BACK",
51
+ * // EventLog: [ // DeploymentEvents
52
+ * // { // DeploymentEvent
53
+ * // EventType: "PERCENTAGE_UPDATED" || "ROLLBACK_STARTED" || "ROLLBACK_COMPLETED" || "BAKE_TIME_STARTED" || "DEPLOYMENT_STARTED" || "DEPLOYMENT_COMPLETED",
54
+ * // TriggeredBy: "USER" || "APPCONFIG" || "CLOUDWATCH_ALARM" || "INTERNAL_ERROR",
55
+ * // Description: "STRING_VALUE",
56
+ * // ActionInvocations: [ // ActionInvocations
57
+ * // { // ActionInvocation
58
+ * // ExtensionIdentifier: "STRING_VALUE",
59
+ * // ActionName: "STRING_VALUE",
60
+ * // Uri: "STRING_VALUE",
61
+ * // RoleArn: "STRING_VALUE",
62
+ * // ErrorMessage: "STRING_VALUE",
63
+ * // ErrorCode: "STRING_VALUE",
64
+ * // InvocationId: "STRING_VALUE",
65
+ * // },
66
+ * // ],
67
+ * // OccurredAt: new Date("TIMESTAMP"),
68
+ * // },
69
+ * // ],
70
+ * // PercentageComplete: Number("float"),
71
+ * // StartedAt: new Date("TIMESTAMP"),
72
+ * // CompletedAt: new Date("TIMESTAMP"),
73
+ * // AppliedExtensions: [ // AppliedExtensions
74
+ * // { // AppliedExtension
75
+ * // ExtensionId: "STRING_VALUE",
76
+ * // ExtensionAssociationId: "STRING_VALUE",
77
+ * // VersionNumber: Number("int"),
78
+ * // Parameters: { // ParameterValueMap
79
+ * // "<keys>": "STRING_VALUE",
80
+ * // },
81
+ * // },
82
+ * // ],
83
+ * // KmsKeyArn: "STRING_VALUE",
84
+ * // KmsKeyIdentifier: "STRING_VALUE",
85
+ * // };
86
+ *
36
87
  * ```
37
88
  *
38
89
  * @param GetDeploymentCommandInput - {@link GetDeploymentCommandInput}
@@ -50,6 +101,8 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer
50
101
  * @throws {@link ResourceNotFoundException} (client fault)
51
102
  * <p>The requested resource could not be found.</p>
52
103
  *
104
+ * @throws {@link AppConfigServiceException}
105
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
53
106
  *
54
107
  * @example To retrieve deployment details
55
108
  * ```javascript
@@ -35,6 +35,17 @@ export interface GetDeploymentStrategyCommandOutput extends DeploymentStrategy,
35
35
  * };
36
36
  * const command = new GetDeploymentStrategyCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DeploymentStrategy
39
+ * // Id: "STRING_VALUE",
40
+ * // Name: "STRING_VALUE",
41
+ * // Description: "STRING_VALUE",
42
+ * // DeploymentDurationInMinutes: Number("int"),
43
+ * // GrowthType: "LINEAR" || "EXPONENTIAL",
44
+ * // GrowthFactor: Number("float"),
45
+ * // FinalBakeTimeInMinutes: Number("int"),
46
+ * // ReplicateTo: "NONE" || "SSM_DOCUMENT",
47
+ * // };
48
+ *
38
49
  * ```
39
50
  *
40
51
  * @param GetDeploymentStrategyCommandInput - {@link GetDeploymentStrategyCommandInput}
@@ -52,6 +63,8 @@ export interface GetDeploymentStrategyCommandOutput extends DeploymentStrategy,
52
63
  * @throws {@link ResourceNotFoundException} (client fault)
53
64
  * <p>The requested resource could not be found.</p>
54
65
  *
66
+ * @throws {@link AppConfigServiceException}
67
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
55
68
  *
56
69
  * @example To retrieve details of a deployment strategy
57
70
  * ```javascript
@@ -37,6 +37,20 @@ export interface GetEnvironmentCommandOutput extends Environment, __MetadataBear
37
37
  * };
38
38
  * const command = new GetEnvironmentCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // Environment
41
+ * // ApplicationId: "STRING_VALUE",
42
+ * // Id: "STRING_VALUE",
43
+ * // Name: "STRING_VALUE",
44
+ * // Description: "STRING_VALUE",
45
+ * // State: "READY_FOR_DEPLOYMENT" || "DEPLOYING" || "ROLLING_BACK" || "ROLLED_BACK",
46
+ * // Monitors: [ // MonitorList
47
+ * // { // Monitor
48
+ * // AlarmArn: "STRING_VALUE", // required
49
+ * // AlarmRoleArn: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // };
53
+ *
40
54
  * ```
41
55
  *
42
56
  * @param GetEnvironmentCommandInput - {@link GetEnvironmentCommandInput}
@@ -54,6 +68,8 @@ export interface GetEnvironmentCommandOutput extends Environment, __MetadataBear
54
68
  * @throws {@link ResourceNotFoundException} (client fault)
55
69
  * <p>The requested resource could not be found.</p>
56
70
  *
71
+ * @throws {@link AppConfigServiceException}
72
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
57
73
  *
58
74
  * @example To retrieve environment details
59
75
  * ```javascript
@@ -34,6 +34,17 @@ export interface GetExtensionAssociationCommandOutput extends ExtensionAssociati
34
34
  * };
35
35
  * const command = new GetExtensionAssociationCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ExtensionAssociation
38
+ * // Id: "STRING_VALUE",
39
+ * // ExtensionArn: "STRING_VALUE",
40
+ * // ResourceArn: "STRING_VALUE",
41
+ * // Arn: "STRING_VALUE",
42
+ * // Parameters: { // ParameterValueMap
43
+ * // "<keys>": "STRING_VALUE",
44
+ * // },
45
+ * // ExtensionVersionNumber: Number("int"),
46
+ * // };
47
+ *
37
48
  * ```
38
49
  *
39
50
  * @param GetExtensionAssociationCommandInput - {@link GetExtensionAssociationCommandInput}
@@ -51,6 +62,8 @@ export interface GetExtensionAssociationCommandOutput extends ExtensionAssociati
51
62
  * @throws {@link ResourceNotFoundException} (client fault)
52
63
  * <p>The requested resource could not be found.</p>
53
64
  *
65
+ * @throws {@link AppConfigServiceException}
66
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
54
67
  *
55
68
  */
56
69
  export declare class GetExtensionAssociationCommand extends $Command<GetExtensionAssociationCommandInput, GetExtensionAssociationCommandOutput, AppConfigClientResolvedConfig> {
@@ -32,6 +32,30 @@ export interface GetExtensionCommandOutput extends Extension, __MetadataBearer {
32
32
  * };
33
33
  * const command = new GetExtensionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // Extension
36
+ * // Id: "STRING_VALUE",
37
+ * // Name: "STRING_VALUE",
38
+ * // VersionNumber: Number("int"),
39
+ * // Arn: "STRING_VALUE",
40
+ * // Description: "STRING_VALUE",
41
+ * // Actions: { // ActionsMap
42
+ * // "<keys>": [ // ActionList
43
+ * // { // Action
44
+ * // Name: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // Uri: "STRING_VALUE",
47
+ * // RoleArn: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // },
51
+ * // Parameters: { // ParameterMap
52
+ * // "<keys>": { // Parameter
53
+ * // Description: "STRING_VALUE",
54
+ * // Required: true || false,
55
+ * // },
56
+ * // },
57
+ * // };
58
+ *
35
59
  * ```
36
60
  *
37
61
  * @param GetExtensionCommandInput - {@link GetExtensionCommandInput}
@@ -49,6 +73,8 @@ export interface GetExtensionCommandOutput extends Extension, __MetadataBearer {
49
73
  * @throws {@link ResourceNotFoundException} (client fault)
50
74
  * <p>The requested resource could not be found.</p>
51
75
  *
76
+ * @throws {@link AppConfigServiceException}
77
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
52
78
  *
53
79
  */
54
80
  export declare class GetExtensionCommand extends $Command<GetExtensionCommandInput, GetExtensionCommandOutput, AppConfigClientResolvedConfig> {
@@ -33,6 +33,16 @@ export interface GetHostedConfigurationVersionCommandOutput extends HostedConfig
33
33
  * };
34
34
  * const command = new GetHostedConfigurationVersionCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // HostedConfigurationVersion
37
+ * // ApplicationId: "STRING_VALUE",
38
+ * // ConfigurationProfileId: "STRING_VALUE",
39
+ * // VersionNumber: Number("int"),
40
+ * // Description: "STRING_VALUE",
41
+ * // Content: "BLOB_VALUE",
42
+ * // ContentType: "STRING_VALUE",
43
+ * // VersionLabel: "STRING_VALUE",
44
+ * // };
45
+ *
36
46
  * ```
37
47
  *
38
48
  * @param GetHostedConfigurationVersionCommandInput - {@link GetHostedConfigurationVersionCommandInput}
@@ -50,6 +60,8 @@ export interface GetHostedConfigurationVersionCommandOutput extends HostedConfig
50
60
  * @throws {@link ResourceNotFoundException} (client fault)
51
61
  * <p>The requested resource could not be found.</p>
52
62
  *
63
+ * @throws {@link AppConfigServiceException}
64
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
53
65
  *
54
66
  * @example To retrieve hosted configuration details
55
67
  * ```javascript
@@ -32,6 +32,17 @@ export interface ListApplicationsCommandOutput extends Applications, __MetadataB
32
32
  * };
33
33
  * const command = new ListApplicationsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // Applications
36
+ * // Items: [ // ApplicationList
37
+ * // { // Application
38
+ * // Id: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // Description: "STRING_VALUE",
41
+ * // },
42
+ * // ],
43
+ * // NextToken: "STRING_VALUE",
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param ListApplicationsCommandInput - {@link ListApplicationsCommandInput}
@@ -46,6 +57,8 @@ export interface ListApplicationsCommandOutput extends Applications, __MetadataB
46
57
  * @throws {@link InternalServerException} (server fault)
47
58
  * <p>There was an internal failure in the AppConfig service.</p>
48
59
  *
60
+ * @throws {@link AppConfigServiceException}
61
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
49
62
  *
50
63
  * @example To list the available applications
51
64
  * ```javascript