@aws-sdk/client-elastic-beanstalk 3.325.0 → 3.326.0

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

@@ -48,6 +48,8 @@ export interface RequestEnvironmentInfoCommandOutput extends __MetadataBearer {
  * };
  * const command = new RequestEnvironmentInfoCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param RequestEnvironmentInfoCommandInput - {@link RequestEnvironmentInfoCommandInput}
@@ -56,6 +58,8 @@ export interface RequestEnvironmentInfoCommandOutput extends __MetadataBearer {
  * @see {@link RequestEnvironmentInfoCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To request tailed logs
  * ```javascript

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

@@ -33,6 +33,8 @@ export interface RestartAppServerCommandOutput extends __MetadataBearer {
  * };
  * const command = new RestartAppServerCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param RestartAppServerCommandInput - {@link RestartAppServerCommandInput}
@@ -41,6 +43,8 @@ export interface RestartAppServerCommandOutput extends __MetadataBearer {
  * @see {@link RestartAppServerCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To restart application servers
  * ```javascript

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

@@ -42,6 +42,17 @@ export interface RetrieveEnvironmentInfoCommandOutput extends RetrieveEnvironmen
  * };
  * const command = new RetrieveEnvironmentInfoCommand(input);
  * const response = await client.send(command);
+ * // { // RetrieveEnvironmentInfoResultMessage
+ * //   EnvironmentInfo: [ // EnvironmentInfoDescriptionList
+ * //     { // EnvironmentInfoDescription
+ * //       InfoType: "tail" || "bundle",
+ * //       Ec2InstanceId: "STRING_VALUE",
+ * //       SampleTimestamp: new Date("TIMESTAMP"),
+ * //       Message: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param RetrieveEnvironmentInfoCommandInput - {@link RetrieveEnvironmentInfoCommandInput}
@@ -50,6 +61,8 @@ export interface RetrieveEnvironmentInfoCommandOutput extends RetrieveEnvironmen
  * @see {@link RetrieveEnvironmentInfoCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To retrieve tailed logs
  * ```javascript

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

@@ -34,6 +34,8 @@ export interface SwapEnvironmentCNAMEsCommandOutput extends __MetadataBearer {
  * };
  * const command = new SwapEnvironmentCNAMEsCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param SwapEnvironmentCNAMEsCommandInput - {@link SwapEnvironmentCNAMEsCommandInput}
@@ -42,6 +44,8 @@ export interface SwapEnvironmentCNAMEsCommandOutput extends __MetadataBearer {
  * @see {@link SwapEnvironmentCNAMEsCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To swap environment CNAMES
  * ```javascript

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

@@ -34,6 +34,50 @@ export interface TerminateEnvironmentCommandOutput extends EnvironmentDescriptio
  * };
  * const command = new TerminateEnvironmentCommand(input);
  * const response = await client.send(command);
+ * // { // EnvironmentDescription
+ * //   EnvironmentName: "STRING_VALUE",
+ * //   EnvironmentId: "STRING_VALUE",
+ * //   ApplicationName: "STRING_VALUE",
+ * //   VersionLabel: "STRING_VALUE",
+ * //   SolutionStackName: "STRING_VALUE",
+ * //   PlatformArn: "STRING_VALUE",
+ * //   TemplateName: "STRING_VALUE",
+ * //   Description: "STRING_VALUE",
+ * //   EndpointURL: "STRING_VALUE",
+ * //   CNAME: "STRING_VALUE",
+ * //   DateCreated: new Date("TIMESTAMP"),
+ * //   DateUpdated: new Date("TIMESTAMP"),
+ * //   Status: "Aborting" || "Launching" || "Updating" || "LinkingFrom" || "LinkingTo" || "Ready" || "Terminating" || "Terminated",
+ * //   AbortableOperationInProgress: true || false,
+ * //   Health: "Green" || "Yellow" || "Red" || "Grey",
+ * //   HealthStatus: "NoData" || "Unknown" || "Pending" || "Ok" || "Info" || "Warning" || "Degraded" || "Severe" || "Suspended",
+ * //   Resources: { // EnvironmentResourcesDescription
+ * //     LoadBalancer: { // LoadBalancerDescription
+ * //       LoadBalancerName: "STRING_VALUE",
+ * //       Domain: "STRING_VALUE",
+ * //       Listeners: [ // LoadBalancerListenersDescription
+ * //         { // Listener
+ * //           Protocol: "STRING_VALUE",
+ * //           Port: Number("int"),
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * //   Tier: { // EnvironmentTier
+ * //     Name: "STRING_VALUE",
+ * //     Type: "STRING_VALUE",
+ * //     Version: "STRING_VALUE",
+ * //   },
+ * //   EnvironmentLinks: [ // EnvironmentLinks
+ * //     { // EnvironmentLink
+ * //       LinkName: "STRING_VALUE",
+ * //       EnvironmentName: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   EnvironmentArn: "STRING_VALUE",
+ * //   OperationsRole: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param TerminateEnvironmentCommandInput - {@link TerminateEnvironmentCommandInput}
@@ -46,6 +90,8 @@ export interface TerminateEnvironmentCommandOutput extends EnvironmentDescriptio
  *  <p>The specified account does not have sufficient privileges for one or more AWS
  *       services.</p>
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To terminate an environment
  * ```javascript

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

@@ -36,6 +36,37 @@ export interface UpdateApplicationCommandOutput extends ApplicationDescriptionMe
  * };
  * const command = new UpdateApplicationCommand(input);
  * const response = await client.send(command);
+ * // { // ApplicationDescriptionMessage
+ * //   Application: { // ApplicationDescription
+ * //     ApplicationArn: "STRING_VALUE",
+ * //     ApplicationName: "STRING_VALUE",
+ * //     Description: "STRING_VALUE",
+ * //     DateCreated: new Date("TIMESTAMP"),
+ * //     DateUpdated: new Date("TIMESTAMP"),
+ * //     Versions: [ // VersionLabelsList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     ConfigurationTemplates: [ // ConfigurationTemplateNamesList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     ResourceLifecycleConfig: { // ApplicationResourceLifecycleConfig
+ * //       ServiceRole: "STRING_VALUE",
+ * //       VersionLifecycleConfig: { // ApplicationVersionLifecycleConfig
+ * //         MaxCountRule: { // MaxCountRule
+ * //           Enabled: true || false, // required
+ * //           MaxCount: Number("int"),
+ * //           DeleteSourceFromS3: true || false,
+ * //         },
+ * //         MaxAgeRule: { // MaxAgeRule
+ * //           Enabled: true || false, // required
+ * //           MaxAgeInDays: Number("int"),
+ * //           DeleteSourceFromS3: true || false,
+ * //         },
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateApplicationCommandInput - {@link UpdateApplicationCommandInput}
@@ -44,6 +75,8 @@ export interface UpdateApplicationCommandOutput extends ApplicationDescriptionMe
  * @see {@link UpdateApplicationCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To change an application's description
  * ```javascript

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

@@ -46,6 +46,25 @@ export interface UpdateApplicationResourceLifecycleCommandOutput extends Applica
  * };
  * const command = new UpdateApplicationResourceLifecycleCommand(input);
  * const response = await client.send(command);
