@aws-sdk/client-elastic-beanstalk 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 (48) hide show
  1. package/dist-types/commands/AbortEnvironmentUpdateCommand.d.ts +16 -0
  2. package/dist-types/commands/ApplyEnvironmentManagedActionCommand.d.ts +7 -0
  3. package/dist-types/commands/AssociateEnvironmentOperationsRoleCommand.d.ts +5 -0
  4. package/dist-types/commands/CheckDNSAvailabilityCommand.d.ts +18 -0
  5. package/dist-types/commands/ComposeEnvironmentsCommand.d.ts +8 -0
  6. package/dist-types/commands/CreateApplicationCommand.d.ts +27 -0
  7. package/dist-types/commands/CreateApplicationVersionCommand.d.ts +63 -0
  8. package/dist-types/commands/CreateConfigurationTemplateCommand.d.ts +33 -0
  9. package/dist-types/commands/CreateEnvironmentCommand.d.ts +42 -0
  10. package/dist-types/commands/CreatePlatformVersionCommand.d.ts +11 -0
  11. package/dist-types/commands/CreateStorageLocationCommand.d.ts +25 -0
  12. package/dist-types/commands/DeleteApplicationCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteApplicationVersionCommand.d.ts +41 -0
  14. package/dist-types/commands/DeleteConfigurationTemplateCommand.d.ts +17 -0
  15. package/dist-types/commands/DeleteEnvironmentConfigurationCommand.d.ts +13 -0
  16. package/dist-types/commands/DeletePlatformVersionCommand.d.ts +15 -0
  17. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +5 -0
  18. package/dist-types/commands/DescribeApplicationVersionsCommand.d.ts +43 -0
  19. package/dist-types/commands/DescribeApplicationsCommand.d.ts +45 -0
  20. package/dist-types/commands/DescribeConfigurationOptionsCommand.d.ts +41 -0
  21. package/dist-types/commands/DescribeConfigurationSettingsCommand.d.ts +57 -0
  22. package/dist-types/commands/DescribeEnvironmentHealthCommand.d.ts +61 -0
  23. package/dist-types/commands/DescribeEnvironmentManagedActionHistoryCommand.d.ts +4 -0
  24. package/dist-types/commands/DescribeEnvironmentManagedActionsCommand.d.ts +4 -0
  25. package/dist-types/commands/DescribeEnvironmentResourcesCommand.d.ts +45 -0
  26. package/dist-types/commands/DescribeEnvironmentsCommand.d.ts +39 -0
  27. package/dist-types/commands/DescribeEventsCommand.d.ts +49 -0
  28. package/dist-types/commands/DescribeInstancesHealthCommand.d.ts +72 -0
  29. package/dist-types/commands/DescribePlatformVersionCommand.d.ts +8 -0
  30. package/dist-types/commands/DisassociateEnvironmentOperationsRoleCommand.d.ts +5 -0
  31. package/dist-types/commands/ListAvailableSolutionStacksCommand.d.ts +52 -0
  32. package/dist-types/commands/ListPlatformBranchesCommand.d.ts +1 -0
  33. package/dist-types/commands/ListPlatformVersionsCommand.d.ts +8 -0
  34. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  35. package/dist-types/commands/RebuildEnvironmentCommand.d.ts +16 -0
  36. package/dist-types/commands/RequestEnvironmentInfoCommand.d.ts +13 -0
  37. package/dist-types/commands/RestartAppServerCommand.d.ts +12 -0
  38. package/dist-types/commands/RetrieveEnvironmentInfoCommand.d.ts +25 -0
  39. package/dist-types/commands/SwapEnvironmentCNAMEsCommand.d.ts +13 -0
  40. package/dist-types/commands/TerminateEnvironmentCommand.d.ts +36 -0
  41. package/dist-types/commands/UpdateApplicationCommand.d.ts +31 -0
  42. package/dist-types/commands/UpdateApplicationResourceLifecycleCommand.d.ts +5 -0
  43. package/dist-types/commands/UpdateApplicationVersionCommand.d.ts +29 -0
  44. package/dist-types/commands/UpdateConfigurationTemplateCommand.d.ts +35 -0
  45. package/dist-types/commands/UpdateEnvironmentCommand.d.ts +94 -0
  46. package/dist-types/commands/UpdateTagsForResourceCommand.d.ts +21 -0
  47. package/dist-types/commands/ValidateConfigurationSettingsCommand.d.ts +32 -0
  48. package/package.json +30 -30
