@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
@@ -43,6 +43,63 @@ export interface DescribeConfigurationSettingsCommandOutput extends Configuratio
43
43
  * @see {@link DescribeConfigurationSettingsCommandOutput} for command's `response` shape.
44
44
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
45
45
  *
46
+ * @throws {@link TooManyBucketsException} (client fault)
47
+ * <p>The specified account has reached its limit of Amazon S3 buckets.</p>
48
+ *
49
+ *
50
+ * @example To view configurations settings for an environment
51
+ * ```javascript
52
+ * // The following operation retrieves configuration settings for an environment named my-env:
53
+ * const input = {
54
+ * "ApplicationName": "my-app",
55
+ * "EnvironmentName": "my-env"
56
+ * };
57
+ * const command = new DescribeConfigurationSettingsCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "ConfigurationSettings": [
62
+ * {
63
+ * "ApplicationName": "my-app",
64
+ * "DateCreated": "2015-08-13T19:16:25Z",
65
+ * "DateUpdated": "2015-08-13T23:30:07Z",
66
+ * "DeploymentStatus": "deployed",
67
+ * "Description": "Environment created from the EB CLI using \"eb create\"",
68
+ * "EnvironmentName": "my-env",
69
+ * "OptionSettings": [
70
+ * {
71
+ * "Namespace": "aws:autoscaling:asg",
72
+ * "OptionName": "Availability Zones",
73
+ * "ResourceName": "AWSEBAutoScalingGroup",
74
+ * "Value": "Any"
75
+ * },
76
+ * {
77
+ * "Namespace": "aws:autoscaling:asg",
78
+ * "OptionName": "Cooldown",
79
+ * "ResourceName": "AWSEBAutoScalingGroup",
80
+ * "Value": "360"
81
+ * },
82
+ * {
83
+ * "Namespace": "aws:elb:policies",
84
+ * "OptionName": "ConnectionDrainingTimeout",
85
+ * "ResourceName": "AWSEBLoadBalancer",
86
+ * "Value": "20"
87
+ * },
88
+ * {
89
+ * "Namespace": "aws:elb:policies",
90
+ * "OptionName": "ConnectionSettingIdleTimeout",
91
+ * "ResourceName": "AWSEBLoadBalancer",
92
+ * "Value": "60"
93
+ * }
94
+ * ],
95
+ * "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8"
96
+ * }
97
+ * ]
98
+ * }
99
+ * *\/
100
+ * // example id: to-view-configurations-settings-for-an-environment-1456276924537
101
+ * ```
102
+ *
46
103
  */
47
104
  export declare class DescribeConfigurationSettingsCommand extends $Command<DescribeConfigurationSettingsCommandInput, DescribeConfigurationSettingsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
48
105
  readonly input: DescribeConfigurationSettingsCommandInput;
@@ -31,6 +31,67 @@ export interface DescribeEnvironmentHealthCommandOutput extends DescribeEnvironm
31
31
  * @see {@link DescribeEnvironmentHealthCommandOutput} 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 InvalidRequestException} (client fault)
38
+ * <p>One or more input parameters is not valid. Please correct the input parameters and try
39
+ * the operation again.</p>
40
+ *
41
+ *
42
+ * @example To view environment health
43
+ * ```javascript
44
+ * // The following operation retrieves overall health information for an environment named my-env:
45
+ * const input = {
46
+ * "AttributeNames": [
47
+ * "All"
48
+ * ],
49
+ * "EnvironmentName": "my-env"
50
+ * };
51
+ * const command = new DescribeEnvironmentHealthCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "ApplicationMetrics": {
56
+ * "Duration": 10,
57
+ * "Latency": {
58
+ * "P10": 0.001,
59
+ * "P50": 0.001,
60
+ * "P75": 0.002,
61
+ * "P85": 0.003,
62
+ * "P90": 0.003,
63
+ * "P95": 0.004,
64
+ * "P99": 0.004,
65
+ * "P999": 0.004
66
+ * },
67
+ * "RequestCount": 45,
68
+ * "StatusCodes": {
69
+ * "Status2xx": 45,
70
+ * "Status3xx": 0,
71
+ * "Status4xx": 0,
72
+ * "Status5xx": 0
73
+ * }
74
+ * },
75
+ * "Causes": [],
76
+ * "Color": "Green",
77
+ * "EnvironmentName": "my-env",
78
+ * "HealthStatus": "Ok",
79
+ * "InstancesHealth": {
80
+ * "Degraded": 0,
81
+ * "Info": 0,
82
+ * "NoData": 0,
83
+ * "Ok": 1,
84
+ * "Pending": 0,
85
+ * "Severe": 0,
86
+ * "Unknown": 0,
87
+ * "Warning": 0
88
+ * },
89
+ * "RefreshedAt": "2015-08-20T21:09:18Z"
90
+ * }
91
+ * *\/
92
+ * // example id: to-view-environment-health-1456277109510
93
+ * ```
94
+ *
34
95
  */