+ * // { // ApplicationResourceLifecycleDescriptionMessage
+ * //   ApplicationName: "STRING_VALUE",
+ * //   ResourceLifecycleConfig: { // ApplicationResourceLifecycleConfig
+ * //     ServiceRole: "STRING_VALUE",
+ * //     VersionLifecycleConfig: { // ApplicationVersionLifecycleConfig
+ * //       MaxCountRule: { // MaxCountRule
+ * //         Enabled: true || false, // required
+ * //         MaxCount: Number("int"),
+ * //         DeleteSourceFromS3: true || false,
+ * //       },
+ * //       MaxAgeRule: { // MaxAgeRule
+ * //         Enabled: true || false, // required
+ * //         MaxAgeInDays: Number("int"),
+ * //         DeleteSourceFromS3: true || false,
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateApplicationResourceLifecycleCommandInput - {@link UpdateApplicationResourceLifecycleCommandInput}
@@ -58,6 +77,8 @@ export interface UpdateApplicationResourceLifecycleCommandOutput extends Applica
  *  <p>The specified account does not have sufficient privileges for one or more AWS
  *       services.</p>
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  */
 export declare class UpdateApplicationResourceLifecycleCommand extends $Command<UpdateApplicationResourceLifecycleCommandInput, UpdateApplicationResourceLifecycleCommandOutput, ElasticBeanstalkClientResolvedConfig> {

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

@@ -37,6 +37,28 @@ export interface UpdateApplicationVersionCommandOutput extends ApplicationVersio
  * };
  * const command = new UpdateApplicationVersionCommand(input);
  * const response = await client.send(command);