@@ -30,6 +30,22 @@ export interface AbortEnvironmentUpdateCommandOutput extends __MetadataBearer {
30
30
  * @see {@link AbortEnvironmentUpdateCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
32
32
  *
33
+ * @throws {@link InsufficientPrivilegesException} (client fault)
34
+ * <p>The specified account does not have sufficient privileges for one or more AWS
35
+ * services.</p>
36
+ *
37
+ *
38
+ * @example To abort a deployment
39
+ * ```javascript
40
+ * // The following code aborts a running application version deployment for an environment named my-env:
41
+ * const input = {
42
+ * "EnvironmentName": "my-env"
43
+ * };
44
+ * const command = new AbortEnvironmentUpdateCommand(input);
45
+ * await client.send(command);
46
+ * // example id: to-abort-a-deployment-1456267848227
47
+ * ```
48
+ *
33
49
  */
34
50
  export declare class AbortEnvironmentUpdateCommand extends $Command<AbortEnvironmentUpdateCommandInput, AbortEnvironmentUpdateCommandOutput, ElasticBeanstalkClientResolvedConfig> {
35
51
  readonly input: AbortEnvironmentUpdateCommandInput;
@@ -31,6 +31,13 @@ export interface ApplyEnvironmentManagedActionCommandOutput extends ApplyEnviron
31
31
  * @see {@link ApplyEnvironmentManagedActionCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
33
33
  *
34
+ * @throws {@link ElasticBeanstalkServiceException} (client fault)
35
+ * <p>A generic service exception has occurred.</p>
36
+ *
37
+ * @throws {@link ManagedActionInvalidStateException} (client fault)
38
+ * <p>Cannot modify the managed action in its current state.</p>
39
+ *
40
+ *
34
41
  */
35
42
  export declare class ApplyEnvironmentManagedActionCommand extends $Command<ApplyEnvironmentManagedActionCommandInput, ApplyEnvironmentManagedActionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
36
43
  readonly input: ApplyEnvironmentManagedActionCommandInput;
@@ -32,6 +32,11 @@ export interface AssociateEnvironmentOperationsRoleCommandOutput extends __Metad
32
32
  * @see {@link AssociateEnvironmentOperationsRoleCommandOutput} for command's `response` shape.
33
33
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
34
34
  *
35
+ * @throws {@link InsufficientPrivilegesException} (client fault)
36
+ * <p>The specified account does not have sufficient privileges for one or more AWS
37
+ * services.</p>
38
+ *
39
+ *
35
40
  */
36
41
  export declare class AssociateEnvironmentOperationsRoleCommand extends $Command<AssociateEnvironmentOperationsRoleCommandInput, AssociateEnvironmentOperationsRoleCommandOutput, ElasticBeanstalkClientResolvedConfig> {
37
42
  readonly input: AssociateEnvironmentOperationsRoleCommandInput;
@@ -29,6 +29,24 @@ export interface CheckDNSAvailabilityCommandOutput extends CheckDNSAvailabilityR
29
29
  * @see {@link CheckDNSAvailabilityCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
31
31
  *
32
+ *
33
+ * @example To check the availability of a CNAME
34
+ * ```javascript
35
+ * // The following operation checks the availability of the subdomain my-cname:
36
+ * const input = {
37
+ * "CNAMEPrefix": "my-cname"
38
+ * };
39
+ * const command = new CheckDNSAvailabilityCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Available": true,
44
+ * "FullyQualifiedCNAME": "my-cname.us-west-2.elasticbeanstalk.com"
45
+ * }
46
+ * *\/
47
+ * // example id: to-check-the-availability-of-a-cname-1456268589537
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class CheckDNSAvailabilityCommand extends $Command<CheckDNSAvailabilityCommandInput, CheckDNSAvailabilityCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
52
  readonly input: CheckDNSAvailabilityCommandInput;
@@ -34,6 +34,14 @@ export interface ComposeEnvironmentsCommandOutput extends EnvironmentDescription
34
34
  * @see {@link ComposeEnvironmentsCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
36
36
  *
37
+ * @throws {@link InsufficientPrivilegesException} (client fault)
38
+ * <p>The specified account does not have sufficient privileges for one or more AWS
39
+ * services.</p>
40
+ *
41
+ * @throws {@link TooManyEnvironmentsException} (client fault)
42
+ * <p>The specified account has reached its limit of environments.</p>
43
+ *
44
+ *
37
45
  */
38
46
  export declare class ComposeEnvironmentsCommand extends $Command<ComposeEnvironmentsCommandInput, ComposeEnvironmentsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
39
47
  readonly input: ComposeEnvironmentsCommandInput;
@@ -30,6 +30,33 @@ export interface CreateApplicationCommandOutput extends ApplicationDescriptionMe
30
30
  * @see {@link CreateApplicationCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
32
32
  *
33
+ * @throws {@link TooManyApplicationsException} (client fault)
34
+ * <p>The specified account has reached its limit of applications.</p>
35
+ *
36
+ *
37
+ * @example To create a new application
38
+ * ```javascript
39
+ * // The following operation creates a new application named my-app:
40
+ * const input = {
41
+ * "ApplicationName": "my-app",
42
+ * "Description": "my application"
43
+ * };
44
+ * const command = new CreateApplicationCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "Application": {
49
+ * "ApplicationName": "my-app",
50
+ * "ConfigurationTemplates": [],
51
+ * "DateCreated": "2015-02-12T18:32:21.181Z",
52
+ * "DateUpdated": "2015-02-12T18:32:21.181Z",
53
+ * "Description": "my application"
54
+ * }
55
+ * }
56
+ * *\/
57
+ * // example id: to-create-a-new-application-1456268895683
58
+ * ```
59
+ *
33
60
  */
34
61
  export declare class CreateApplicationCommand extends $Command<CreateApplicationCommandInput, CreateApplicationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
35
62
  readonly input: CreateApplicationCommandInput;
@@ -45,6 +45,69 @@ export interface CreateApplicationVersionCommandOutput extends ApplicationVersio
45
45
  * @see {@link CreateApplicationVersionCommandOutput} for command's `response` shape.
46
46
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
47
47
  *
48
+ * @throws {@link CodeBuildNotInServiceRegionException} (client fault)
49
+ * <p>AWS CodeBuild is not available in the specified region.</p>
50
+ *
51
+ * @throws {@link InsufficientPrivilegesException} (client fault)
52
+ * <p>The specified account does not have sufficient privileges for one or more AWS
53
+ * services.</p>
54
+ *
55
+ * @throws {@link S3LocationNotInServiceRegionException} (client fault)
56
+ * <p>The specified S3 bucket does not belong to the S3 region in which the service is
57
+ * running. The following regions are supported:</p>
58
+ * <ul>
59
+ * <li>
60
+ * <p>IAD/us-east-1</p>
61
+ * </li>
62
+ * <li>
63
+ * <p>PDX/us-west-2</p>
64
+ * </li>
65
+ * <li>
66
+ * <p>DUB/eu-west-1</p>
67
+ * </li>
68
+ * </ul>
69
+ *
70
+ * @throws {@link TooManyApplicationsException} (client fault)
71
+ * <p>The specified account has reached its limit of applications.</p>
72
+ *
73
+ * @throws {@link TooManyApplicationVersionsException} (client fault)
74
+ * <p>The specified account has reached its limit of application versions.</p>
75
+ *
76
+ *
77
+ * @example To create a new application
78
+ * ```javascript
79
+ * // The following operation creates a new version (v1) of an application named my-app:
80
+ * const input = {
81
+ * "ApplicationName": "my-app",
82
+ * "AutoCreateApplication": true,
83
+ * "Description": "my-app-v1",
84
+ * "Process": true,
85
+ * "SourceBundle": {
86
+ * "S3Bucket": "my-bucket",
87
+ * "S3Key": "sample.war"
88
+ * },
89
+ * "VersionLabel": "v1"
90
+ * };
91
+ * const command = new CreateApplicationVersionCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "ApplicationVersion": {
96
+ * "ApplicationName": "my-app",
97
+ * "DateCreated": "2015-02-03T23:01:25.412Z",
98
+ * "DateUpdated": "2015-02-03T23:01:25.412Z",
99
+ * "Description": "my-app-v1",
100
+ * "SourceBundle": {
101
+ * "S3Bucket": "my-bucket",
102
+ * "S3Key": "sample.war"
103
+ * },
104
+ * "VersionLabel": "v1"
105
+ * }
106
+ * }
107
+ * *\/
108
+ * // example id: to-create-a-new-application-1456268895683
109
+ * ```
110
+ *
48
111
  */
49
112
  export declare class CreateApplicationVersionCommand extends $Command<CreateApplicationVersionCommandInput, CreateApplicationVersionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
50
113
  readonly input: CreateApplicationVersionCommandInput;
@@ -52,6 +52,39 @@ export interface CreateConfigurationTemplateCommandOutput extends ConfigurationS
52
52
  * @see {@link CreateConfigurationTemplateCommandOutput} for command's `response` shape.
53
53
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
54
54
  *
55
+ * @throws {@link InsufficientPrivilegesException} (client fault)
56
+ * <p>The specified account does not have sufficient privileges for one or more AWS
57
+ * services.</p>
58
+ *
59
+ * @throws {@link TooManyBucketsException} (client fault)
60
+ * <p>The specified account has reached its limit of Amazon S3 buckets.</p>
61
+ *
62
+ * @throws {@link TooManyConfigurationTemplatesException} (client fault)
63
+ * <p>The specified account has reached its limit of configuration templates.</p>
64
+ *
65
+ *
66
+ * @example To create a configuration template
67
+ * ```javascript
68
+ * // The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j:
69
+ * const input = {
70
+ * "ApplicationName": "my-app",
71
+ * "EnvironmentId": "e-rpqsewtp2j",
72
+ * "TemplateName": "my-app-v1"
73
+ * };
74
+ * const command = new CreateConfigurationTemplateCommand(input);
75
+ * const response = await client.send(command);
76
+ * /* response ==
77
+ * {
78
+ * "ApplicationName": "my-app",
79
+ * "DateCreated": "2015-08-12T18:40:39Z",
80
+ * "DateUpdated": "2015-08-12T18:40:39Z",
81
+ * "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
82
+ * "TemplateName": "my-app-v1"
83
+ * }
84
+ * *\/
85
+ * // example id: to-create-a-configuration-template-1456269283586
86
+ * ```
87
+ *
55
88
  */
56
89
  export declare class CreateConfigurationTemplateCommand extends $Command<CreateConfigurationTemplateCommandInput, CreateConfigurationTemplateCommandOutput, ElasticBeanstalkClientResolvedConfig> {
57
90
  readonly input: CreateConfigurationTemplateCommandInput;
@@ -30,6 +30,48 @@ export interface CreateEnvironmentCommandOutput extends EnvironmentDescription,
30
30
  * @see {@link CreateEnvironmentCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
32
32
  *
33
+ * @throws {@link InsufficientPrivilegesException} (client fault)
34
+ * <p>The specified account does not have sufficient privileges for one or more AWS
35
+ * services.</p>
36
+ *
37
+ * @throws {@link TooManyEnvironmentsException} (client fault)
38
+ * <p>The specified account has reached its limit of environments.</p>
39
+ *
40
+ *
41
+ * @example To create a new environment for an application
42
+ * ```javascript
43
+ * // The following operation creates a new environment for version v1 of a java application named my-app:
44
+ * const input = {
45
+ * "ApplicationName": "my-app",
46
+ * "CNAMEPrefix": "my-app",
47
+ * "EnvironmentName": "my-env",
48
+ * "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
49
+ * "VersionLabel": "v1"
50
+ * };
51
+ * const command = new CreateEnvironmentCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "ApplicationName": "my-app",
56
+ * "CNAME": "my-app.elasticbeanstalk.com",
57
+ * "DateCreated": "2015-02-03T23:04:54.479Z",
58
+ * "DateUpdated": "2015-02-03T23:04:54.479Z",
59
+ * "EnvironmentId": "e-izqpassy4h",
60
+ * "EnvironmentName": "my-env",
61
+ * "Health": "Grey",
62
+ * "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
63
+ * "Status": "Launching",
64
+ * "Tier": {
65
+ * "Name": "WebServer",
66
+ * "Type": "Standard",
67
+ * "Version": " "
68
+ * },
69
+ * "VersionLabel": "v1"
70
+ * }
71
+ * *\/
72
+ * // example id: to-create-a-new-environment-for-an-application-1456269380396
73
+ * ```
74
+ *
33
75
  */
34
76
  export declare class CreateEnvironmentCommand extends $Command<CreateEnvironmentCommandInput, CreateEnvironmentCommandOutput, ElasticBeanstalkClientResolvedConfig> {
35
77
  readonly input: CreateEnvironmentCommandInput;
@@ -29,6 +29,17 @@ export interface CreatePlatformVersionCommandOutput extends CreatePlatformVersio
29
29
  * @see {@link CreatePlatformVersionCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
31
31
  *
32
+ * @throws {@link ElasticBeanstalkServiceException} (client fault)
33
+ * <p>A generic service exception has occurred.</p>
34
+ *
35
+ * @throws {@link InsufficientPrivilegesException} (client fault)
36
+ * <p>The specified account does not have sufficient privileges for one or more AWS
37
+ * services.</p>
38
+ *
39
+ * @throws {@link TooManyPlatformsException} (client fault)
40
+ * <p>You have exceeded the maximum number of allowed platforms associated with the account.</p>
41
+ *
42
+ *
32
43
  */
33
44
  export declare class CreatePlatformVersionCommand extends $Command<CreatePlatformVersionCommandInput, CreatePlatformVersionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
45
  readonly input: CreatePlatformVersionCommandInput;
@@ -33,6 +33,31 @@ export interface CreateStorageLocationCommandOutput extends CreateStorageLocatio
33
33
  * @see {@link CreateStorageLocationCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
35
35
  *
36
+ * @throws {@link InsufficientPrivilegesException} (client fault)
37
+ * <p>The specified account does not have sufficient privileges for one or more AWS
38
+ * services.</p>
39
+ *
40
+ * @throws {@link S3SubscriptionRequiredException} (client fault)
41
+ * <p>The specified account does not have a subscription to Amazon S3.</p>
42
+ *
43
+ * @throws {@link TooManyBucketsException} (client fault)
44
+ * <p>The specified account has reached its limit of Amazon S3 buckets.</p>
45
+ *
46
+ *
47
+ * @example To create a new environment for an application
48
+ * ```javascript
49
+ * // The following operation creates a new environment for version v1 of a java application named my-app:
50
+ * const input = undefined;
51
+ * const command = new CreateStorageLocationCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012"
56
+ * }
57
+ * *\/
58
+ * // example id: to-create-a-new-environment-for-an-application-1456269380396
59
+ * ```
60
+ *
36
61
  */
37
62
  export declare class CreateStorageLocationCommand extends $Command<CreateStorageLocationCommandInput, CreateStorageLocationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
38
63
  readonly input: CreateStorageLocationCommandInput;
@@ -34,6 +34,22 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {
34
34
  * @see {@link DeleteApplicationCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
36
36
  *
37
+ * @throws {@link OperationInProgressException} (client fault)
38
+ * <p>Unable to perform the specified operation because another operation that effects an
39
+ * element in this activity is already in progress.</p>
40
+ *
41
+ *
42
+ * @example To delete an application
43
+ * ```javascript
44
+ * // The following operation deletes an application named my-app:
45
+ * const input = {
46
+ * "ApplicationName": "my-app"
47
+ * };
48
+ * const command = new DeleteApplicationCommand(input);
49
+ * await client.send(command);
50
+ * // example id: to-delete-an-application-1456269699366
51
+ * ```
52
+ *
37
53
  */
38
54
  export declare class DeleteApplicationCommand extends $Command<DeleteApplicationCommandInput, DeleteApplicationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
39
55
  readonly input: DeleteApplicationCommandInput;
@@ -33,6 +33,47 @@ export interface DeleteApplicationVersionCommandOutput extends __MetadataBearer
33
33
  * @see {@link DeleteApplicationVersionCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
35
35
  *
36
+ * @throws {@link InsufficientPrivilegesException} (client fault)
37
+ * <p>The specified account does not have sufficient privileges for one or more AWS
38
+ * services.</p>
39
+ *
40
+ * @throws {@link OperationInProgressException} (client fault)
41
+ * <p>Unable to perform the specified operation because another operation that effects an
42
+ * element in this activity is already in progress.</p>
43
+ *
44
+ * @throws {@link S3LocationNotInServiceRegionException} (client fault)
45
+ * <p>The specified S3 bucket does not belong to the S3 region in which the service is
46
+ * running. The following regions are supported:</p>
47
+ * <ul>
48
+ * <li>
49
+ * <p>IAD/us-east-1</p>
50
+ * </li>
51
+ * <li>
52
+ * <p>PDX/us-west-2</p>
53
+ * </li>
54
+ * <li>
55
+ * <p>DUB/eu-west-1</p>
56
+ * </li>
57
+ * </ul>
58
+ *
59
+ * @throws {@link SourceBundleDeletionException} (client fault)
60
+ * <p>Unable to delete the Amazon S3 source bundle associated with the application version.
61
+ * The application version was deleted successfully.</p>
62
+ *
63
+ *
64
+ * @example To delete an application version
65
+ * ```javascript
66
+ * // The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app:
67
+ * const input = {
68
+ * "ApplicationName": "my-app",
69
+ * "DeleteSourceBundle": true,
70
+ * "VersionLabel": "22a0-stage-150819_182129"
71
+ * };
72
+ * const command = new DeleteApplicationVersionCommand(input);
73
+ * await client.send(command);
74
+ * // example id: to-delete-an-application-version-1456269792956
75
+ * ```
76
+ *
36
77
  */
37
78
  export declare class DeleteApplicationVersionCommand extends $Command<DeleteApplicationVersionCommandInput, DeleteApplicationVersionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
38
79
  readonly input: DeleteApplicationVersionCommandInput;
@@ -34,6 +34,23 @@ export interface DeleteConfigurationTemplateCommandOutput extends __MetadataBear
34
34
  * @see {@link DeleteConfigurationTemplateCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
36
36
  *
37
+ * @throws {@link OperationInProgressException} (client fault)
38
+ * <p>Unable to perform the specified operation because another operation that effects an
39
+ * element in this activity is already in progress.</p>
40
+ *
41
+ *
42
+ * @example To delete a configuration template
43
+ * ```javascript
44
+ * // The following operation deletes a configuration template named my-template for an application named my-app:
45
+ * const input = {
46
+ * "ApplicationName": "my-app",
47
+ * "TemplateName": "my-template"
48
+ * };
49
+ * const command = new DeleteConfigurationTemplateCommand(input);
50
+ * await client.send(command);
51
+ * // example id: to-delete-a-configuration-template-1456269836701
52
+ * ```
53
+ *
37
54
  */
38
55
  export declare class DeleteConfigurationTemplateCommand extends $Command<DeleteConfigurationTemplateCommandInput, DeleteConfigurationTemplateCommandOutput, ElasticBeanstalkClientResolvedConfig> {
39
56
  readonly input: DeleteConfigurationTemplateCommandInput;
@@ -34,6 +34,19 @@ export interface DeleteEnvironmentConfigurationCommandOutput extends __MetadataB
34
34
  * @see {@link DeleteEnvironmentConfigurationCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
36
36
  *
37
+ *
38
+ * @example To delete a draft configuration
39
+ * ```javascript
40
+ * // The following operation deletes a draft configuration for an environment named my-env:
41
+ * const input = {
42
+ * "ApplicationName": "my-app",
43
+ * "EnvironmentName": "my-env"
44
+ * };
45
+ * const command = new DeleteEnvironmentConfigurationCommand(input);
46
+ * await client.send(command);
47
+ * // example id: to-delete-a-draft-configuration-1456269886654
48
+ * ```
49
+ *
37
50
  */
38
51
  export declare class DeleteEnvironmentConfigurationCommand extends $Command<DeleteEnvironmentConfigurationCommandInput, DeleteEnvironmentConfigurationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
39
52
  readonly input: DeleteEnvironmentConfigurationCommandInput;
@@ -29,6 +29,21 @@ export interface DeletePlatformVersionCommandOutput extends DeletePlatformVersio
29
29
  * @see {@link DeletePlatformVersionCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
31
31
  *
32
+ * @throws {@link ElasticBeanstalkServiceException} (client fault)
33
+ * <p>A generic service exception has occurred.</p>
34
+ *
35
+ * @throws {@link InsufficientPrivilegesException} (client fault)
36
+ * <p>The specified account does not have sufficient privileges for one or more AWS
37
+ * services.</p>
38
+ *
39
+ * @throws {@link OperationInProgressException} (client fault)
40
+ * <p>Unable to perform the specified operation because another operation that effects an
41
+ * element in this activity is already in progress.</p>
42
+ *
43
+ * @throws {@link PlatformVersionStillReferencedException} (client fault)
44
+ * <p>You cannot delete the platform version because there are still environments running on it.</p>
45
+ *
46
+ *
32
47
  */
33
48
  export declare class DeletePlatformVersionCommand extends $Command<DeletePlatformVersionCommandInput, DeletePlatformVersionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
49
  readonly input: DeletePlatformVersionCommandInput;
@@ -31,6 +31,11 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA
31
31
  * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
33
33
  *
34
+ * @throws {@link InsufficientPrivilegesException} (client fault)
35
+ * <p>The specified account does not have sufficient privileges for one or more AWS
36
+ * services.</p>
37
+ *
38
+ *
34
39
  */
35
40
  export declare class DescribeAccountAttributesCommand extends $Command<DescribeAccountAttributesCommandInput, DescribeAccountAttributesCommandOutput, ElasticBeanstalkClientResolvedConfig> {
36
41
  readonly input: DescribeAccountAttributesCommandInput;
@@ -29,6 +29,49 @@ export interface DescribeApplicationVersionsCommandOutput extends ApplicationVer
29
29
  * @see {@link DescribeApplicationVersionsCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
31
31
  *
32
+ *
33
+ * @example To view information about an application version
34
+ * ```javascript
35
+ * // The following operation retrieves information about an application version labeled v2:
36
+ * const input = {
37
+ * "ApplicationName": "my-app",
38
+ * "VersionLabels": [
39
+ * "v2"
40
+ * ]
41
+ * };
42
+ * const command = new DescribeApplicationVersionsCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "ApplicationVersions": [
47
+ * {
48
+ * "ApplicationName": "my-app",
49
+ * "DateCreated": "2015-07-23T01:32:26.079Z",
50
+ * "DateUpdated": "2015-07-23T01:32:26.079Z",
51
+ * "Description": "update cover page",
52
+ * "SourceBundle": {
53
+ * "S3Bucket": "elasticbeanstalk-us-west-2-015321684451",
54
+ * "S3Key": "my-app/5026-stage-150723_224258.war"
55
+ * },
56
+ * "VersionLabel": "v2"
57
+ * },
58
+ * {
59
+ * "ApplicationName": "my-app",
60
+ * "DateCreated": "2015-07-23T22:26:10.816Z",
61
+ * "DateUpdated": "2015-07-23T22:26:10.816Z",
62
+ * "Description": "initial version",
63
+ * "SourceBundle": {
64
+ * "S3Bucket": "elasticbeanstalk-us-west-2-015321684451",
65
+ * "S3Key": "my-app/5026-stage-150723_222618.war"
66
+ * },
67
+ * "VersionLabel": "v1"
68
+ * }
69
+ * ]
70
+ * }
71
+ * *\/
72
+ * // example id: to-view-information-about-an-application-version-1456269947428
73
+ * ```
74
+ *
32
75
  */
33
76
  export declare class DescribeApplicationVersionsCommand extends $Command<DescribeApplicationVersionsCommandInput, DescribeApplicationVersionsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
77
  readonly input: DescribeApplicationVersionsCommandInput;
@@ -29,6 +29,51 @@ export interface DescribeApplicationsCommandOutput extends ApplicationDescriptio
29
29
  * @see {@link DescribeApplicationsCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
31
31
  *
32
+ *
33
+ * @example To view a list of applications
34
+ * ```javascript
35
+ * // The following operation retrieves information about applications in the current region:
36
+ * const input = {};
37
+ * const command = new DescribeApplicationsCommand(input);
38
+ * const response = await client.send(command);
39
+ * /* response ==
40
+ * {
41
+ * "Applications": [
42
+ * {
43
+ * "ApplicationName": "ruby",
44
+ * "ConfigurationTemplates": [],
45
+ * "DateCreated": "2015-08-13T21:05:44.376Z",
46
+ * "DateUpdated": "2015-08-13T21:05:44.376Z",
47
+ * "Versions": [
48
+ * "Sample Application"
49
+ * ]
50
+ * },
51
+ * {
52
+ * "ApplicationName": "pythonsample",
53
+ * "ConfigurationTemplates": [],
54
+ * "DateCreated": "2015-08-13T19:05:43.637Z",
55
+ * "DateUpdated": "2015-08-13T19:05:43.637Z",
56
+ * "Description": "Application created from the EB CLI using \"eb init\"",
57
+ * "Versions": [
58
+ * "Sample Application"
59
+ * ]
60
+ * },
61
+ * {
62
+ * "ApplicationName": "nodejs-example",
63
+ * "ConfigurationTemplates": [],
64
+ * "DateCreated": "2015-08-06T17:50:02.486Z",
65
+ * "DateUpdated": "2015-08-06T17:50:02.486Z",
66
+ * "Versions": [
67
+ * "add elasticache",
68
+ * "First Release"
69
+ * ]
70
+ * }
71
+ * ]
72
+ * }
73
+ * *\/
74
+ * // example id: to-view-a-list-of-applications-1456270027373
75
+ * ```
76
+ *
32
77
  */
33
78
  export declare class DescribeApplicationsCommand extends $Command<DescribeApplicationsCommandInput, DescribeApplicationsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
79
  readonly input: DescribeApplicationsCommandInput;
@@ -32,6 +32,47 @@ export interface DescribeConfigurationOptionsCommandOutput extends Configuration
32
32
  * @see {@link DescribeConfigurationOptionsCommandOutput} for command's `response` shape.
33
33
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
34
34
  *
35
+ * @throws {@link TooManyBucketsException} (client fault)
36
+ * <p>The specified account has reached its limit of Amazon S3 buckets.</p>
37
+ *
38
+ *
39
+ * @example To view configuration options for an environment
40
+ * ```javascript
41
+ * // The following operation retrieves descriptions of all available configuration options for an environment named my-env:
42
+ * const input = {
43
+ * "ApplicationName": "my-app",
44
+ * "EnvironmentName": "my-env"
45
+ * };
46
+ * const command = new DescribeConfigurationOptionsCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "Options": [
51
+ * {
52
+ * "ChangeSeverity": "NoInterruption",
53
+ * "DefaultValue": "30",
54
+ * "MaxValue": 300,
55
+ * "MinValue": 5,
56
+ * "Name": "Interval",
57
+ * "Namespace": "aws:elb:healthcheck",
58
+ * "UserDefined": false,
59
+ * "ValueType": "Scalar"
60
+ * },
61
+ * {
62
+ * "ChangeSeverity": "NoInterruption",
63
+ * "DefaultValue": "2000000",
64
+ * "MinValue": 0,
65
+ * "Name": "LowerThreshold",
66
+ * "Namespace": "aws:autoscaling:trigger",
67
+ * "UserDefined": false,
68
+ * "ValueType": "Scalar"
69
+ * }
70
+ * ]
71
+ * }
72
+ * *\/
73
+ * // example id: to-view-configuration-options-for-an-environment-1456276763917
74
+ * ```
75
+ *
35
76
  */
36
77
  export declare class DescribeConfigurationOptionsCommand extends $Command<DescribeConfigurationOptionsCommandInput, DescribeConfigurationOptionsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
37
78
  readonly input: DescribeConfigurationOptionsCommandInput;