@aws-sdk/client-elastic-beanstalk 3.288.0 → 3.289.0

package/dist-types/commands/DescribeEventsCommand.d.ts

@@ -33,6 +33,54 @@ export interface DescribeEventsCommandOutput extends EventDescriptionsMessage, _
  * @see {@link DescribeEventsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view events for an environment
+ * ```javascript
+ * // The following operation retrieves events for an environment named my-env:
+ * const input = {
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new DescribeEventsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Events": [
+ *     {
+ *       "ApplicationName": "my-app",
+ *       "EnvironmentName": "my-env",
+ *       "EventDate": "2015-08-20T07:06:53.535Z",
+ *       "Message": "Environment health has transitioned from Info to Ok.",
+ *       "Severity": "INFO"
+ *     },
+ *     {
+ *       "ApplicationName": "my-app",
+ *       "EnvironmentName": "my-env",
+ *       "EventDate": "2015-08-20T07:06:02.049Z",
+ *       "Message": "Environment update completed successfully.",
+ *       "RequestId": "b7f3960b-4709-11e5-ba1e-07e16200da41",
+ *       "Severity": "INFO"
+ *     },
+ *     {
+ *       "ApplicationName": "my-app",
+ *       "EnvironmentName": "my-env",
+ *       "EventDate": "2015-08-13T19:16:27.561Z",
+ *       "Message": "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.",
+ *       "RequestId": "ca8dfbf6-41ef-11e5-988b-651aa638f46b",
+ *       "Severity": "INFO"
+ *     },
+ *     {
+ *       "ApplicationName": "my-app",
+ *       "EnvironmentName": "my-env",
+ *       "EventDate": "2015-08-13T19:16:26.581Z",
+ *       "Message": "createEnvironment is starting.",
+ *       "RequestId": "cdfba8f6-41ef-11e5-988b-65638f41aa6b",
+ *       "Severity": "INFO"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-view-events-for-an-environment-1456277367589
+ * ```
+ *
  */
 export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeEventsCommandInput;

package/dist-types/commands/DescribeInstancesHealthCommand.d.ts

@@ -31,6 +31,70 @@ export interface DescribeInstancesHealthCommandOutput extends DescribeInstancesH
  * @see {@link DescribeInstancesHealthCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view environment health
+ * ```javascript
+ * // The following operation retrieves health information for instances in an environment named my-env:
+ * const input = {
+ *   "AttributeNames": [
+ *     "All"
+ *   ],
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new DescribeInstancesHealthCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InstanceHealthList": [
+ *     {
+ *       "ApplicationMetrics": {
+ *         "Duration": 10,
+ *         "Latency": {
+ *           "P10": 0,
+ *           "P50": 0.001,
+ *           "P75": 0.002,
+ *           "P85": 0.003,
+ *           "P90": 0.004,
+ *           "P95": 0.005,
+ *           "P99": 0.006,
+ *           "P999": 0.006
+ *         },
+ *         "RequestCount": 48,
+ *         "StatusCodes": {
+ *           "Status2xx": 47,
+ *           "Status3xx": 0,
+ *           "Status4xx": 1,
+ *           "Status5xx": 0
+ *         }
+ *       },
+ *       "Causes": [],
+ *       "Color": "Green",
+ *       "HealthStatus": "Ok",
+ *       "InstanceId": "i-08691cc7",
+ *       "LaunchedAt": "2015-08-13T19:17:09Z",
+ *       "System": {
+ *         "CPUUtilization": {
+ *           "IOWait": 0.2,
+ *           "IRQ": 0,
+ *           "Idle": 97.8,
+ *           "Nice": 0.1,
+ *           "SoftIRQ": 0.1,
+ *           "System": 0.3,
+ *           "User": 1.5
+ *         },
+ *         "LoadAverage": [
+ *           0,
+ *           0.02,
+ *           0.05
+ *         ]
+ *       }
+ *     }
+ *   ],
+ *   "RefreshedAt": "2015-08-20T21:09:08Z"
+ * }
+ * *\/
+ * // example id: to-view-environment-health-1456277424757
+ * ```
+ *
  */
 export declare class DescribeInstancesHealthCommand extends $Command<DescribeInstancesHealthCommandInput, DescribeInstancesHealthCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeInstancesHealthCommandInput;

package/dist-types/commands/ListAvailableSolutionStacksCommand.d.ts

@@ -30,6 +30,57 @@ export interface ListAvailableSolutionStacksCommandOutput extends ListAvailableS
  * @see {@link ListAvailableSolutionStacksCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view solution stacks
+ * ```javascript
+ * // The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:
+ * const input = undefined;
+ * const command = new ListAvailableSolutionStacksCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SolutionStackDetails": [
+ *     {
+ *       "PermittedFileTypes": [
+ *         "zip"
+ *       ],
+ *       "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Node.js"
+ *     }
+ *   ],
+ *   "SolutionStacks": [
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Node.js",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Python",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6",
+ *     "64bit Windows Server Core 2012 R2 running IIS 8.5",
+ *     "64bit Windows Server 2012 R2 running IIS 8.5",
+ *     "64bit Windows Server 2012 running IIS 8",
+ *     "64bit Windows Server 2008 R2 running IIS 7.5",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2",
+ *     "64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)",
+ *     "64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)",
+ *     "64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)",
+ *     "64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)",
+ *     "64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)",
+ *     "64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-view-solution-stacks-1456277504811
+ * ```
+ *
  */
 export declare class ListAvailableSolutionStacksCommand extends $Command<ListAvailableSolutionStacksCommandInput, ListAvailableSolutionStacksCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: ListAvailableSolutionStacksCommandInput;

package/dist-types/commands/RebuildEnvironmentCommand.d.ts

@@ -30,6 +30,17 @@ export interface RebuildEnvironmentCommandOutput extends __MetadataBearer {
  * @see {@link RebuildEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To rebuild an environment
+ * ```javascript
+ * // The following operation terminates and recreates the resources in an environment named my-env:
+ * const input = {
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new RebuildEnvironmentCommand(input);
+ * await client.send(command);
+ * // example id: to-rebuild-an-environment-1456277600918
+ * ```
+ *
  */
 export declare class RebuildEnvironmentCommand extends $Command<RebuildEnvironmentCommandInput, RebuildEnvironmentCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: RebuildEnvironmentCommandInput;

package/dist-types/commands/RequestEnvironmentInfoCommand.d.ts

@@ -44,6 +44,18 @@ export interface RequestEnvironmentInfoCommandOutput extends __MetadataBearer {
  * @see {@link RequestEnvironmentInfoCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To request tailed logs
+ * ```javascript
+ * // The following operation requests logs from an environment named my-env:
+ * const input = {
+ *   "EnvironmentName": "my-env",
+ *   "InfoType": "tail"
+ * };
+ * const command = new RequestEnvironmentInfoCommand(input);
+ * await client.send(command);
+ * // example id: to-request-tailed-logs-1456277657045
+ * ```
+ *
  */
 export declare class RequestEnvironmentInfoCommand extends $Command<RequestEnvironmentInfoCommandInput, RequestEnvironmentInfoCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: RequestEnvironmentInfoCommandInput;

package/dist-types/commands/RestartAppServerCommand.d.ts

@@ -30,6 +30,17 @@ export interface RestartAppServerCommandOutput extends __MetadataBearer {
  * @see {@link RestartAppServerCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To restart application servers
+ * ```javascript
+ * // The following operation restarts application servers on all instances in an environment named my-env:
+ * const input = {
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new RestartAppServerCommand(input);
+ * await client.send(command);
+ * // example id: to-restart-application-servers-1456277739302
+ * ```
+ *
  */
 export declare class RestartAppServerCommand extends $Command<RestartAppServerCommandInput, RestartAppServerCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: RestartAppServerCommandInput;

package/dist-types/commands/RetrieveEnvironmentInfoCommand.d.ts

@@ -38,6 +38,30 @@ export interface RetrieveEnvironmentInfoCommandOutput extends RetrieveEnvironmen
  * @see {@link RetrieveEnvironmentInfoCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To retrieve tailed logs
+ * ```javascript
+ * // The following operation retrieves a link to logs from an environment named my-env:
+ * const input = {
+ *   "EnvironmentName": "my-env",
+ *   "InfoType": "tail"
+ * };
+ * const command = new RetrieveEnvironmentInfoCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "EnvironmentInfo": [
+ *     {
+ *       "Ec2InstanceId": "i-09c1c867",
+ *       "InfoType": "tail",
+ *       "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",
+ *       "SampleTimestamp": "2015-08-20T22:23:17.703Z"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-retrieve-tailed-logs-1456277792734
+ * ```
+ *
  */
 export declare class RetrieveEnvironmentInfoCommand extends $Command<RetrieveEnvironmentInfoCommandInput, RetrieveEnvironmentInfoCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: RetrieveEnvironmentInfoCommandInput;

package/dist-types/commands/SwapEnvironmentCNAMEsCommand.d.ts

@@ -29,6 +29,18 @@ export interface SwapEnvironmentCNAMEsCommandOutput extends __MetadataBearer {
  * @see {@link SwapEnvironmentCNAMEsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To swap environment CNAMES
+ * ```javascript
+ * // The following operation swaps the assigned subdomains of two environments:
+ * const input = {
+ *   "DestinationEnvironmentName": "my-env-green",
+ *   "SourceEnvironmentName": "my-env-blue"
+ * };
+ * const command = new SwapEnvironmentCNAMEsCommand(input);
+ * await client.send(command);
+ * // example id: to-swap-environment-cnames-1456277839438
+ * ```
+ *
  */
 export declare class SwapEnvironmentCNAMEsCommand extends $Command<SwapEnvironmentCNAMEsCommandInput, SwapEnvironmentCNAMEsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: SwapEnvironmentCNAMEsCommandInput;

package/dist-types/commands/TerminateEnvironmentCommand.d.ts

@@ -29,6 +29,37 @@ export interface TerminateEnvironmentCommandOutput extends EnvironmentDescriptio
  * @see {@link TerminateEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To terminate an environment
+ * ```javascript
+ * // The following operation terminates an Elastic Beanstalk environment named my-env:
+ * const input = {
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new TerminateEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AbortableOperationInProgress": false,
+ *   "ApplicationName": "my-app",
+ *   "CNAME": "my-env.elasticbeanstalk.com",
+ *   "DateCreated": "2015-08-12T18:52:53.622Z",
+ *   "DateUpdated": "2015-08-12T19:05:54.744Z",
+ *   "EndpointURL": "awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com",
+ *   "EnvironmentId": "e-fh2eravpns",
+ *   "EnvironmentName": "my-env",
+ *   "Health": "Grey",
+ *   "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
+ *   "Status": "Terminating",
+ *   "Tier": {
+ *     "Name": "WebServer",
+ *     "Type": "Standard",
+ *     "Version": " "
+ *   }
+ * }
+ * *\/
+ * // example id: to-terminate-an-environment-1456277888556
+ * ```
+ *
  */
 export declare class TerminateEnvironmentCommand extends $Command<TerminateEnvironmentCommandInput, TerminateEnvironmentCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: TerminateEnvironmentCommandInput;

package/dist-types/commands/UpdateApplicationCommand.d.ts

@@ -33,6 +33,36 @@ export interface UpdateApplicationCommandOutput extends ApplicationDescriptionMe
  * @see {@link UpdateApplicationCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To change an application's description
+ * ```javascript
+ * // The following operation updates the description of an application named my-app:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "Description": "my Elastic Beanstalk application"
+ * };
+ * const command = new UpdateApplicationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Application": {
+ *     "ApplicationName": "my-app",
+ *     "ConfigurationTemplates": [],
+ *     "DateCreated": "2015-08-13T19:15:50.449Z",
+ *     "DateUpdated": "2015-08-20T22:34:56.195Z",
+ *     "Description": "my Elastic Beanstalk application",
+ *     "Versions": [
+ *       "2fba-stage-150819_234450",
+ *       "bf07-stage-150820_214945",
+ *       "93f8",
+ *       "fd7c-stage-150820_000431",
+ *       "22a0-stage-150819_185942"
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-change-an-applications-description-1456277957075
+ * ```
+ *
  */
 export declare class UpdateApplicationCommand extends $Command<UpdateApplicationCommandInput, UpdateApplicationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: UpdateApplicationCommandInput;

package/dist-types/commands/UpdateApplicationVersionCommand.d.ts

@@ -33,6 +33,34 @@ export interface UpdateApplicationVersionCommandOutput extends ApplicationVersio
  * @see {@link UpdateApplicationVersionCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To change an application version's description
+ * ```javascript
+ * // The following operation updates the description of an application version named 22a0-stage-150819_185942:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "Description": "new description",
+ *   "VersionLabel": "22a0-stage-150819_185942"
+ * };
+ * const command = new UpdateApplicationVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationVersion": {
+ *     "ApplicationName": "my-app",
+ *     "DateCreated": "2015-08-19T18:59:17.646Z",
+ *     "DateUpdated": "2015-08-20T22:53:28.871Z",
+ *     "Description": "new description",
+ *     "SourceBundle": {
+ *       "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012",
+ *       "S3Key": "my-app/22a0-stage-150819_185942.war"
+ *     },
+ *     "VersionLabel": "22a0-stage-150819_185942"
+ *   }
+ * }
+ * *\/
+ * // example id: to-change-an-application-versions-description-1456278019237
+ * ```
+ *
  */
 export declare class UpdateApplicationVersionCommand extends $Command<UpdateApplicationVersionCommandInput, UpdateApplicationVersionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: UpdateApplicationVersionCommandInput;

package/dist-types/commands/UpdateConfigurationTemplateCommand.d.ts

@@ -42,6 +42,33 @@ export interface UpdateConfigurationTemplateCommandOutput extends ConfigurationS
  * @see {@link UpdateConfigurationTemplateCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To update a configuration template
+ * ```javascript
+ * // The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "OptionsToRemove": [
+ *     {
+ *       "Namespace": "aws:elasticbeanstalk:healthreporting:system",
+ *       "OptionName": "ConfigDocument"
+ *     }
+ *   ],
+ *   "TemplateName": "my-template"
+ * };
+ * const command = new UpdateConfigurationTemplateCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationName": "my-app",
+ *   "DateCreated": "2015-08-20T22:39:31Z",
+ *   "DateUpdated": "2015-08-20T22:43:11Z",
+ *   "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
+ *   "TemplateName": "my-template"
+ * }
+ * *\/
+ * // example id: to-update-a-configuration-template-1456278075300
+ * ```
+ *
  */
 export declare class UpdateConfigurationTemplateCommand extends $Command<UpdateConfigurationTemplateCommandInput, UpdateConfigurationTemplateCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: UpdateConfigurationTemplateCommandInput;

package/dist-types/commands/UpdateEnvironmentCommand.d.ts

@@ -37,6 +37,92 @@ export interface UpdateEnvironmentCommandOutput extends EnvironmentDescription,
  * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To update an environment to a new version
+ * ```javascript
+ * // The following operation updates an environment named "my-env" to version "v2" of the application to which it belongs:
+ * const input = {
+ *   "EnvironmentName": "my-env",
+ *   "VersionLabel": "v2"
+ * };
+ * const command = new UpdateEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationName": "my-app",
+ *   "CNAME": "my-env.elasticbeanstalk.com",
+ *   "DateCreated": "2015-02-03T23:04:54.453Z",
+ *   "DateUpdated": "2015-02-03T23:12:29.119Z",
+ *   "EndpointURL": "awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com",
+ *   "EnvironmentId": "e-szqipays4h",
+ *   "EnvironmentName": "my-env",
+ *   "Health": "Grey",
+ *   "SolutionStackName": "64bit Amazon Linux running Tomcat 7",
+ *   "Status": "Updating",
+ *   "Tier": {
+ *     "Name": "WebServer",
+ *     "Type": "Standard",
+ *     "Version": " "
+ *   },
+ *   "VersionLabel": "v2"
+ * }
+ * *\/
+ * // example id: to-update-an-environment-to-a-new-version-1456278210718
+ * ```
+ *
+ * @example To configure option settings
+ * ```javascript
+ * // The following operation configures several options in the aws:elb:loadbalancer namespace:
+ * const input = {
+ *   "EnvironmentName": "my-env",
+ *   "OptionSettings": [
+ *     {
+ *       "Namespace": "aws:elb:healthcheck",
+ *       "OptionName": "Interval",
+ *       "Value": "15"
+ *     },
+ *     {
+ *       "Namespace": "aws:elb:healthcheck",
+ *       "OptionName": "Timeout",
+ *       "Value": "8"
+ *     },
+ *     {
+ *       "Namespace": "aws:elb:healthcheck",
+ *       "OptionName": "HealthyThreshold",
+ *       "Value": "2"
+ *     },
+ *     {
+ *       "Namespace": "aws:elb:healthcheck",
+ *       "OptionName": "UnhealthyThreshold",
+ *       "Value": "3"
+ *     }
+ *   ]
+ * };
+ * const command = new UpdateEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AbortableOperationInProgress": true,
+ *   "ApplicationName": "my-app",
+ *   "CNAME": "my-env.elasticbeanstalk.com",
+ *   "DateCreated": "2015-08-07T20:48:49.599Z",
+ *   "DateUpdated": "2015-08-12T18:15:23.804Z",
+ *   "EndpointURL": "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com",
+ *   "EnvironmentId": "e-wtp2rpqsej",
+ *   "EnvironmentName": "my-env",
+ *   "Health": "Grey",
+ *   "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
+ *   "Status": "Updating",
+ *   "Tier": {
+ *     "Name": "WebServer",
+ *     "Type": "Standard",
+ *     "Version": " "
+ *   },
+ *   "VersionLabel": "7f58-stage-150812_025409"
+ * }
+ * *\/
+ * // example id: to-configure-option-settings-1456278286349
+ * ```
+ *
  */
 export declare class UpdateEnvironmentCommand extends $Command<UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: UpdateEnvironmentCommandInput;

package/dist-types/commands/ValidateConfigurationSettingsCommand.d.ts

@@ -32,6 +32,30 @@ export interface ValidateConfigurationSettingsCommandOutput extends Configuratio
  * @see {@link ValidateConfigurationSettingsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To validate configuration settings
+ * ```javascript
+ * // The following operation validates a CloudWatch custom metrics config document:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "EnvironmentName": "my-env",
+ *   "OptionSettings": [
+ *     {
+ *       "Namespace": "aws:elasticbeanstalk:healthreporting:system",
+ *       "OptionName": "ConfigDocument",
+ *       "Value": "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}"
+ *     }
+ *   ]
+ * };
+ * const command = new ValidateConfigurationSettingsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Messages": []
+ * }
+ * *\/
+ * // example id: to-validate-configuration-settings-1456278393654
+ * ```
+ *
  */
 export declare class ValidateConfigurationSettingsCommand extends $Command<ValidateConfigurationSettingsCommandInput, ValidateConfigurationSettingsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: ValidateConfigurationSettingsCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-elastic-beanstalk",
   "description": "AWS SDK for JavaScript Elastic Beanstalk Client for Node.js, Browser and React Native",
-  "version": "3.288.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.288.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.288.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.288.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
-    "@aws-sdk/util-waiter": "3.272.0",
+    "@aws-sdk/util-waiter": "3.289.0",
     "fast-xml-parser": "4.1.2",
     "tslib": "^2.3.1"
   },