+ * // { // ApplicationVersionDescriptionMessage
+ * //   ApplicationVersion: { // ApplicationVersionDescription
+ * //     ApplicationVersionArn: "STRING_VALUE",
+ * //     ApplicationName: "STRING_VALUE",
+ * //     Description: "STRING_VALUE",
+ * //     VersionLabel: "STRING_VALUE",
+ * //     SourceBuildInformation: { // SourceBuildInformation
+ * //       SourceType: "Git" || "Zip", // required
+ * //       SourceRepository: "CodeCommit" || "S3", // required
+ * //       SourceLocation: "STRING_VALUE", // required
+ * //     },
+ * //     BuildArn: "STRING_VALUE",
+ * //     SourceBundle: { // S3Location
+ * //       S3Bucket: "STRING_VALUE",
+ * //       S3Key: "STRING_VALUE",
+ * //     },
+ * //     DateCreated: new Date("TIMESTAMP"),
+ * //     DateUpdated: new Date("TIMESTAMP"),
+ * //     Status: "Processed" || "Unprocessed" || "Failed" || "Processing" || "Building",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateApplicationVersionCommandInput - {@link UpdateApplicationVersionCommandInput}
@@ -45,6 +67,8 @@ export interface UpdateApplicationVersionCommandOutput extends ApplicationVersio
  * @see {@link UpdateApplicationVersionCommandOutput} for command's `response` shape.
  * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape.
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To change an application version's description
  * ```javascript

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

@@ -61,6 +61,26 @@ export interface UpdateConfigurationTemplateCommandOutput extends ConfigurationS
  * };
  * const command = new UpdateConfigurationTemplateCommand(input);
  * const response = await client.send(command);
+ * // { // ConfigurationSettingsDescription
+ * //   SolutionStackName: "STRING_VALUE",
+ * //   PlatformArn: "STRING_VALUE",
+ * //   ApplicationName: "STRING_VALUE",
+ * //   TemplateName: "STRING_VALUE",
+ * //   Description: "STRING_VALUE",
+ * //   EnvironmentName: "STRING_VALUE",
+ * //   DeploymentStatus: "deployed" || "pending" || "failed",
+ * //   DateCreated: new Date("TIMESTAMP"),
+ * //   DateUpdated: new Date("TIMESTAMP"),
+ * //   OptionSettings: [ // ConfigurationOptionSettingsList
+ * //     { // ConfigurationOptionSetting
+ * //       ResourceName: "STRING_VALUE",
+ * //       Namespace: "STRING_VALUE",
+ * //       OptionName: "STRING_VALUE",
+ * //       Value: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param UpdateConfigurationTemplateCommandInput - {@link UpdateConfigurationTemplateCommandInput}
@@ -76,6 +96,8 @@ export interface UpdateConfigurationTemplateCommandOutput extends ConfigurationS
  * @throws {@link TooManyBucketsException} (client fault)
  *  <p>The specified account has reached its limit of Amazon S3 buckets.</p>
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To update a configuration template
  * ```javascript

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

@@ -67,6 +67,50 @@ export interface UpdateEnvironmentCommandOutput extends EnvironmentDescription,
  * };
  * const command = new UpdateEnvironmentCommand(input);
  * const response = await client.send(command);
