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

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

@@ -29,6 +29,42 @@ export interface TerminateEnvironmentCommandOutput extends EnvironmentDescriptio
  * @see {@link TerminateEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link InsufficientPrivilegesException} (client fault)
+ *  <p>The specified account does not have sufficient privileges for one or more AWS
+ *       services.</p>
+ *
+ *
+ * @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,37 @@ 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/UpdateApplicationResourceLifecycleCommand.d.ts

@@ -29,6 +29,11 @@ export interface UpdateApplicationResourceLifecycleCommandOutput extends Applica
  * @see {@link UpdateApplicationResourceLifecycleCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link InsufficientPrivilegesException} (client fault)
+ *  <p>The specified account does not have sufficient privileges for one or more AWS
+ *       services.</p>
+ *
+ *
  */
 export declare class UpdateApplicationResourceLifecycleCommand extends $Command<UpdateApplicationResourceLifecycleCommandInput, UpdateApplicationResourceLifecycleCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: UpdateApplicationResourceLifecycleCommandInput;

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

@@ -33,6 +33,35 @@ 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,41 @@ export interface UpdateConfigurationTemplateCommandOutput extends ConfigurationS
  * @see {@link UpdateConfigurationTemplateCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link InsufficientPrivilegesException} (client fault)
+ *  <p>The specified account does not have sufficient privileges for one or more AWS
+ *       services.</p>
+ *
+ * @throws {@link TooManyBucketsException} (client fault)
+ *  <p>The specified account has reached its limit of Amazon S3 buckets.</p>
+ *
+ *
+ * @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,100 @@ export interface UpdateEnvironmentCommandOutput extends EnvironmentDescription,
  * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link InsufficientPrivilegesException} (client fault)
+ *  <p>The specified account does not have sufficient privileges for one or more AWS
+ *       services.</p>
+ *
+ * @throws {@link TooManyBucketsException} (client fault)
+ *  <p>The specified account has reached its limit of Amazon S3 buckets.</p>
+ *
+ *
+ * @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/UpdateTagsForResourceCommand.d.ts

@@ -48,6 +48,27 @@ export interface UpdateTagsForResourceCommandOutput extends __MetadataBearer {
  * @see {@link UpdateTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link InsufficientPrivilegesException} (client fault)
+ *  <p>The specified account does not have sufficient privileges for one or more AWS
+ *       services.</p>
+ *
+ * @throws {@link OperationInProgressException} (client fault)
+ *  <p>Unable to perform the specified operation because another operation that effects an
+ *       element in this activity is already in progress.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>A resource doesn't exist for the specified Amazon Resource Name (ARN).</p>
+ *
+ * @throws {@link ResourceTypeNotSupportedException} (client fault)
+ *  <p>The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.</p>
+ *
+ * @throws {@link TooManyTagsException} (client fault)
+ *  <p>The number of tags in the resource would exceed the number of tags that each resource
+ *       can have.</p>
+ *          <p>To calculate this, the operation considers both the number of tags the resource already has
+ *       and the tags this operation would add if it succeeded.</p>
+ *
+ *
  */
 export declare class UpdateTagsForResourceCommand extends $Command<UpdateTagsForResourceCommandInput, UpdateTagsForResourceCommandOutput, ElasticBeanstalkClientResolvedConfig> {
     readonly input: UpdateTagsForResourceCommandInput;

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

@@ -32,6 +32,38 @@ export interface ValidateConfigurationSettingsCommandOutput extends Configuratio
  * @see {@link ValidateConfigurationSettingsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link InsufficientPrivilegesException} (client fault)
+ *  <p>The specified account does not have sufficient privileges for one or more AWS
+ *       services.</p>
+ *
+ * @throws {@link TooManyBucketsException} (client fault)
+ *  <p>The specified account has reached its limit of Amazon S3 buckets.</p>
+ *
+ *
+ * @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.290.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.290.0",
+    "@aws-sdk/config-resolver": "3.290.0",
+    "@aws-sdk/credential-provider-node": "3.290.0",
+    "@aws-sdk/fetch-http-handler": "3.290.0",
+    "@aws-sdk/hash-node": "3.290.0",
+    "@aws-sdk/invalid-dependency": "3.290.0",
+    "@aws-sdk/middleware-content-length": "3.290.0",
+    "@aws-sdk/middleware-endpoint": "3.290.0",
+    "@aws-sdk/middleware-host-header": "3.290.0",
+    "@aws-sdk/middleware-logger": "3.290.0",
+    "@aws-sdk/middleware-recursion-detection": "3.290.0",
+    "@aws-sdk/middleware-retry": "3.290.0",
+    "@aws-sdk/middleware-serde": "3.290.0",
+    "@aws-sdk/middleware-signing": "3.290.0",
+    "@aws-sdk/middleware-stack": "3.290.0",
+    "@aws-sdk/middleware-user-agent": "3.290.0",
+    "@aws-sdk/node-config-provider": "3.290.0",
+    "@aws-sdk/node-http-handler": "3.290.0",
+    "@aws-sdk/protocol-http": "3.290.0",
+    "@aws-sdk/smithy-client": "3.290.0",
+    "@aws-sdk/types": "3.290.0",
+    "@aws-sdk/url-parser": "3.290.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.290.0",
+    "@aws-sdk/util-defaults-mode-node": "3.290.0",
+    "@aws-sdk/util-endpoints": "3.290.0",
+    "@aws-sdk/util-retry": "3.290.0",
+    "@aws-sdk/util-user-agent-browser": "3.290.0",
+    "@aws-sdk/util-user-agent-node": "3.290.0",
     "@aws-sdk/util-utf8": "3.254.0",
-    "@aws-sdk/util-waiter": "3.272.0",
+    "@aws-sdk/util-waiter": "3.290.0",
     "fast-xml-parser": "4.1.2",
     "tslib": "^2.3.1"
   },