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

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

@@ -30,6 +30,17 @@ export interface AbortEnvironmentUpdateCommandOutput extends __MetadataBearer {
  * @see {@link AbortEnvironmentUpdateCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To abort a deployment
+ * ```javascript
+ * // The following code aborts a running application version deployment for an environment named my-env:
+ * const input = {
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new AbortEnvironmentUpdateCommand(input);
+ * await client.send(command);
+ * // example id: to-abort-a-deployment-1456267848227
+ * ```
+ *
  */
 export declare class AbortEnvironmentUpdateCommand extends $Command<AbortEnvironmentUpdateCommandInput, AbortEnvironmentUpdateCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: AbortEnvironmentUpdateCommandInput;

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

@@ -29,6 +29,23 @@ export interface CheckDNSAvailabilityCommandOutput extends CheckDNSAvailabilityR
  * @see {@link CheckDNSAvailabilityCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To check the availability of a CNAME
+ * ```javascript
+ * // The following operation checks the availability of the subdomain my-cname:
+ * const input = {
+ *   "CNAMEPrefix": "my-cname"
+ * };
+ * const command = new CheckDNSAvailabilityCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Available": true,
+ *   "FullyQualifiedCNAME": "my-cname.us-west-2.elasticbeanstalk.com"
+ * }
+ * *\/
+ * // example id: to-check-the-availability-of-a-cname-1456268589537
+ * ```
+ *
  */
 export declare class CheckDNSAvailabilityCommand extends $Command<CheckDNSAvailabilityCommandInput, CheckDNSAvailabilityCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: CheckDNSAvailabilityCommandInput;

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

@@ -30,6 +30,29 @@ export interface CreateApplicationCommandOutput extends ApplicationDescriptionMe
  * @see {@link CreateApplicationCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To create a new application
+ * ```javascript
+ * // The following operation creates a new application named my-app:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "Description": "my application"
+ * };
+ * const command = new CreateApplicationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Application": {
+ *     "ApplicationName": "my-app",
+ *     "ConfigurationTemplates": [],
+ *     "DateCreated": "2015-02-12T18:32:21.181Z",
+ *     "DateUpdated": "2015-02-12T18:32:21.181Z",
+ *     "Description": "my application"
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-new-application-1456268895683
+ * ```
+ *
  */
 export declare class CreateApplicationCommand extends $Command<CreateApplicationCommandInput, CreateApplicationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: CreateApplicationCommandInput;

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

@@ -45,6 +45,40 @@ export interface CreateApplicationVersionCommandOutput extends ApplicationVersio
  * @see {@link CreateApplicationVersionCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To create a new application
+ * ```javascript
+ * // The following operation creates a new version (v1) of an application named my-app:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "AutoCreateApplication": true,
+ *   "Description": "my-app-v1",
+ *   "Process": true,
+ *   "SourceBundle": {
+ *     "S3Bucket": "my-bucket",
+ *     "S3Key": "sample.war"
+ *   },
+ *   "VersionLabel": "v1"
+ * };
+ * const command = new CreateApplicationVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationVersion": {
+ *     "ApplicationName": "my-app",
+ *     "DateCreated": "2015-02-03T23:01:25.412Z",
+ *     "DateUpdated": "2015-02-03T23:01:25.412Z",
+ *     "Description": "my-app-v1",
+ *     "SourceBundle": {
+ *       "S3Bucket": "my-bucket",
+ *       "S3Key": "sample.war"
+ *     },
+ *     "VersionLabel": "v1"
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-new-application-1456268895683
+ * ```
+ *
  */
 export declare class CreateApplicationVersionCommand extends $Command<CreateApplicationVersionCommandInput, CreateApplicationVersionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: CreateApplicationVersionCommandInput;

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

@@ -52,6 +52,28 @@ export interface CreateConfigurationTemplateCommandOutput extends ConfigurationS
  * @see {@link CreateConfigurationTemplateCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To create a configuration template
+ * ```javascript
+ * // The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "EnvironmentId": "e-rpqsewtp2j",
+ *   "TemplateName": "my-app-v1"
+ * };
+ * const command = new CreateConfigurationTemplateCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationName": "my-app",
+ *   "DateCreated": "2015-08-12T18:40:39Z",
+ *   "DateUpdated": "2015-08-12T18:40:39Z",
+ *   "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
+ *   "TemplateName": "my-app-v1"
+ * }
+ * *\/
+ * // example id: to-create-a-configuration-template-1456269283586
+ * ```
+ *
  */
 export declare class CreateConfigurationTemplateCommand extends $Command<CreateConfigurationTemplateCommandInput, CreateConfigurationTemplateCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: CreateConfigurationTemplateCommandInput;

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

@@ -30,6 +30,40 @@ export interface CreateEnvironmentCommandOutput extends EnvironmentDescription,
  * @see {@link CreateEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To create a new environment for an application
+ * ```javascript
+ * // The following operation creates a new environment for version v1 of a java application named my-app:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "CNAMEPrefix": "my-app",
+ *   "EnvironmentName": "my-env",
+ *   "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
+ *   "VersionLabel": "v1"
+ * };
+ * const command = new CreateEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationName": "my-app",
+ *   "CNAME": "my-app.elasticbeanstalk.com",
+ *   "DateCreated": "2015-02-03T23:04:54.479Z",
+ *   "DateUpdated": "2015-02-03T23:04:54.479Z",
+ *   "EnvironmentId": "e-izqpassy4h",
+ *   "EnvironmentName": "my-env",
+ *   "Health": "Grey",
+ *   "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
+ *   "Status": "Launching",
+ *   "Tier": {
+ *     "Name": "WebServer",
+ *     "Type": "Standard",
+ *     "Version": " "
+ *   },
+ *   "VersionLabel": "v1"
+ * }
+ * *\/
+ * // example id: to-create-a-new-environment-for-an-application-1456269380396
+ * ```
+ *
  */
 export declare class CreateEnvironmentCommand extends $Command<CreateEnvironmentCommandInput, CreateEnvironmentCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: CreateEnvironmentCommandInput;

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

@@ -33,6 +33,20 @@ export interface CreateStorageLocationCommandOutput extends CreateStorageLocatio
  * @see {@link CreateStorageLocationCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To create a new environment for an application
+ * ```javascript
+ * // The following operation creates a new environment for version v1 of a java application named my-app:
+ * const input = undefined;
+ * const command = new CreateStorageLocationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012"
+ * }
+ * *\/
+ * // example id: to-create-a-new-environment-for-an-application-1456269380396
+ * ```
+ *
  */
 export declare class CreateStorageLocationCommand extends $Command<CreateStorageLocationCommandInput, CreateStorageLocationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: CreateStorageLocationCommandInput;

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

@@ -34,6 +34,17 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {
  * @see {@link DeleteApplicationCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To delete an application
+ * ```javascript
+ * // The following operation deletes an application named my-app:
+ * const input = {
+ *   "ApplicationName": "my-app"
+ * };
+ * const command = new DeleteApplicationCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-an-application-1456269699366
+ * ```
+ *
  */
 export declare class DeleteApplicationCommand extends $Command<DeleteApplicationCommandInput, DeleteApplicationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DeleteApplicationCommandInput;

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

@@ -33,6 +33,19 @@ export interface DeleteApplicationVersionCommandOutput extends __MetadataBearer
  * @see {@link DeleteApplicationVersionCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To delete an application version
+ * ```javascript
+ * // The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "DeleteSourceBundle": true,
+ *   "VersionLabel": "22a0-stage-150819_182129"
+ * };
+ * const command = new DeleteApplicationVersionCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-an-application-version-1456269792956
+ * ```
+ *
  */
 export declare class DeleteApplicationVersionCommand extends $Command<DeleteApplicationVersionCommandInput, DeleteApplicationVersionCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DeleteApplicationVersionCommandInput;

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

@@ -34,6 +34,18 @@ export interface DeleteConfigurationTemplateCommandOutput extends __MetadataBear
  * @see {@link DeleteConfigurationTemplateCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To delete a configuration template
+ * ```javascript
+ * // The following operation deletes a configuration template named my-template for an application named my-app:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "TemplateName": "my-template"
+ * };
+ * const command = new DeleteConfigurationTemplateCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-configuration-template-1456269836701
+ * ```
+ *
  */
 export declare class DeleteConfigurationTemplateCommand extends $Command<DeleteConfigurationTemplateCommandInput, DeleteConfigurationTemplateCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DeleteConfigurationTemplateCommandInput;

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

@@ -34,6 +34,18 @@ export interface DeleteEnvironmentConfigurationCommandOutput extends __MetadataB
  * @see {@link DeleteEnvironmentConfigurationCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To delete a draft configuration
+ * ```javascript
+ * // The following operation deletes a draft configuration for an environment named my-env:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new DeleteEnvironmentConfigurationCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-draft-configuration-1456269886654
+ * ```
+ *
  */
 export declare class DeleteEnvironmentConfigurationCommand extends $Command<DeleteEnvironmentConfigurationCommandInput, DeleteEnvironmentConfigurationCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DeleteEnvironmentConfigurationCommandInput;

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

@@ -29,6 +29,48 @@ export interface DescribeApplicationVersionsCommandOutput extends ApplicationVer
  * @see {@link DescribeApplicationVersionsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view information about an application version
+ * ```javascript
+ * // The following operation retrieves information about an application version labeled v2:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "VersionLabels": [
+ *     "v2"
+ *   ]
+ * };
+ * const command = new DescribeApplicationVersionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationVersions": [
+ *     {
+ *       "ApplicationName": "my-app",
+ *       "DateCreated": "2015-07-23T01:32:26.079Z",
+ *       "DateUpdated": "2015-07-23T01:32:26.079Z",
+ *       "Description": "update cover page",
+ *       "SourceBundle": {
+ *         "S3Bucket": "elasticbeanstalk-us-west-2-015321684451",
+ *         "S3Key": "my-app/5026-stage-150723_224258.war"
+ *       },
+ *       "VersionLabel": "v2"
+ *     },
+ *     {
+ *       "ApplicationName": "my-app",
+ *       "DateCreated": "2015-07-23T22:26:10.816Z",
+ *       "DateUpdated": "2015-07-23T22:26:10.816Z",
+ *       "Description": "initial version",
+ *       "SourceBundle": {
+ *         "S3Bucket": "elasticbeanstalk-us-west-2-015321684451",
+ *         "S3Key": "my-app/5026-stage-150723_222618.war"
+ *       },
+ *       "VersionLabel": "v1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-view-information-about-an-application-version-1456269947428
+ * ```
+ *
  */
 export declare class DescribeApplicationVersionsCommand extends $Command<DescribeApplicationVersionsCommandInput, DescribeApplicationVersionsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeApplicationVersionsCommandInput;

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

@@ -29,6 +29,50 @@ export interface DescribeApplicationsCommandOutput extends ApplicationDescriptio
  * @see {@link DescribeApplicationsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view a list of applications
+ * ```javascript
+ * // The following operation retrieves information about applications in the current region:
+ * const input = {};
+ * const command = new DescribeApplicationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Applications": [
+ *     {
+ *       "ApplicationName": "ruby",
+ *       "ConfigurationTemplates": [],
+ *       "DateCreated": "2015-08-13T21:05:44.376Z",
+ *       "DateUpdated": "2015-08-13T21:05:44.376Z",
+ *       "Versions": [
+ *         "Sample Application"
+ *       ]
+ *     },
+ *     {
+ *       "ApplicationName": "pythonsample",
+ *       "ConfigurationTemplates": [],
+ *       "DateCreated": "2015-08-13T19:05:43.637Z",
+ *       "DateUpdated": "2015-08-13T19:05:43.637Z",
+ *       "Description": "Application created from the EB CLI using \"eb init\"",
+ *       "Versions": [
+ *         "Sample Application"
+ *       ]
+ *     },
+ *     {
+ *       "ApplicationName": "nodejs-example",
+ *       "ConfigurationTemplates": [],
+ *       "DateCreated": "2015-08-06T17:50:02.486Z",
+ *       "DateUpdated": "2015-08-06T17:50:02.486Z",
+ *       "Versions": [
+ *         "add elasticache",
+ *         "First Release"
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-view-a-list-of-applications-1456270027373
+ * ```
+ *
  */
 export declare class DescribeApplicationsCommand extends $Command<DescribeApplicationsCommandInput, DescribeApplicationsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeApplicationsCommandInput;

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

@@ -32,6 +32,43 @@ export interface DescribeConfigurationOptionsCommandOutput extends Configuration
  * @see {@link DescribeConfigurationOptionsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view configuration options for an environment
+ * ```javascript
+ * // The following operation retrieves descriptions of all available configuration options for an environment named my-env:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new DescribeConfigurationOptionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Options": [
+ *     {
+ *       "ChangeSeverity": "NoInterruption",
+ *       "DefaultValue": "30",
+ *       "MaxValue": 300,
+ *       "MinValue": 5,
+ *       "Name": "Interval",
+ *       "Namespace": "aws:elb:healthcheck",
+ *       "UserDefined": false,
+ *       "ValueType": "Scalar"
+ *     },
+ *     {
+ *       "ChangeSeverity": "NoInterruption",
+ *       "DefaultValue": "2000000",
+ *       "MinValue": 0,
+ *       "Name": "LowerThreshold",
+ *       "Namespace": "aws:autoscaling:trigger",
+ *       "UserDefined": false,
+ *       "ValueType": "Scalar"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-view-configuration-options-for-an-environment-1456276763917
+ * ```
+ *
  */
 export declare class DescribeConfigurationOptionsCommand extends $Command<DescribeConfigurationOptionsCommandInput, DescribeConfigurationOptionsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeConfigurationOptionsCommandInput;

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

@@ -43,6 +43,59 @@ export interface DescribeConfigurationSettingsCommandOutput extends Configuratio
  * @see {@link DescribeConfigurationSettingsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view configurations settings for an environment
+ * ```javascript
+ * // The following operation retrieves configuration settings for an environment named my-env:
+ * const input = {
+ *   "ApplicationName": "my-app",
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new DescribeConfigurationSettingsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ConfigurationSettings": [
+ *     {
+ *       "ApplicationName": "my-app",
+ *       "DateCreated": "2015-08-13T19:16:25Z",
+ *       "DateUpdated": "2015-08-13T23:30:07Z",
+ *       "DeploymentStatus": "deployed",
+ *       "Description": "Environment created from the EB CLI using \"eb create\"",
+ *       "EnvironmentName": "my-env",
+ *       "OptionSettings": [
+ *         {
+ *           "Namespace": "aws:autoscaling:asg",
+ *           "OptionName": "Availability Zones",
+ *           "ResourceName": "AWSEBAutoScalingGroup",
+ *           "Value": "Any"
+ *         },
+ *         {
+ *           "Namespace": "aws:autoscaling:asg",
+ *           "OptionName": "Cooldown",
+ *           "ResourceName": "AWSEBAutoScalingGroup",
+ *           "Value": "360"
+ *         },
+ *         {
+ *           "Namespace": "aws:elb:policies",
+ *           "OptionName": "ConnectionDrainingTimeout",
+ *           "ResourceName": "AWSEBLoadBalancer",
+ *           "Value": "20"
+ *         },
+ *         {
+ *           "Namespace": "aws:elb:policies",
+ *           "OptionName": "ConnectionSettingIdleTimeout",
+ *           "ResourceName": "AWSEBLoadBalancer",
+ *           "Value": "60"
+ *         }
+ *       ],
+ *       "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-view-configurations-settings-for-an-environment-1456276924537
+ * ```
+ *
  */
 export declare class DescribeConfigurationSettingsCommand extends $Command<DescribeConfigurationSettingsCommandInput, DescribeConfigurationSettingsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeConfigurationSettingsCommandInput;

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

@@ -31,6 +31,59 @@ export interface DescribeEnvironmentHealthCommandOutput extends DescribeEnvironm
  * @see {@link DescribeEnvironmentHealthCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view environment health
+ * ```javascript
+ * // The following operation retrieves overall health information for an environment named my-env:
+ * const input = {
+ *   "AttributeNames": [
+ *     "All"
+ *   ],
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new DescribeEnvironmentHealthCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplicationMetrics": {
+ *     "Duration": 10,
+ *     "Latency": {
+ *       "P10": 0.001,
+ *       "P50": 0.001,
+ *       "P75": 0.002,
+ *       "P85": 0.003,
+ *       "P90": 0.003,
+ *       "P95": 0.004,
+ *       "P99": 0.004,
+ *       "P999": 0.004
+ *     },
+ *     "RequestCount": 45,
+ *     "StatusCodes": {
+ *       "Status2xx": 45,
+ *       "Status3xx": 0,
+ *       "Status4xx": 0,
+ *       "Status5xx": 0
+ *     }
+ *   },
+ *   "Causes": [],
+ *   "Color": "Green",
+ *   "EnvironmentName": "my-env",
+ *   "HealthStatus": "Ok",
+ *   "InstancesHealth": {
+ *     "Degraded": 0,
+ *     "Info": 0,
+ *     "NoData": 0,
+ *     "Ok": 1,
+ *     "Pending": 0,
+ *     "Severe": 0,
+ *     "Unknown": 0,
+ *     "Warning": 0
+ *   },
+ *   "RefreshedAt": "2015-08-20T21:09:18Z"
+ * }
+ * *\/
+ * // example id: to-view-environment-health-1456277109510
+ * ```
+ *
  */
 export declare class DescribeEnvironmentHealthCommand extends $Command<DescribeEnvironmentHealthCommandInput, DescribeEnvironmentHealthCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeEnvironmentHealthCommandInput;

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

@@ -29,6 +29,46 @@ export interface DescribeEnvironmentResourcesCommandOutput extends EnvironmentRe
  * @see {@link DescribeEnvironmentResourcesCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view information about the AWS resources in your environment
+ * ```javascript
+ * // The following operation retrieves information about resources in an environment named my-env:
+ * const input = {
+ *   "EnvironmentName": "my-env"
+ * };
+ * const command = new DescribeEnvironmentResourcesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "EnvironmentResources": {
+ *     "AutoScalingGroups": [
+ *       {
+ *         "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT"
+ *       }
+ *     ],
+ *     "EnvironmentName": "my-env",
+ *     "Instances": [
+ *       {
+ *         "Id": "i-0c91c786"
+ *       }
+ *     ],
+ *     "LaunchConfigurations": [
+ *       {
+ *         "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2"
+ *       }
+ *     ],
+ *     "LoadBalancers": [
+ *       {
+ *         "Name": "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0"
+ *       }
+ *     ],
+ *     "Queues": [],
+ *     "Triggers": []
+ *   }
+ * }
+ * *\/
+ * // example id: to-view-information-about-the-aws-resources-in-your-environment-1456277206232
+ * ```
+ *
  */
 export declare class DescribeEnvironmentResourcesCommand extends $Command<DescribeEnvironmentResourcesCommandInput, DescribeEnvironmentResourcesCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeEnvironmentResourcesCommandInput;

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

@@ -29,6 +29,44 @@ export interface DescribeEnvironmentsCommandOutput extends EnvironmentDescriptio
  * @see {@link DescribeEnvironmentsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @example To view information about an environment
+ * ```javascript
+ * // The following operation retrieves information about an environment named my-env:
+ * const input = {
+ *   "EnvironmentNames": [
+ *     "my-env"
+ *   ]
+ * };
+ * const command = new DescribeEnvironmentsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Environments": [
+ *     {
+ *       "AbortableOperationInProgress": false,
+ *       "ApplicationName": "my-app",
+ *       "CNAME": "my-env.elasticbeanstalk.com",
+ *       "DateCreated": "2015-08-07T20:48:49.599Z",
+ *       "DateUpdated": "2015-08-12T18:16:55.019Z",
+ *       "EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com",
+ *       "EnvironmentId": "e-rpqsewtp2j",
+ *       "EnvironmentName": "my-env",
+ *       "Health": "Green",
+ *       "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
+ *       "Status": "Ready",
+ *       "Tier": {
+ *         "Name": "WebServer",
+ *         "Type": "Standard",
+ *         "Version": " "
+ *       },
+ *       "VersionLabel": "7f58-stage-150812_025409"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-view-information-about-an-environment-1456277288662
+ * ```
+ *
  */
 export declare class DescribeEnvironmentsCommand extends $Command<DescribeEnvironmentsCommandInput, DescribeEnvironmentsCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: DescribeEnvironmentsCommandInput;