+ * // { // EnvironmentDescription
+ * //   EnvironmentName: "STRING_VALUE",
+ * //   EnvironmentId: "STRING_VALUE",
+ * //   ApplicationName: "STRING_VALUE",
+ * //   VersionLabel: "STRING_VALUE",
+ * //   SolutionStackName: "STRING_VALUE",
+ * //   PlatformArn: "STRING_VALUE",
+ * //   TemplateName: "STRING_VALUE",
+ * //   Description: "STRING_VALUE",
+ * //   EndpointURL: "STRING_VALUE",
+ * //   CNAME: "STRING_VALUE",
+ * //   DateCreated: new Date("TIMESTAMP"),
+ * //   DateUpdated: new Date("TIMESTAMP"),
+ * //   Status: "Aborting" || "Launching" || "Updating" || "LinkingFrom" || "LinkingTo" || "Ready" || "Terminating" || "Terminated",
+ * //   AbortableOperationInProgress: true || false,
+ * //   Health: "Green" || "Yellow" || "Red" || "Grey",
+ * //   HealthStatus: "NoData" || "Unknown" || "Pending" || "Ok" || "Info" || "Warning" || "Degraded" || "Severe" || "Suspended",
+ * //   Resources: { // EnvironmentResourcesDescription
+ * //     LoadBalancer: { // LoadBalancerDescription
+ * //       LoadBalancerName: "STRING_VALUE",
+ * //       Domain: "STRING_VALUE",
+ * //       Listeners: [ // LoadBalancerListenersDescription
+ * //         { // Listener
+ * //           Protocol: "STRING_VALUE",
+ * //           Port: Number("int"),
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * //   Tier: { // EnvironmentTier
+ * //     Name: "STRING_VALUE",
+ * //     Type: "STRING_VALUE",
+ * //     Version: "STRING_VALUE",
+ * //   },
+ * //   EnvironmentLinks: [ // EnvironmentLinks
+ * //     { // EnvironmentLink
+ * //       LinkName: "STRING_VALUE",
+ * //       EnvironmentName: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   EnvironmentArn: "STRING_VALUE",
+ * //   OperationsRole: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param UpdateEnvironmentCommandInput - {@link UpdateEnvironmentCommandInput}
@@ -82,6 +126,8 @@ export interface UpdateEnvironmentCommandOutput extends EnvironmentDescription,
  * @throws {@link TooManyBucketsException} (client fault)
  *  <p>The specified account has reached its limit of Amazon S3 buckets.</p>
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To update an environment to a new version
  * ```javascript

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

@@ -59,6 +59,8 @@ export interface UpdateTagsForResourceCommandOutput extends __MetadataBearer {
  * };
  * const command = new UpdateTagsForResourceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdateTagsForResourceCommandInput - {@link UpdateTagsForResourceCommandInput}
@@ -87,6 +89,8 @@ export interface UpdateTagsForResourceCommandOutput extends __MetadataBearer {
  *          <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>
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  */
 export declare class UpdateTagsForResourceCommand extends $Command<UpdateTagsForResourceCommandInput, UpdateTagsForResourceCommandOutput, ElasticBeanstalkClientResolvedConfig> {

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

@@ -44,6 +44,17 @@ export interface ValidateConfigurationSettingsCommandOutput extends Configuratio
  * };
  * const command = new ValidateConfigurationSettingsCommand(input);
  * const response = await client.send(command);
+ * // { // ConfigurationSettingsValidationMessages
+ * //   Messages: [ // ValidationMessagesList
+ * //     { // ValidationMessage
+ * //       Message: "STRING_VALUE",
+ * //       Severity: "error" || "warning",
+ * //       Namespace: "STRING_VALUE",
+ * //       OptionName: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ValidateConfigurationSettingsCommandInput - {@link ValidateConfigurationSettingsCommandInput}
@@ -59,6 +70,8 @@ export interface ValidateConfigurationSettingsCommandOutput extends Configuratio
  * @throws {@link TooManyBucketsException} (client fault)
  *  <p>The specified account has reached its limit of Amazon S3 buckets.</p>
  *
+ * @throws {@link ElasticBeanstalkServiceException}
+ * <p>Base exception class for all service exceptions from ElasticBeanstalk service.</p>
  *
  * @example To validate configuration settings
  * ```javascript

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.325.0",
+  "version": "3.326.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.325.0",
+    "@aws-sdk/client-sts": "3.326.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.325.0",
+    "@aws-sdk/credential-provider-node": "3.326.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",