35
96
  export declare class DescribeEnvironmentHealthCommand extends $Command<DescribeEnvironmentHealthCommandInput, DescribeEnvironmentHealthCommandOutput, ElasticBeanstalkClientResolvedConfig> {
36
97
  readonly input: DescribeEnvironmentHealthCommandInput;
@@ -29,6 +29,10 @@ export interface DescribeEnvironmentManagedActionHistoryCommandOutput extends De
29
29
  * @see {@link DescribeEnvironmentManagedActionHistoryCommandOutput} 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
+ *
32
36
  */
33
37
  export declare class DescribeEnvironmentManagedActionHistoryCommand extends $Command<DescribeEnvironmentManagedActionHistoryCommandInput, DescribeEnvironmentManagedActionHistoryCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
38
  readonly input: DescribeEnvironmentManagedActionHistoryCommandInput;
@@ -29,6 +29,10 @@ export interface DescribeEnvironmentManagedActionsCommandOutput extends Describe
29
29
  * @see {@link DescribeEnvironmentManagedActionsCommandOutput} 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
+ *
32
36
  */
33
37
  export declare class DescribeEnvironmentManagedActionsCommand extends $Command<DescribeEnvironmentManagedActionsCommandInput, DescribeEnvironmentManagedActionsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
38
  readonly input: DescribeEnvironmentManagedActionsCommandInput;
@@ -29,6 +29,51 @@ export interface DescribeEnvironmentResourcesCommandOutput extends EnvironmentRe
29
29
  * @see {@link DescribeEnvironmentResourcesCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
31
31
  *
32
+ * @throws {@link InsufficientPrivilegesException} (client fault)
33
+ * <p>The specified account does not have sufficient privileges for one or more AWS
34
+ * services.</p>
35
+ *
36
+ *
37
+ * @example To view information about the AWS resources in your environment
38
+ * ```javascript
39
+ * // The following operation retrieves information about resources in an environment named my-env:
40
+ * const input = {
41
+ * "EnvironmentName": "my-env"
42
+ * };
43
+ * const command = new DescribeEnvironmentResourcesCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "EnvironmentResources": {
48
+ * "AutoScalingGroups": [
49
+ * {
50
+ * "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT"
51
+ * }
52
+ * ],
53
+ * "EnvironmentName": "my-env",
54
+ * "Instances": [
55
+ * {
56
+ * "Id": "i-0c91c786"
57
+ * }
58
+ * ],
59
+ * "LaunchConfigurations": [
60
+ * {
61
+ * "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2"
62
+ * }
63
+ * ],
64
+ * "LoadBalancers": [
65
+ * {
66
+ * "Name": "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0"
67
+ * }
68
+ * ],
69
+ * "Queues": [],
70
+ * "Triggers": []
71
+ * }
72
+ * }
73
+ * *\/
74
+ * // example id: to-view-information-about-the-aws-resources-in-your-environment-1456277206232
75
+ * ```
76
+ *
32
77
  */
33
78
  export declare class DescribeEnvironmentResourcesCommand extends $Command<DescribeEnvironmentResourcesCommandInput, DescribeEnvironmentResourcesCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
79
  readonly input: DescribeEnvironmentResourcesCommandInput;
@@ -29,6 +29,45 @@ export interface DescribeEnvironmentsCommandOutput extends EnvironmentDescriptio
29
29
  * @see {@link DescribeEnvironmentsCommandOutput} 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 environment
34
+ * ```javascript
35
+ * // The following operation retrieves information about an environment named my-env:
36
+ * const input = {
37
+ * "EnvironmentNames": [
38
+ * "my-env"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeEnvironmentsCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "Environments": [
46
+ * {
47
+ * "AbortableOperationInProgress": false,
48
+ * "ApplicationName": "my-app",
49
+ * "CNAME": "my-env.elasticbeanstalk.com",
50
+ * "DateCreated": "2015-08-07T20:48:49.599Z",
51
+ * "DateUpdated": "2015-08-12T18:16:55.019Z",
52
+ * "EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com",
53
+ * "EnvironmentId": "e-rpqsewtp2j",
54
+ * "EnvironmentName": "my-env",
55
+ * "Health": "Green",
56
+ * "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
57
+ * "Status": "Ready",
58
+ * "Tier": {
59
+ * "Name": "WebServer",
60
+ * "Type": "Standard",
61
+ * "Version": " "
62
+ * },
63
+ * "VersionLabel": "7f58-stage-150812_025409"
64
+ * }
65
+ * ]
66
+ * }
67
+ * *\/
68
+ * // example id: to-view-information-about-an-environment-1456277288662
69
+ * ```
70
+ *
32
71
  */
33
72
  export declare class DescribeEnvironmentsCommand extends $Command<DescribeEnvironmentsCommandInput, DescribeEnvironmentsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
73
  readonly input: DescribeEnvironmentsCommandInput;
@@ -33,6 +33,55 @@ export interface DescribeEventsCommandOutput extends EventDescriptionsMessage, _
33
33
  * @see {@link DescribeEventsCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
35
35
  *
36
+ *
37
+ * @example To view events for an environment
38
+ * ```javascript
39
+ * // The following operation retrieves events for an environment named my-env:
40
+ * const input = {
41
+ * "EnvironmentName": "my-env"
42
+ * };
43
+ * const command = new DescribeEventsCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "Events": [
48
+ * {
49
+ * "ApplicationName": "my-app",
50
+ * "EnvironmentName": "my-env",
51
+ * "EventDate": "2015-08-20T07:06:53.535Z",
52
+ * "Message": "Environment health has transitioned from Info to Ok.",
53
+ * "Severity": "INFO"
54
+ * },
55
+ * {
56
+ * "ApplicationName": "my-app",
57
+ * "EnvironmentName": "my-env",
58
+ * "EventDate": "2015-08-20T07:06:02.049Z",
59
+ * "Message": "Environment update completed successfully.",
60
+ * "RequestId": "b7f3960b-4709-11e5-ba1e-07e16200da41",
61
+ * "Severity": "INFO"
62
+ * },
63
+ * {
64
+ * "ApplicationName": "my-app",
65
+ * "EnvironmentName": "my-env",
66
+ * "EventDate": "2015-08-13T19:16:27.561Z",
67
+ * "Message": "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.",
68
+ * "RequestId": "ca8dfbf6-41ef-11e5-988b-651aa638f46b",
69
+ * "Severity": "INFO"
70
+ * },
71
+ * {
72
+ * "ApplicationName": "my-app",
73
+ * "EnvironmentName": "my-env",
74
+ * "EventDate": "2015-08-13T19:16:26.581Z",
75
+ * "Message": "createEnvironment is starting.",
76
+ * "RequestId": "cdfba8f6-41ef-11e5-988b-65638f41aa6b",
77
+ * "Severity": "INFO"
78
+ * }
79
+ * ]
80
+ * }
81
+ * *\/
82
+ * // example id: to-view-events-for-an-environment-1456277367589
83
+ * ```
84
+ *
36
85
  */
37
86
  export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
38
87
  readonly input: DescribeEventsCommandInput;
@@ -31,6 +31,78 @@ export interface DescribeInstancesHealthCommandOutput extends DescribeInstancesH
31
31
  * @see {@link DescribeInstancesHealthCommandOutput} 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 InvalidRequestException} (client fault)
38
+ * <p>One or more input parameters is not valid. Please correct the input parameters and try
39
+ * the operation again.</p>
40
+ *
41
+ *
42
+ * @example To view environment health
43
+ * ```javascript
44
+ * // The following operation retrieves health information for instances in an environment named my-env:
45
+ * const input = {
46
+ * "AttributeNames": [
47
+ * "All"
48
+ * ],
49
+ * "EnvironmentName": "my-env"
50
+ * };
51
+ * const command = new DescribeInstancesHealthCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "InstanceHealthList": [
56
+ * {
57
+ * "ApplicationMetrics": {
58
+ * "Duration": 10,
59
+ * "Latency": {
60
+ * "P10": 0,
61
+ * "P50": 0.001,
62
+ * "P75": 0.002,
63
+ * "P85": 0.003,
64
+ * "P90": 0.004,
65
+ * "P95": 0.005,
66
+ * "P99": 0.006,
67
+ * "P999": 0.006
68
+ * },
69
+ * "RequestCount": 48,
70
+ * "StatusCodes": {
71
+ * "Status2xx": 47,
72
+ * "Status3xx": 0,
73
+ * "Status4xx": 1,
74
+ * "Status5xx": 0
75
+ * }
76
+ * },
77
+ * "Causes": [],
78
+ * "Color": "Green",
79
+ * "HealthStatus": "Ok",
80
+ * "InstanceId": "i-08691cc7",
81
+ * "LaunchedAt": "2015-08-13T19:17:09Z",
82
+ * "System": {
83
+ * "CPUUtilization": {
84
+ * "IOWait": 0.2,
85
+ * "IRQ": 0,
86
+ * "Idle": 97.8,
87
+ * "Nice": 0.1,
88
+ * "SoftIRQ": 0.1,
89
+ * "System": 0.3,
90
+ * "User": 1.5
91
+ * },
92
+ * "LoadAverage": [
93
+ * 0,
94
+ * 0.02,
95
+ * 0.05
96
+ * ]
97
+ * }
98
+ * }
99
+ * ],
100
+ * "RefreshedAt": "2015-08-20T21:09:08Z"
101
+ * }
102
+ * *\/
103
+ * // example id: to-view-environment-health-1456277424757
104
+ * ```
105
+ *
34
106
  */
35
107
  export declare class DescribeInstancesHealthCommand extends $Command<DescribeInstancesHealthCommandInput, DescribeInstancesHealthCommandOutput, ElasticBeanstalkClientResolvedConfig> {
36
108
  readonly input: DescribeInstancesHealthCommandInput;
@@ -32,6 +32,14 @@ export interface DescribePlatformVersionCommandOutput extends DescribePlatformVe
32
32
  * @see {@link DescribePlatformVersionCommandOutput} for command's `response` shape.
33
33
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
34
34
  *
35
+ * @throws {@link ElasticBeanstalkServiceException} (client fault)
36
+ * <p>A generic service exception has occurred.</p>
37
+ *
38
+ * @throws {@link InsufficientPrivilegesException} (client fault)
39
+ * <p>The specified account does not have sufficient privileges for one or more AWS
40
+ * services.</p>
41
+ *
42
+ *
35
43
  */
36
44
  export declare class DescribePlatformVersionCommand extends $Command<DescribePlatformVersionCommandInput, DescribePlatformVersionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
37
45
  readonly input: DescribePlatformVersionCommandInput;
@@ -32,6 +32,11 @@ export interface DisassociateEnvironmentOperationsRoleCommandOutput extends __Me
32
32
  * @see {@link DisassociateEnvironmentOperationsRoleCommandOutput} 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 DisassociateEnvironmentOperationsRoleCommand extends $Command<DisassociateEnvironmentOperationsRoleCommandInput, DisassociateEnvironmentOperationsRoleCommandOutput, ElasticBeanstalkClientResolvedConfig> {
37
42
  readonly input: DisassociateEnvironmentOperationsRoleCommandInput;
@@ -30,6 +30,58 @@ export interface ListAvailableSolutionStacksCommandOutput extends ListAvailableS
30
30
  * @see {@link ListAvailableSolutionStacksCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
32
32
  *
33
+ *
34
+ * @example To view solution stacks
35
+ * ```javascript
36
+ * // The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:
37
+ * const input = undefined;
38
+ * const command = new ListAvailableSolutionStacksCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "SolutionStackDetails": [
43
+ * {
44
+ * "PermittedFileTypes": [
45
+ * "zip"
46
+ * ],
47
+ * "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Node.js"
48
+ * }
49
+ * ],
50
+ * "SolutionStacks": [
51
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Node.js",
52
+ * "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6",
53
+ * "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5",
54
+ * "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4",
55
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4",
56
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7",
57
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Python",
58
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)",
59
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)",
60
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)",
61
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)",
62
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)",
63
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)",
64
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3",
65
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
66
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7",
67
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6",
68
+ * "64bit Windows Server Core 2012 R2 running IIS 8.5",
69
+ * "64bit Windows Server 2012 R2 running IIS 8.5",
70
+ * "64bit Windows Server 2012 running IIS 8",
71
+ * "64bit Windows Server 2008 R2 running IIS 7.5",
72
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2",
73
+ * "64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)",
74
+ * "64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)",
75
+ * "64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)",
76
+ * "64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)",
77
+ * "64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)",
78
+ * "64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)"
79
+ * ]
80
+ * }
81
+ * *\/
82
+ * // example id: to-view-solution-stacks-1456277504811
83
+ * ```
84
+ *
33
85
  */
34
86
  export declare class ListAvailableSolutionStacksCommand extends $Command<ListAvailableSolutionStacksCommandInput, ListAvailableSolutionStacksCommandOutput, ElasticBeanstalkClientResolvedConfig> {
35
87
  readonly input: ListAvailableSolutionStacksCommandInput;
@@ -32,6 +32,7 @@ export interface ListPlatformBranchesCommandOutput extends ListPlatformBranchesR
32
32
  * @see {@link ListPlatformBranchesCommandOutput} for command's `response` shape.
33
33
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
34
34
  *
35
+ *
35
36
  */
36
37
  export declare class ListPlatformBranchesCommand extends $Command<ListPlatformBranchesCommandInput, ListPlatformBranchesCommandOutput, ElasticBeanstalkClientResolvedConfig> {
37
38
  readonly input: ListPlatformBranchesCommandInput;
@@ -33,6 +33,14 @@ export interface ListPlatformVersionsCommandOutput extends ListPlatformVersionsR
33
33
  * @see {@link ListPlatformVersionsCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
35
35
  *
36
+ * @throws {@link ElasticBeanstalkServiceException} (client fault)
37
+ * <p>A generic service exception has occurred.</p>
38
+ *
39
+ * @throws {@link InsufficientPrivilegesException} (client fault)
40
+ * <p>The specified account does not have sufficient privileges for one or more AWS
41
+ * services.</p>
42
+ *
43
+ *
36
44
  */
37
45
  export declare class ListPlatformVersionsCommand extends $Command<ListPlatformVersionsCommandInput, ListPlatformVersionsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
38
46
  readonly input: ListPlatformVersionsCommandInput;
@@ -32,6 +32,17 @@ export interface ListTagsForResourceCommandOutput extends ResourceTagsDescriptio
32
32
  * @see {@link ListTagsForResourceCommandOutput} 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
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>A resource doesn't exist for the specified Amazon Resource Name (ARN).</p>
41
+ *
42
+ * @throws {@link ResourceTypeNotSupportedException} (client fault)
43
+ * <p>The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.</p>
44
+ *
45
+ *
35
46
  */
36
47
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ElasticBeanstalkClientResolvedConfig> {
37
48
  readonly input: ListTagsForResourceCommandInput;
@@ -30,6 +30,22 @@ export interface RebuildEnvironmentCommandOutput extends __MetadataBearer {
30
30
  * @see {@link RebuildEnvironmentCommandOutput} 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 rebuild an environment
39
+ * ```javascript
40
+ * // The following operation terminates and recreates the resources in an environment named my-env:
41
+ * const input = {
42
+ * "EnvironmentName": "my-env"
43
+ * };
44
+ * const command = new RebuildEnvironmentCommand(input);
45
+ * await client.send(command);
46
+ * // example id: to-rebuild-an-environment-1456277600918
47
+ * ```
48
+ *
33
49
  */
34
50
  export declare class RebuildEnvironmentCommand extends $Command<RebuildEnvironmentCommandInput, RebuildEnvironmentCommandOutput, ElasticBeanstalkClientResolvedConfig> {
35
51
  readonly input: RebuildEnvironmentCommandInput;
@@ -44,6 +44,19 @@ export interface RequestEnvironmentInfoCommandOutput extends __MetadataBearer {
44
44
  * @see {@link RequestEnvironmentInfoCommandOutput} for command's `response` shape.
45
45
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
46
46
  *
47
+ *
48
+ * @example To request tailed logs
49
+ * ```javascript
50
+ * // The following operation requests logs from an environment named my-env:
51
+ * const input = {
52
+ * "EnvironmentName": "my-env",
53
+ * "InfoType": "tail"
54
+ * };
55
+ * const command = new RequestEnvironmentInfoCommand(input);
56
+ * await client.send(command);
57
+ * // example id: to-request-tailed-logs-1456277657045
58
+ * ```
59
+ *
47
60
  */
48
61
  export declare class RequestEnvironmentInfoCommand extends $Command<RequestEnvironmentInfoCommandInput, RequestEnvironmentInfoCommandOutput, ElasticBeanstalkClientResolvedConfig> {
49
62
  readonly input: RequestEnvironmentInfoCommandInput;
@@ -30,6 +30,18 @@ export interface RestartAppServerCommandOutput extends __MetadataBearer {
30
30
  * @see {@link RestartAppServerCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
32
32
  *
33
+ *
34
+ * @example To restart application servers
35
+ * ```javascript
36
+ * // The following operation restarts application servers on all instances in an environment named my-env:
37
+ * const input = {
38
+ * "EnvironmentName": "my-env"
39
+ * };
40
+ * const command = new RestartAppServerCommand(input);
41
+ * await client.send(command);
42
+ * // example id: to-restart-application-servers-1456277739302
43
+ * ```
44
+ *
33
45
  */
34
46
  export declare class RestartAppServerCommand extends $Command<RestartAppServerCommandInput, RestartAppServerCommandOutput, ElasticBeanstalkClientResolvedConfig> {
35
47
  readonly input: RestartAppServerCommandInput;
@@ -38,6 +38,31 @@ export interface RetrieveEnvironmentInfoCommandOutput extends RetrieveEnvironmen
38
38
  * @see {@link RetrieveEnvironmentInfoCommandOutput} for command's `response` shape.
39
39
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
40
40
  *
41
+ *
42
+ * @example To retrieve tailed logs
43
+ * ```javascript
44
+ * // The following operation retrieves a link to logs from an environment named my-env:
45
+ * const input = {
46
+ * "EnvironmentName": "my-env",
47
+ * "InfoType": "tail"
48
+ * };
49
+ * const command = new RetrieveEnvironmentInfoCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "EnvironmentInfo": [
54
+ * {
55
+ * "Ec2InstanceId": "i-09c1c867",
56
+ * "InfoType": "tail",
57
+ * "Message": "https://elasticbeanstalk-us-west-2-0123456789012.s3.amazonaws.com/resources/environments/logs/tail/e-fyqyju3yjs/i-09c1c867/TailLogs-1440109397703.out?AWSAccessKeyId=AKGPT4J56IAJ2EUBL5CQ&Expires=1440195891&Signature=n%2BEalOV6A2HIOx4Rcfb7LT16bBM%3D",
58
+ * "SampleTimestamp": "2015-08-20T22:23:17.703Z"
59
+ * }
60
+ * ]
61
+ * }
62
+ * *\/
63
+ * // example id: to-retrieve-tailed-logs-1456277792734
64
+ * ```
65
+ *
41
66
  */
42
67
  export declare class RetrieveEnvironmentInfoCommand extends $Command<RetrieveEnvironmentInfoCommandInput, RetrieveEnvironmentInfoCommandOutput, ElasticBeanstalkClientResolvedConfig> {
43
68
  readonly input: RetrieveEnvironmentInfoCommandInput;
@@ -29,6 +29,19 @@ export interface SwapEnvironmentCNAMEsCommandOutput extends __MetadataBearer {
29
29
  * @see {@link SwapEnvironmentCNAMEsCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
31
31
  *
32
+ *
33
+ * @example To swap environment CNAMES
34
+ * ```javascript
35
+ * // The following operation swaps the assigned subdomains of two environments:
36
+ * const input = {
37
+ * "DestinationEnvironmentName": "my-env-green",
38
+ * "SourceEnvironmentName": "my-env-blue"
39
+ * };
40
+ * const command = new SwapEnvironmentCNAMEsCommand(input);
41
+ * await client.send(command);
42
+ * // example id: to-swap-environment-cnames-1456277839438
43
+ * ```
44
+ *
32
45
  */
33
46
  export declare class SwapEnvironmentCNAMEsCommand extends $Command<SwapEnvironmentCNAMEsCommandInput, SwapEnvironmentCNAMEsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
34
47
  readonly input: SwapEnvironmentCNAMEsCommandInput;