# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AbortEnvironmentUpdate](API_AbortEnvironmentUpdate.md) 
+  [ApplyEnvironmentManagedAction](API_ApplyEnvironmentManagedAction.md) 
+  [AssociateEnvironmentOperationsRole](API_AssociateEnvironmentOperationsRole.md) 
+  [CheckDNSAvailability](API_CheckDNSAvailability.md) 
+  [ComposeEnvironments](API_ComposeEnvironments.md) 
+  [CreateApplication](API_CreateApplication.md) 
+  [CreateApplicationVersion](API_CreateApplicationVersion.md) 
+  [CreateConfigurationTemplate](API_CreateConfigurationTemplate.md) 
+  [CreateEnvironment](API_CreateEnvironment.md) 
+  [CreatePlatformVersion](API_CreatePlatformVersion.md) 
+  [CreateStorageLocation](API_CreateStorageLocation.md) 
+  [DeleteApplication](API_DeleteApplication.md) 
+  [DeleteApplicationVersion](API_DeleteApplicationVersion.md) 
+  [DeleteConfigurationTemplate](API_DeleteConfigurationTemplate.md) 
+  [DeleteEnvironmentConfiguration](API_DeleteEnvironmentConfiguration.md) 
+  [DeletePlatformVersion](API_DeletePlatformVersion.md) 
+  [DescribeAccountAttributes](API_DescribeAccountAttributes.md) 
+  [DescribeApplications](API_DescribeApplications.md) 
+  [DescribeApplicationVersions](API_DescribeApplicationVersions.md) 
+  [DescribeConfigurationOptions](API_DescribeConfigurationOptions.md) 
+  [DescribeConfigurationSettings](API_DescribeConfigurationSettings.md) 
+  [DescribeEnvironmentHealth](API_DescribeEnvironmentHealth.md) 
+  [DescribeEnvironmentManagedActionHistory](API_DescribeEnvironmentManagedActionHistory.md) 
+  [DescribeEnvironmentManagedActions](API_DescribeEnvironmentManagedActions.md) 
+  [DescribeEnvironmentResources](API_DescribeEnvironmentResources.md) 
+  [DescribeEnvironments](API_DescribeEnvironments.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeInstancesHealth](API_DescribeInstancesHealth.md) 
+  [DescribePlatformVersion](API_DescribePlatformVersion.md) 
+  [DisassociateEnvironmentOperationsRole](API_DisassociateEnvironmentOperationsRole.md) 
+  [ListAvailableSolutionStacks](API_ListAvailableSolutionStacks.md) 
+  [ListPlatformBranches](API_ListPlatformBranches.md) 
+  [ListPlatformVersions](API_ListPlatformVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [RebuildEnvironment](API_RebuildEnvironment.md) 
+  [RequestEnvironmentInfo](API_RequestEnvironmentInfo.md) 
+  [RestartAppServer](API_RestartAppServer.md) 
+  [RetrieveEnvironmentInfo](API_RetrieveEnvironmentInfo.md) 
+  [SwapEnvironmentCNAMEs](API_SwapEnvironmentCNAMEs.md) 
+  [TerminateEnvironment](API_TerminateEnvironment.md) 
+  [UpdateApplication](API_UpdateApplication.md) 
+  [UpdateApplicationResourceLifecycle](API_UpdateApplicationResourceLifecycle.md) 
+  [UpdateApplicationVersion](API_UpdateApplicationVersion.md) 
+  [UpdateConfigurationTemplate](API_UpdateConfigurationTemplate.md) 
+  [UpdateEnvironment](API_UpdateEnvironment.md) 
+  [UpdateTagsForResource](API_UpdateTagsForResource.md) 
+  [ValidateConfigurationSettings](API_ValidateConfigurationSettings.md) 

# AbortEnvironmentUpdate
<a name="API_AbortEnvironmentUpdate"></a>

Cancels in-progress environment configuration update or application version deployment.

## Request Parameters
<a name="API_AbortEnvironmentUpdate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
This specifies the ID of the environment with the in-progress update that you want to cancel.  
Type: String  
Required: No

 ** EnvironmentName **   
This specifies the name of the environment with the in-progress update that you want to cancel.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

## Errors
<a name="API_AbortEnvironmentUpdate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## See Also
<a name="API_AbortEnvironmentUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate) 

# ApplyEnvironmentManagedAction
<a name="API_ApplyEnvironmentManagedAction"></a>

Applies a scheduled managed action immediately. A managed action can be applied only if its status is `Scheduled`. Get the status and action ID of a managed action with [DescribeEnvironmentManagedActions](API_DescribeEnvironmentManagedActions.md).

## Request Parameters
<a name="API_ApplyEnvironmentManagedAction_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ActionId **   
The action ID of the scheduled managed action to execute.  
Type: String  
Required: Yes

 ** EnvironmentId **   
The environment ID of the target environment.  
Type: String  
Required: No

 ** EnvironmentName **   
The name of the target environment.  
Type: String  
Required: No

## Response Elements
<a name="API_ApplyEnvironmentManagedAction_ResponseElements"></a>

The following elements are returned by the service.

 ** ActionDescription **   
A description of the managed action.  
Type: String

 ** ActionId **   
The action ID of the managed action.  
Type: String

 ** ActionType **   
The type of managed action.  
Type: String  
Valid Values: `InstanceRefresh | PlatformUpdate | Unknown` 

 ** Status **   
The status of the managed action.  
Type: String

## Errors
<a name="API_ApplyEnvironmentManagedAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

 ** ManagedActionInvalidState **   
Cannot modify the managed action in its current state.  
HTTP Status Code: 400

## See Also
<a name="API_ApplyEnvironmentManagedAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction) 

# AssociateEnvironmentOperationsRole
<a name="API_AssociateEnvironmentOperationsRole"></a>

**Important**  
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.

Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment.

## Request Parameters
<a name="API_AssociateEnvironmentOperationsRole_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentName **   
The name of the environment to which to set the operations role.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: Yes

 ** OperationsRole **   
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Errors
<a name="API_AssociateEnvironmentOperationsRole_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## Examples
<a name="API_AssociateEnvironmentOperationsRole_Examples"></a>

### Example
<a name="API_AssociateEnvironmentOperationsRole_Example_1"></a>

This example illustrates one usage of AssociateEnvironmentOperationsRole.

#### Sample Request
<a name="API_AssociateEnvironmentOperationsRole_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentName=MyEnv
&OperationsRole=arn:aws:iam::123456789012:role/MyOpsRole
&Operation=AssociateEnvironmentOperationsRole
&AuthParams
```

#### Sample Response
<a name="API_AssociateEnvironmentOperationsRole_Example_1_Response"></a>

```
<AssociateEnvironmentOperationsRoleResponse xmlns="http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>f4e1b145-9080-11e0-8e5a-a558e0ce1fc4</RequestId>
  </ResponseMetadata>
</AssociateEnvironmentOperationsRoleResponse>
```

## See Also
<a name="API_AssociateEnvironmentOperationsRole_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole) 

# CheckDNSAvailability
<a name="API_CheckDNSAvailability"></a>

Checks if the specified CNAME is available.

## Request Parameters
<a name="API_CheckDNSAvailability_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CNAMEPrefix **   
The prefix used when this CNAME is reserved.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 63.  
Required: Yes

## Response Elements
<a name="API_CheckDNSAvailability_ResponseElements"></a>

The following elements are returned by the service.

 ** Available **   
Indicates if the specified CNAME is available:  
+  `true` : The CNAME is available.
+  `false` : The CNAME is not available.
Type: Boolean

 ** FullyQualifiedCNAME **   
The fully qualified CNAME to reserve when [CreateEnvironment](API_CreateEnvironment.md) is called with the provided prefix.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_CheckDNSAvailability_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_CheckDNSAvailability_Examples"></a>

### Example
<a name="API_CheckDNSAvailability_Example_1"></a>

This example illustrates one usage of CheckDNSAvailability.

#### Sample Request
<a name="API_CheckDNSAvailability_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?CNAMEPrefix=sampleapplication
&Operation=CheckDNSAvailability
&AuthParams
```

#### Sample Response
<a name="API_CheckDNSAvailability_Example_1_Response"></a>

```
<CheckDNSAvailabilityResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <CheckDNSAvailabilityResult>
    <FullyQualifiedCNAME>sampleapplication.elasticbeanstalk.amazonaws.com</FullyQualifiedCNAME>
    <Available>true</Available>
  </CheckDNSAvailabilityResult>
  <ResponseMetadata>
    <RequestId>12f6701f-f1d6-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</CheckDNSAvailabilityResponse>
```

## See Also
<a name="API_CheckDNSAvailability_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/CheckDNSAvailability) 

# ComposeEnvironments
<a name="API_ComposeEnvironments"></a>

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named `env.yaml`. See [Compose Environments](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html) for details.

## Request Parameters
<a name="API_ComposeEnvironments_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application to which the specified source bundles belong.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** GroupName **   
The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a \$1 (plus) character. See [Environment Manifest (env.yaml)](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) for details.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 19.  
Required: No

 **VersionLabels.member.N**   
A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_ComposeEnvironments_ResponseElements"></a>

The following elements are returned by the service.

 **Environments.member.N**   
 Returns an [EnvironmentDescription](API_EnvironmentDescription.md) list.   
Type: Array of [EnvironmentDescription](API_EnvironmentDescription.md) objects

 ** NextToken **   
In a paginated request, the token that you can pass in a subsequent request to get the next response page.  
Type: String

## Errors
<a name="API_ComposeEnvironments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** TooManyEnvironments **   
The specified account has reached its limit of environments.  
HTTP Status Code: 400

## See Also
<a name="API_ComposeEnvironments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/ComposeEnvironments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/ComposeEnvironments) 

# CreateApplication
<a name="API_CreateApplication"></a>

Creates an application that has one configuration template named `default` and no application versions.

## Request Parameters
<a name="API_CreateApplication_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application. Must be unique within your account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** Description **   
Your description of the application.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

 ** ResourceLifecycleConfig **   
Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.  
Type: [ApplicationResourceLifecycleConfig](API_ApplicationResourceLifecycleConfig.md) object  
Required: No

 **Tags.member.N**   
Specifies the tags applied to the application.  
Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateApplication_ResponseElements"></a>

The following element is returned by the service.

 ** Application **   
 The [ApplicationDescription](API_ApplicationDescription.md) of the application.   
Type: [ApplicationDescription](API_ApplicationDescription.md) object

## Errors
<a name="API_CreateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** TooManyApplications **   
The specified account has reached its limit of applications.  
HTTP Status Code: 400

## Examples
<a name="API_CreateApplication_Examples"></a>

### Example
<a name="API_CreateApplication_Example_1"></a>

This example illustrates one usage of CreateApplication.

#### Sample Request
<a name="API_CreateApplication_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&Description=Sample%20Description
&Operation=CreateApplication
&AuthParams
```

#### Sample Response
<a name="API_CreateApplication_Example_1_Response"></a>

```
<CreateApplicationResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <CreateApplicationResult>
    <Application>
      <Versions/>
      <Description>Sample Description</Description>
      <ApplicationName>SampleApp</ApplicationName>
      <DateCreated>2010-11-16T23:09:20.256Z</DateCreated>
      <DateUpdated>2010-11-16T23:09:20.256Z</DateUpdated>
      <ConfigurationTemplates>
        <member>Default</member>
      </ConfigurationTemplates>
    </Application>
  </CreateApplicationResult>
  <ResponseMetadata>
    <RequestId>8b00e053-f1d6-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</CreateApplicationResponse>
```

## See Also
<a name="API_CreateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/CreateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/CreateApplication) 

# CreateApplicationVersion
<a name="API_CreateApplicationVersion"></a>

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with `SourceBuildInformation`.

Specify a build in an AWS CodeBuild with `SourceBuildInformation` and `BuildConfiguration`.

Specify a source bundle in Amazon S3 with `SourceBundle` 

Omit both `SourceBuildInformation` and `SourceBundle` to use the default sample application.

**Note**  
After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

## Request Parameters
<a name="API_CreateApplicationVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
 The name of the application. If no application is found with this name, and `AutoCreateApplication` is `false`, returns an `InvalidParameterValue` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** AutoCreateApplication **   
Set to `true` to create an application with the specified name if it doesn't already exist.  
Type: Boolean  
Required: No

 ** BuildConfiguration **   
Settings for an AWS CodeBuild build.  
Type: [BuildConfiguration](API_BuildConfiguration.md) object  
Required: No

 ** Description **   
A description of this application version.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

 ** Process **   
Pre-processes and validates the environment manifest (`env.yaml`) and configuration files (`*.config` files in the `.ebextensions` folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.  
You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.  
The `Process` option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.
Type: Boolean  
Required: No

 ** SourceBuildInformation **   
Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.  
Type: [SourceBuildInformation](API_SourceBuildInformation.md) object  
Required: No

 ** SourceBundle **   
The Amazon S3 bucket and key that identify the location of the source bundle for this version.  
The Amazon S3 bucket must be in the same region as the environment.  
Unless you're specifying a source bundle in the bucket that Elastic Beanstalk manages in your account, you must assign a custom policy to your user, and grant `Allow` permission to the `s3:Get*` actions on your S3 object resource, for example, `arn:aws:s3:::your-bucket/your-source-bundle-object`.
Specify a source bundle in Amazon S3 or a commit in an AWS CodeCommit repository (with `SourceBuildInformation`), but not both. If neither `SourceBundle` nor `SourceBuildInformation` are provided, Elastic Beanstalk uses a sample application.  
Type: [S3Location](API_S3Location.md) object  
Required: No

 **Tags.member.N**   
Specifies the tags applied to the application version.  
Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** VersionLabel **   
A label identifying this version.  
Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an `InvalidParameterValue` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Elements
<a name="API_CreateApplicationVersion_ResponseElements"></a>

The following element is returned by the service.

 ** ApplicationVersion **   
 The [ApplicationVersionDescription](API_ApplicationVersionDescription.md) of the application version.   
Type: [ApplicationVersionDescription](API_ApplicationVersionDescription.md) object

## Errors
<a name="API_CreateApplicationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CodeBuildNotInServiceRegion **   
 AWS CodeBuild is not available in the specified region.  
HTTP Status Code: 400

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** S3LocationNotInServiceRegion **   
The specified S3 bucket does not belong to the S3 region in which the service is running. The following regions are supported:  
+ IAD/us-east-1
+ PDX/us-west-2
+ DUB/eu-west-1
HTTP Status Code: 400

 ** TooManyApplications **   
The specified account has reached its limit of applications.  
HTTP Status Code: 400

 ** TooManyApplicationVersions **   
The specified account has reached its limit of application versions.  
HTTP Status Code: 400

## Examples
<a name="API_CreateApplicationVersion_Examples"></a>

### Example
<a name="API_CreateApplicationVersion_Example_1"></a>

This example illustrates one usage of CreateApplicationVersion.

#### Sample Request
<a name="API_CreateApplicationVersion_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&VersionLabel=Version1
&Description=description
&SourceBundle.S3Bucket=amazonaws.com
&SourceBundle.S3Key=sample.war
&AutoCreateApplication=true
&Operation=CreateApplicationVersion
&AuthParams
```

#### Sample Response
<a name="API_CreateApplicationVersion_Example_1_Response"></a>

```
<CreateApplicationVersionResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <CreateApplicationVersionResult>
    <ApplicationVersion>
      <SourceBundle>
        <S3Bucket>amazonaws.com</S3Bucket>
        <S3Key>sample.war</S3Key>
      </SourceBundle>
      <VersionLabel>Version1</VersionLabel>
      <Description>description</Description>
      <ApplicationName>SampleApp</ApplicationName>
      <DateCreated>2010-11-17T03:21:59.161Z</DateCreated>
      <DateUpdated>2010-11-17T03:21:59.161Z</DateUpdated>
    </ApplicationVersion>
  </CreateApplicationVersionResult>
  <ResponseMetadata>
    <RequestId>d653efef-f1f9-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</CreateApplicationVersionResponse>
```

## See Also
<a name="API_CreateApplicationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/CreateApplicationVersion) 

# CreateConfigurationTemplate
<a name="API_CreateConfigurationTemplate"></a>

Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

Templates aren't associated with any environment. The `EnvironmentName` response element is always `null`.

Related Topics
+  [DescribeConfigurationOptions](API_DescribeConfigurationOptions.md) 
+  [DescribeConfigurationSettings](API_DescribeConfigurationSettings.md) 
+  [ListAvailableSolutionStacks](API_ListAvailableSolutionStacks.md) 

## Request Parameters
<a name="API_CreateConfigurationTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the Elastic Beanstalk application to associate with this configuration template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** Description **   
An optional description for this configuration.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

 ** EnvironmentId **   
The ID of an environment whose settings you want to use to create the configuration template. You must specify `EnvironmentId` if you don't specify `PlatformArn`, `SolutionStackName`, or `SourceConfiguration`.  
Type: String  
Required: No

 **OptionSettings.member.N**   
Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the * AWS Elastic Beanstalk Developer Guide*.  
Type: Array of [ConfigurationOptionSetting](API_ConfigurationOptionSetting.md) objects  
Required: No

 ** PlatformArn **   
The Amazon Resource Name (ARN) of the custom platform. For more information, see [ Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the * AWS Elastic Beanstalk Developer Guide*.  
If you specify `PlatformArn`, then don't specify `SolutionStackName`.
Type: String  
Required: No

 ** SolutionStackName **   
The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, `64bit Amazon Linux 2013.09 running Tomcat 7 Java 7`. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the * AWS Elastic Beanstalk Developer Guide*.  
You must specify `SolutionStackName` if you don't specify `PlatformArn`, `EnvironmentId`, or `SourceConfiguration`.  
Use the [https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html) API to obtain a list of available solution stacks.  
Type: String  
Required: No

 ** SourceConfiguration **   
An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.  
Values specified in `OptionSettings` override any values obtained from the `SourceConfiguration`.  
You must specify `SourceConfiguration` if you don't specify `PlatformArn`, `EnvironmentId`, or `SolutionStackName`.  
Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.  
Type: [SourceConfiguration](API_SourceConfiguration.md) object  
Required: No

 **Tags.member.N**   
Specifies the tags applied to the configuration template.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TemplateName **   
The name of the configuration template.  
Constraint: This name must be unique per application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Elements
<a name="API_CreateConfigurationTemplate_ResponseElements"></a>

The following elements are returned by the service.

 ** ApplicationName **   
The name of the application associated with this configuration set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** DateCreated **   
The date (in UTC time) when this configuration set was created.  
Type: Timestamp

 ** DateUpdated **   
The date (in UTC time) when this configuration set was last modified.  
Type: Timestamp

 ** DeploymentStatus **   
 If this configuration set is associated with an environment, the `DeploymentStatus` parameter indicates the deployment status of this configuration set:   
+  `null`: This configuration is not associated with a running environment.
+  `pending`: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
+  `deployed`: This is the configuration that is currently deployed to the associated running environment.
+  `failed`: This is a draft configuration that failed to successfully deploy.
Type: String  
Valid Values: `deployed | pending | failed` 

 ** Description **   
Describes this configuration set.  
Type: String  
Length Constraints: Maximum length of 200.

 ** EnvironmentName **   
 If not `null`, the name of the environment for this configuration set.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.

 **OptionSettings.member.N**   
A list of the configuration options and their values in this configuration set.  
Type: Array of [ConfigurationOptionSetting](API_ConfigurationOptionSetting.md) objects

 ** PlatformArn **   
The ARN of the platform version.  
Type: String

 ** SolutionStackName **   
The name of the solution stack this configuration set uses.  
Type: String

 ** TemplateName **   
 If not `null`, the name of the configuration template for this configuration set.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_CreateConfigurationTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** TooManyBuckets **   
The specified account has reached its limit of Amazon S3 buckets.  
HTTP Status Code: 400

 ** TooManyConfigurationTemplates **   
The specified account has reached its limit of configuration templates.  
HTTP Status Code: 400

## Examples
<a name="API_CreateConfigurationTemplate_Examples"></a>

### Example
<a name="API_CreateConfigurationTemplate_Example_1"></a>

This example illustrates one usage of CreateConfigurationTemplate.

#### Sample Request
<a name="API_CreateConfigurationTemplate_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&TemplateName=AppTemplate
&SolutionStackName=32bit%20Amazon%20Linux%20running%20Tomcat%207
&Description=ConfigTemplateDescription
&Operation=CreateConfigurationTemplate
&AuthParams
```

#### Sample Response
<a name="API_CreateConfigurationTemplate_Example_1_Response"></a>

```
<CreateConfigurationTemplateResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <CreateConfigurationTemplateResult>
    <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
    <OptionSettings>
      <member>
        <OptionName>ImageId</OptionName>
        <Value>ami-f2f0069b</Value>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <OptionName>Notification Endpoint</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <OptionName>PARAM4</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>JDBC_CONNECTION_STRING</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>SecurityGroups</OptionName>
        <Value>elasticbeanstalk-default</Value>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <OptionName>UnhealthyThreshold</OptionName>
        <Value>5</Value>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <OptionName>InstanceType</OptionName>
        <Value>t1.micro</Value>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <OptionName>Statistic</OptionName>
        <Value>Average</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>LoadBalancerHTTPSPort</OptionName>
        <Value>OFF</Value>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
      <member>
        <OptionName>Stickiness Cookie Expiration</OptionName>
        <Value>0</Value>
        <Namespace>aws:elb:policies</Namespace>
      </member>
      <member>
        <OptionName>PARAM5</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>MeasureName</OptionName>
        <Value>NetworkOut</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>Interval</OptionName>
        <Value>30</Value>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <OptionName>Application Healthcheck URL</OptionName>
        <Value>/</Value>
        <Namespace>aws:elasticbeanstalk:application</Namespace>
      </member>
      <member>
        <OptionName>Notification Topic ARN</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <OptionName>LowerBreachScaleIncrement</OptionName>
        <Value>-1</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>XX:MaxPermSize</OptionName>
        <Value>64m</Value>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <OptionName>UpperBreachScaleIncrement</OptionName>
        <Value>1</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>MinSize</OptionName>
        <Value>1</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>Custom Availability Zones</OptionName>
        <Value>us-east-1a</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>Availability Zones</OptionName>
        <Value>Any 1</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>LogPublicationControl</OptionName>
        <Value>false</Value>
        <Namespace>aws:elasticbeanstalk:hostmanager</Namespace>
      </member>
      <member>
        <OptionName>JVM Options</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <OptionName>Notification Topic Name</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <OptionName>PARAM2</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>LoadBalancerHTTPPort</OptionName>
        <Value>80</Value>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
      <member>
        <OptionName>Timeout</OptionName>
        <Value>5</Value>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <OptionName>BreachDuration</OptionName>
        <Value>2</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>MonitoringInterval</OptionName>
        <Value>5 minute</Value>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <OptionName>PARAM1</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>MaxSize</OptionName>
        <Value>4</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>LowerThreshold</OptionName>
        <Value>2000000</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>AWS_SECRET_KEY</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>AWS_ACCESS_KEY_ID</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>UpperThreshold</OptionName>
        <Value>6000000</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>Notification Protocol</OptionName>
        <Value>email</Value>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <OptionName>Unit</OptionName>
        <Value>Bytes</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>Xmx</OptionName>
        <Value>256m</Value>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <OptionName>Cooldown</OptionName>
        <Value>360</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>Period</OptionName>
        <Value>1</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>Xms</OptionName>
        <Value>256m</Value>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <OptionName>EC2KeyName</OptionName>
        <Value/>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <OptionName>Stickiness Policy</OptionName>
        <Value>false</Value>
        <Namespace>aws:elb:policies</Namespace>
      </member>
      <member>
        <OptionName>PARAM3</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>HealthyThreshold</OptionName>
        <Value>3</Value>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <OptionName>SSLCertificateId</OptionName>
        <Value/>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
    </OptionSettings>
    <Description>ConfigTemplateDescription</Description>
    <ApplicationName>SampleApp</ApplicationName>
    <DateCreated>2010-11-17T03:48:19.640Z</DateCreated>
    <TemplateName>AppTemplate</TemplateName>
    <DateUpdated>2010-11-17T03:48:19.640Z</DateUpdated>
  </CreateConfigurationTemplateResult>
  <ResponseMetadata>
    <RequestId>846cd905-f1fd-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</CreateConfigurationTemplateResponse>
```

## See Also
<a name="API_CreateConfigurationTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate) 

# CreateEnvironment
<a name="API_CreateEnvironment"></a>

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

## Request Parameters
<a name="API_CreateEnvironment_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application that is associated with this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** CNAMEPrefix **   
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 63.  
Required: No

 ** Description **   
Your description for this environment.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

 ** EnvironmentName **   
A unique name for the environment.  
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an `InvalidParameterValue` error.   
If you don't specify the `CNAMEPrefix` parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** GroupName **   
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See [Environment Manifest (env.yaml)](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) for details.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 19.  
Required: No

 ** OperationsRole **   
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the `iam:PassRole` permission for the role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 **OptionSettings.member.N**   
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.  
Type: Array of [ConfigurationOptionSetting](API_ConfigurationOptionSetting.md) objects  
Required: No

 **OptionsToRemove.member.N**   
A list of custom user-defined configuration options to remove from the configuration set for this new environment.  
Type: Array of [OptionSpecification](API_OptionSpecification.md) objects  
Required: No

 ** PlatformArn **   
The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the * AWS Elastic Beanstalk Developer Guide*.  
If you specify `PlatformArn`, don't specify `SolutionStackName`.
Type: String  
Required: No

 ** SolutionStackName **   
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see [Elastic Beanstalk Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) in the * AWS Elastic Beanstalk Platforms* guide.  
If you specify `SolutionStackName`, don't specify `PlatformArn` or `TemplateName`.
Type: String  
Required: No

 **Tags.member.N**   
Specifies the tags applied to resources in the environment.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TemplateName **   
The name of the Elastic Beanstalk configuration template to use with the environment.  
If you specify `TemplateName`, then don't specify `SolutionStackName`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** Tier **   
Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.  
Type: [EnvironmentTier](API_EnvironmentTier.md) object  
Required: No

 ** VersionLabel **   
The name of the application version to deploy.  
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_CreateEnvironment_ResponseElements"></a>

The following elements are returned by the service.

 ** AbortableOperationInProgress **   
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.  
 `true:` There is an update in progress.   
 `false:` There are no updates currently in progress.   
Type: Boolean

 ** ApplicationName **   
The name of the application associated with this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** CNAME **   
The URL to the CNAME for this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** DateCreated **   
The creation date for this environment.  
Type: Timestamp

 ** DateUpdated **   
The last modified date for this environment.  
Type: Timestamp

 ** Description **   
Describes this environment.  
Type: String  
Length Constraints: Maximum length of 200.

 ** EndpointURL **   
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.  
Type: String

 ** EnvironmentArn **   
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.  
Type: String

 ** EnvironmentId **   
The ID of this environment.  
Type: String

 **EnvironmentLinks.member.N**   
A list of links to other environments in the same group.  
Type: Array of [EnvironmentLink](API_EnvironmentLink.md) objects

 ** EnvironmentName **   
The name of this environment.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.

 ** Health **   
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:  
+  `Red`: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
+  `Yellow`: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
+  `Green`: Indicates the environment is healthy and fully functional.
+  `Grey`: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an `UpdateEnvironment` or `RestartEnvironment` request.
 Default: `Grey`   
Type: String  
Valid Values: `Green | Yellow | Red | Grey` 

 ** HealthStatus **   
Returns the health status of the application running in your environment. For more information, see [Health Colors and Statuses](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html).  
Type: String  
Valid Values: `NoData | Unknown | Pending | Ok | Info | Warning | Degraded | Severe | Suspended` 

 ** OperationsRole **   
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
The Amazon Resource Name (ARN) of the environment's operations role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** PlatformArn **   
The ARN of the platform version.  
Type: String

 ** Resources **   
The description of the AWS resources used by this environment.  
Type: [EnvironmentResourcesDescription](API_EnvironmentResourcesDescription.md) object

 ** SolutionStackName **   
 The name of the `SolutionStack` deployed with this environment.   
Type: String

 ** Status **   
The current operational status of the environment:  
+  `Aborting`: Environment is in the process of aborting a deployment.
+  `Launching`: Environment is in the process of initial deployment.
+  `LinkingFrom`: Environment is in the process of being linked to by another environment. See [Environment links](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html) for details.
+  `LinkingTo`: Environment is in the process of linking to another environment. See [Environment links](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html) for details.
+  `Updating`: Environment is in the process of updating its configuration settings or application version.
+  `Ready`: Environment is available to have an action performed on it, such as update or terminate.
+  `Terminating`: Environment is in the shut-down process.
+  `Terminated`: Environment is not running.
Type: String  
Valid Values: `Aborting | Launching | Updating | LinkingFrom | LinkingTo | Ready | Terminating | Terminated` 

 ** TemplateName **   
The name of the configuration template used to originally launch this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** Tier **   
Describes the current tier of this environment.  
Type: [EnvironmentTier](API_EnvironmentTier.md) object

 ** VersionLabel **   
The application version deployed in this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_CreateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** TooManyEnvironments **   
The specified account has reached its limit of environments.  
HTTP Status Code: 400

## Examples
<a name="API_CreateEnvironment_Examples"></a>

### Example
<a name="API_CreateEnvironment_Example_1"></a>

This example illustrates one usage of CreateEnvironment.

#### Sample Request
<a name="API_CreateEnvironment_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&EnvironmentName=SampleApp
&SolutionStackName=32bit%20Amazon%20Linux%20running%20Tomcat%207
&Description=EnvDescrip
&Operation=CreateEnvironment
&AuthParams
```

#### Sample Response
<a name="API_CreateEnvironment_Example_1_Response"></a>

```
<CreateEnvironmentResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <CreateEnvironmentResult>
    <VersionLabel>Version1</VersionLabel>
    <Status>Deploying</Status>
    <ApplicationName>SampleApp</ApplicationName>
    <Health>Grey</Health>
    <EnvironmentId>e-icsgecu3wf</EnvironmentId>
    <DateUpdated>2010-11-17T03:59:33.520Z</DateUpdated>
    <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
    <Description>EnvDescrip</Description>
    <EnvironmentName>SampleApp</EnvironmentName>
    <DateCreated>2010-11-17T03:59:33.520Z</DateCreated>
  </CreateEnvironmentResult>
  <ResponseMetadata>
    <RequestId>15db925e-f1ff-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</CreateEnvironmentResponse>
```

## See Also
<a name="API_CreateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/CreateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/CreateEnvironment) 

# CreatePlatformVersion
<a name="API_CreatePlatformVersion"></a>

Create a new version of your custom platform.

## Request Parameters
<a name="API_CreatePlatformVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentName **   
The name of the builder environment.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 **OptionSettings.member.N**   
The configuration option settings to apply to the builder environment.  
Type: Array of [ConfigurationOptionSetting](API_ConfigurationOptionSetting.md) objects  
Required: No

 ** PlatformDefinitionBundle **   
The location of the platform definition archive in Amazon S3.  
Type: [S3Location](API_S3Location.md) object  
Required: Yes

 ** PlatformName **   
The name of your custom platform.  
Type: String  
Required: Yes

 ** PlatformVersion **   
The number, such as 1.0.2, for the new platform version.  
Type: String  
Required: Yes

 **Tags.member.N**   
Specifies the tags applied to the new platform version.  
Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreatePlatformVersion_ResponseElements"></a>

The following elements are returned by the service.

 ** Builder **   
The builder used to create the custom platform.  
Type: [Builder](API_Builder.md) object

 ** PlatformSummary **   
Detailed information about the new version of the custom platform.  
Type: [PlatformSummary](API_PlatformSummary.md) object

## Errors
<a name="API_CreatePlatformVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** TooManyPlatforms **   
You have exceeded the maximum number of allowed platforms associated with the account.  
HTTP Status Code: 400

## See Also
<a name="API_CreatePlatformVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/CreatePlatformVersion) 

# CreateStorageLocation
<a name="API_CreateStorageLocation"></a>

Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, `CreateStorageLocation` still returns the bucket name but does not create a new bucket.

## Response Elements
<a name="API_CreateStorageLocation_ResponseElements"></a>

The following element is returned by the service.

 ** S3Bucket **   
The name of the Amazon S3 bucket created.  
Type: String  
Length Constraints: Maximum length of 255.

## Errors
<a name="API_CreateStorageLocation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** S3SubscriptionRequired **   
The specified account does not have a subscription to Amazon S3.  
HTTP Status Code: 400

 ** TooManyBuckets **   
The specified account has reached its limit of Amazon S3 buckets.  
HTTP Status Code: 400

## Examples
<a name="API_CreateStorageLocation_Examples"></a>

### Example
<a name="API_CreateStorageLocation_Example_1"></a>

This example illustrates one usage of CreateStorageLocation.

#### Sample Request
<a name="API_CreateStorageLocation_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?Operation=CreateStorageLocation
&AuthParams
```

#### Sample Response
<a name="API_CreateStorageLocation_Example_1_Response"></a>

```
          <CreateStorageLocationResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <CreateStorageLocationResult>
    <S3Bucket>elasticbeanstalk-us-east-1-780612358023</S3Bucket>
  </CreateStorageLocationResult>
  <ResponseMetadata>
    <RequestId>ef51b94a-f1d6-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</CreateStorageLocationResponse>
```

## See Also
<a name="API_CreateStorageLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/CreateStorageLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/CreateStorageLocation) 

# DeleteApplication
<a name="API_DeleteApplication"></a>

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

**Note**  
You cannot delete an application that has a running environment.

## Request Parameters
<a name="API_DeleteApplication_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** TerminateEnvByForce **   
When set to true, running environments will be terminated before deleting the application.  
Type: Boolean  
Required: No

## Errors
<a name="API_DeleteApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OperationInProgressFailure **   
Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteApplication_Examples"></a>

### Example
<a name="API_DeleteApplication_Example_1"></a>

This example illustrates one usage of DeleteApplication.

#### Sample Request
<a name="API_DeleteApplication_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&Operation=DeleteApplication
&AuthParams
```

#### Sample Response
<a name="API_DeleteApplication_Example_1_Response"></a>

```
<DeleteApplicationResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>1f155abd-f1d7-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DeleteApplicationResponse>
```

## See Also
<a name="API_DeleteApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DeleteApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DeleteApplication) 

# DeleteApplicationVersion
<a name="API_DeleteApplicationVersion"></a>

Deletes the specified version from the specified application.

**Note**  
You cannot delete an application version that is associated with a running environment.

## Request Parameters
<a name="API_DeleteApplicationVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application to which the version belongs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** DeleteSourceBundle **   
Set to `true` to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.  
Type: Boolean  
Required: No

 ** VersionLabel **   
The label of the version to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Errors
<a name="API_DeleteApplicationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** OperationInProgressFailure **   
Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.  
HTTP Status Code: 400

 ** S3LocationNotInServiceRegion **   
The specified S3 bucket does not belong to the S3 region in which the service is running. The following regions are supported:  
+ IAD/us-east-1
+ PDX/us-west-2
+ DUB/eu-west-1
HTTP Status Code: 400

 ** SourceBundleDeletionFailure **   
Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteApplicationVersion_Examples"></a>

### Example
<a name="API_DeleteApplicationVersion_Example_1"></a>

This example illustrates one usage of DeleteApplicationVersion.

#### Sample Request
<a name="API_DeleteApplicationVersion_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&VersionLabel=First%20Release
&Operation=DeleteApplicationVersion
&AuthParams
```

#### Sample Response
<a name="API_DeleteApplicationVersion_Example_1_Response"></a>

```
<DeleteApplicationVersionResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>58dc7339-f272-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DeleteApplicationVersionResponse>
```

## See Also
<a name="API_DeleteApplicationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DeleteApplicationVersion) 

# DeleteConfigurationTemplate
<a name="API_DeleteConfigurationTemplate"></a>

Deletes the specified configuration template.

**Note**  
When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

## Request Parameters
<a name="API_DeleteConfigurationTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application to delete the configuration template from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** TemplateName **   
The name of the configuration template to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Errors
<a name="API_DeleteConfigurationTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OperationInProgressFailure **   
Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteConfigurationTemplate_Examples"></a>

### Example
<a name="API_DeleteConfigurationTemplate_Example_1"></a>

This example illustrates one usage of DeleteConfigurationTemplate.

#### Sample Request
<a name="API_DeleteConfigurationTemplate_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&TemplateName=SampleAppTemplate
&Operation=DeleteConfigurationTemplate
&AuthParams
```

#### Sample Response
<a name="API_DeleteConfigurationTemplate_Example_1_Response"></a>

```
<DeleteConfigurationTemplateResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>af9cf1b6-f25e-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DeleteConfigurationTemplateResponse>
```

## See Also
<a name="API_DeleteConfigurationTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate) 

# DeleteEnvironmentConfiguration
<a name="API_DeleteEnvironmentConfiguration"></a>

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using [DescribeConfigurationSettings](API_DescribeConfigurationSettings.md) while the update is in progress or if the update fails. The `DeploymentStatus` for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

## Request Parameters
<a name="API_DeleteEnvironmentConfiguration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application the environment is associated with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** EnvironmentName **   
The name of the environment to delete the draft configuration from.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: Yes

## Errors
<a name="API_DeleteEnvironmentConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DeleteEnvironmentConfiguration_Examples"></a>

### Example
<a name="API_DeleteEnvironmentConfiguration_Example_1"></a>

This example illustrates one usage of DeleteEnvironmentConfiguration.

#### Sample Request
<a name="API_DeleteEnvironmentConfiguration_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&EnvironmentName=SampleApp
&Operation=DeleteEnvironmentConfiguration
&AuthParams
```

#### Sample Response
<a name="API_DeleteEnvironmentConfiguration_Example_1_Response"></a>

```
<DeleteEnvironmentConfigurationResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>fdf76507-f26d-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DeleteEnvironmentConfigurationResponse>
```

## See Also
<a name="API_DeleteEnvironmentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration) 

# DeletePlatformVersion
<a name="API_DeletePlatformVersion"></a>

Deletes the specified version of a custom platform.

## Request Parameters
<a name="API_DeletePlatformVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** PlatformArn **   
The ARN of the version of the custom platform.  
Type: String  
Required: No

## Response Elements
<a name="API_DeletePlatformVersion_ResponseElements"></a>

The following element is returned by the service.

 ** PlatformSummary **   
Detailed information about the version of the custom platform.  
Type: [PlatformSummary](API_PlatformSummary.md) object

## Errors
<a name="API_DeletePlatformVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** OperationInProgressFailure **   
Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.  
HTTP Status Code: 400

 ** PlatformVersionStillReferenced **   
You cannot delete the platform version because there are still environments running on it.  
HTTP Status Code: 400

## See Also
<a name="API_DeletePlatformVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DeletePlatformVersion) 

# DescribeAccountAttributes
<a name="API_DescribeAccountAttributes"></a>

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

The result currently has one set of attributes—resource quotas.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Response Elements
<a name="API_DescribeAccountAttributes_ResponseElements"></a>

The following element is returned by the service.

 ** ResourceQuotas **   
The Elastic Beanstalk resource quotas associated with the calling AWS account.  
Type: [ResourceQuotas](API_ResourceQuotas.md) object

## Errors
<a name="API_DescribeAccountAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## Examples
<a name="API_DescribeAccountAttributes_Examples"></a>

### Example
<a name="API_DescribeAccountAttributes_Example_1"></a>

This example illustrates one usage of DescribeAccountAttributes.

#### Sample Request
<a name="API_DescribeAccountAttributes_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?Operation=DescribeAccountAttributes
&AuthParams
```

#### Sample Response
<a name="API_DescribeAccountAttributes_Example_1_Response"></a>

```
<DescribeAccountAttributesResponse xmlns="http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <DescribeAccountAttributesResult>
    <ResourceQuotas>
      <ConfigurationTemplateQuota>
        <Maximum>2000</Maximum>
      </ConfigurationTemplateQuota>
      <ApplicationVersionQuota>
        <Maximum>1000</Maximum>
      </ApplicationVersionQuota>
      <CustomPlatformQuota>
        <Maximum>50</Maximum>
      </CustomPlatformQuota>
      <EnvironmentQuota>
        <Maximum>200</Maximum>
      </EnvironmentQuota>
      <ApplicationQuota>
        <Maximum>75</Maximum>
      </ApplicationQuota>
    </ResourceQuotas>
  </DescribeAccountAttributesResult>
  <ResponseMetadata>
    <RequestId>24fc4d65-1308-49e6-9b85-a0a8838f3b4b</RequestId>
  </ResponseMetadata>
</DescribeAccountAttributesResponse>
```

## See Also
<a name="API_DescribeAccountAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeAccountAttributes) 

# DescribeApplications
<a name="API_DescribeApplications"></a>

Returns the descriptions of existing applications.

This action only returns information about applications that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access two of three applications. When the user calls the *DescribeApplications* action, the response will only include the two applications that the user has permission to access instead of all three applications. If the user doesn’t have access to any of the applications an empty result is returned.

**Note**  
The *AWSElasticBeanstalkReadOnly* managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribeApplications_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **ApplicationNames.member.N**   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_DescribeApplications_ResponseElements"></a>

The following element is returned by the service.

 **Applications.member.N**   
This parameter contains a list of [ApplicationDescription](API_ApplicationDescription.md).  
Type: Array of [ApplicationDescription](API_ApplicationDescription.md) objects

## Errors
<a name="API_DescribeApplications_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeApplications_Examples"></a>

### Example
<a name="API_DescribeApplications_Example_1"></a>

This example illustrates one usage of DescribeApplications.

#### Sample Request
<a name="API_DescribeApplications_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationNames.member.1=SampleApplication
&Operation=DescribeApplications
&AuthParams
```

#### Sample Response
<a name="API_DescribeApplications_Example_1_Response"></a>

```
<DescribeApplicationsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <DescribeApplicationsResult>
    <Applications>
      <member>
        <Versions/>
        <Description>Sample Description</Description>
        <ApplicationName>SampleApplication</ApplicationName>
        <DateCreated>2010-11-16T20:20:51.974Z</DateCreated>
        <DateUpdated>2010-11-16T20:20:51.974Z</DateUpdated>
        <ConfigurationTemplates>
          <member>Default</member>
        </ConfigurationTemplates>
      </member>
    </Applications>
  </DescribeApplicationsResult>
  <ResponseMetadata>
    <RequestId>577c70ff-f1d7-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DescribeApplicationsResponse>
```

## See Also
<a name="API_DescribeApplications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeApplications) 

# DescribeApplicationVersions
<a name="API_DescribeApplicationVersions"></a>

Retrieve a list of application versions.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribeApplicationVersions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
Specify an application name to show only application versions for that application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** MaxRecords **   
For a paginated request. Specify a maximum number of application versions to include in each response.  
If no `MaxRecords` is specified, all available application versions are retrieved in a single response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** NextToken **   
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.  
If no `NextToken` is specified, the first page is retrieved.  
Type: String  
Required: No

 **VersionLabels.member.N**   
Specify a version label to show a specific application version.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_DescribeApplicationVersions_ResponseElements"></a>

The following elements are returned by the service.

 **ApplicationVersions.member.N**   
List of `ApplicationVersionDescription` objects sorted in order of creation.  
Type: Array of [ApplicationVersionDescription](API_ApplicationVersionDescription.md) objects

 ** NextToken **   
In a paginated request, the token that you can pass in a subsequent request to get the next response page.  
Type: String

## Errors
<a name="API_DescribeApplicationVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeApplicationVersions_Examples"></a>

### Example
<a name="API_DescribeApplicationVersions_Example_1"></a>

This example illustrates one usage of DescribeApplicationVersions.

#### Sample Request
<a name="API_DescribeApplicationVersions_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&Operation=DescribeApplicationVersions
&AuthParams
```

#### Sample Response
<a name="API_DescribeApplicationVersions_Example_1_Response"></a>

```
<DescribeApplicationVersionsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <DescribeApplicationVersionsResult>
    <ApplicationVersions>
      <member>
        <SourceBundle>
          <S3Bucket>amazonaws.com</S3Bucket>
          <S3Key>sample.war</S3Key>
        </SourceBundle>
        <VersionLabel>Version1</VersionLabel>
        <Description>description</Description>
        <ApplicationName>SampleApp</ApplicationName>
        <DateCreated>2010-11-17T03:21:59.161Z</DateCreated>
        <DateUpdated>2010-11-17T03:21:59.161Z</DateUpdated>
      </member>
    </ApplicationVersions>
  </DescribeApplicationVersionsResult>
  <ResponseMetadata>
    <RequestId>773cd80a-f26c-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DescribeApplicationVersionsResponse>
```

## See Also
<a name="API_DescribeApplicationVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeApplicationVersions) 

# DescribeConfigurationOptions
<a name="API_DescribeConfigurationOptions"></a>

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribeConfigurationOptions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** EnvironmentName **   
The name of the environment whose configuration options you want to describe.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 **Options.member.N**   
If specified, restricts the descriptions to only the specified options.  
Type: Array of [OptionSpecification](API_OptionSpecification.md) objects  
Required: No

 ** PlatformArn **   
The ARN of the custom platform.  
Type: String  
Required: No

 ** SolutionStackName **   
The name of the solution stack whose configuration options you want to describe.  
Type: String  
Required: No

 ** TemplateName **   
The name of the configuration template whose configuration options you want to describe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_DescribeConfigurationOptions_ResponseElements"></a>

The following elements are returned by the service.

 **Options.member.N**   
 A list of [ConfigurationOptionDescription](API_ConfigurationOptionDescription.md).   
Type: Array of [ConfigurationOptionDescription](API_ConfigurationOptionDescription.md) objects

 ** PlatformArn **   
The ARN of the platform version.  
Type: String

 ** SolutionStackName **   
The name of the solution stack these configuration options belong to.  
Type: String

## Errors
<a name="API_DescribeConfigurationOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** TooManyBuckets **   
The specified account has reached its limit of Amazon S3 buckets.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeConfigurationOptions_Examples"></a>

### Example
<a name="API_DescribeConfigurationOptions_Example_1"></a>

This example illustrates one usage of DescribeConfigurationOptions.

#### Sample Request
<a name="API_DescribeConfigurationOptions_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&TemplateName=default
&Operation=DescribeConfigurationOptions
&AuthParams
```

#### Sample Response
<a name="API_DescribeConfigurationOptions_Example_1_Response"></a>

```
<DescribeConfigurationOptionsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <DescribeConfigurationOptionsResult>
    <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
    <Options>
            <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>ImageId</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>ami-6036c009</DefaultValue>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>Notification Endpoint</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>PARAM4</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>JDBC_CONNECTION_STRING</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>SecurityGroups</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>elasticbeanstalk-default</DefaultValue>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>2</MinValue>
        <Name>UnhealthyThreshold</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>5</DefaultValue>
        <MaxValue>10</MaxValue>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <Name>InstanceType</Name>
        <ValueOptions>
          <member>t1.micro</member>
          <member>m1.small</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>t1.micro</DefaultValue>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <Name>Statistic</Name>
        <ValueOptions>
          <member>Minimum</member>
          <member>Maximum</member>
          <member>Sum</member>
          <member>Average</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>Average</DefaultValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <Name>LoadBalancerHTTPSPort</Name>
        <ValueOptions>
          <member>OFF</member>
          <member>443</member>
          <member>8443</member>
          <member>5443</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>OFF</DefaultValue>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>0</MinValue>
        <Name>Stickiness Cookie Expiration</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>0</DefaultValue>
        <MaxValue>1000000</MaxValue>
        <Namespace>aws:elb:policies</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>PARAM5</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <Name>MeasureName</Name>
        <ValueOptions>
          <member>CPUUtilization</member>
          <member>NetworkIn</member>
          <member>NetworkOut</member>
          <member>DiskWriteOps</member>
          <member>DiskReadBytes</member>
          <member>DiskReadOps</member>
          <member>DiskWriteBytes</member>
          <member>Latency</member>
          <member>RequestCount</member>
          <member>HealthyHostCount</member>
          <member>UnhealthyHostCount</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>NetworkOut</DefaultValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>5</MinValue>
        <Name>Interval</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>30</DefaultValue>
        <MaxValue>300</MaxValue>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>Application Healthcheck URL</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>/</DefaultValue>
        <Namespace>aws:elasticbeanstalk:application</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>Notification Topic ARN</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>LowerBreachScaleIncrement</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>-1</DefaultValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Regex>
          <Pattern>^\S*$</Pattern>
          <Label>nospaces</Label>
        </Regex>
        <Name>XX:MaxPermSize</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>64m</DefaultValue>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>UpperBreachScaleIncrement</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>1</DefaultValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>1</MinValue>
        <Name>MinSize</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>1</DefaultValue>
        <MaxValue>10000</MaxValue>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <Name>Custom Availability Zones</Name>
        <ValueOptions>
          <member>us-east-1a</member>
          <member>us-east-1b</member>
          <member>us-east-1c</member>
          <member>us-east-1d</member>
        </ValueOptions>
        <ValueType>List</ValueType>
        <DefaultValue>us-east-1a</DefaultValue>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <Name>Availability Zones</Name>
        <ValueOptions>
          <member>Any 1</member>
          <member>Any 2</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>Any 1</DefaultValue>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <Name>LogPublicationControl</Name>
        <ValueType>Boolean</ValueType>
        <DefaultValue>false</DefaultValue>
        <Namespace>aws:elasticbeanstalk:hostmanager</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>JVM Options</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>Notification Topic Name</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>PARAM2</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <Name>LoadBalancerHTTPPort</Name>
        <ValueOptions>
          <member>OFF</member>
          <member>80</member>
          <member>8080</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>80</DefaultValue>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>2</MinValue>
        <Name>Timeout</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>5</DefaultValue>
        <MaxValue>60</MaxValue>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>1</MinValue>
        <Name>BreachDuration</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>2</DefaultValue>
        <MaxValue>600</MaxValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <Name>MonitoringInterval</Name>
        <ValueOptions>
          <member>1 minute</member>
          <member>5 minute</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>5 minute</DefaultValue>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>PARAM1</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>1</MinValue>
        <Name>MaxSize</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>4</DefaultValue>
        <MaxValue>10000</MaxValue>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>0</MinValue>
        <Name>LowerThreshold</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>2000000</DefaultValue>
        <MaxValue>20000000</MaxValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>AWS_SECRET_KEY</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>AWS_ACCESS_KEY_ID</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>0</MinValue>
        <Name>UpperThreshold</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>6000000</DefaultValue>
        <MaxValue>20000000</MaxValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <Name>Notification Protocol</Name>
        <ValueOptions>
          <member>http</member>
          <member>https</member>
          <member>email</member>
          <member>email-json</member>
          <member>sqs</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>email</DefaultValue>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <Name>Unit</Name>
        <ValueOptions>
          <member>Seconds</member>
          <member>Percent</member>
          <member>Bytes</member>
          <member>Bits</member>
          <member>Count</member>
          <member>Bytes/Second</member>
          <member>Bits/Second</member>
          <member>Count/Second</member>
          <member>None</member>
        </ValueOptions>
        <ValueType>Scalar</ValueType>
        <DefaultValue>Bytes</DefaultValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Regex>
          <Pattern>^\S*$</Pattern>
          <Label>nospaces</Label>
        </Regex>
        <Name>Xmx</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>256m</DefaultValue>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>0</MinValue>
        <Name>Cooldown</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>360</DefaultValue>
        <MaxValue>10000</MaxValue>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>1</MinValue>
        <Name>Period</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>1</DefaultValue>
        <MaxValue>600</MaxValue>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Regex>
          <Pattern>^\S*$</Pattern>
          <Label>nospaces</Label>
        </Regex>
        <Name>Xms</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>256m</DefaultValue>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>EC2KeyName</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <Name>Stickiness Policy</Name>
        <ValueType>Boolean</ValueType>
        <DefaultValue>false</DefaultValue>
        <Namespace>aws:elb:policies</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartApplicationServer</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>PARAM3</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>NoInterruption</ChangeSeverity>
        <MinValue>2</MinValue>
        <Name>HealthyThreshold</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue>3</DefaultValue>
        <MaxValue>10</MaxValue>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <UserDefined>false</UserDefined>
        <ChangeSeverity>RestartEnvironment</ChangeSeverity>
        <MaxLength>2000</MaxLength>
        <Name>SSLCertificateId</Name>
        <ValueType>Scalar</ValueType>
        <DefaultValue/>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
    </Options>
  </DescribeConfigurationOptionsResult>
  <ResponseMetadata>
    <RequestId>e8768900-f272-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DescribeConfigurationOptionsResponse>
```

## See Also
<a name="API_DescribeConfigurationOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions) 

# DescribeConfigurationSettings
<a name="API_DescribeConfigurationSettings"></a>

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

Related Topics
+  [DeleteEnvironmentConfiguration](API_DeleteEnvironmentConfiguration.md) 

## Request Parameters
<a name="API_DescribeConfigurationSettings_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The application for the environment or configuration template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** EnvironmentName **   
The name of the environment to describe.  
 Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** TemplateName **   
The name of the configuration template to describe.  
 Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns a `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_DescribeConfigurationSettings_ResponseElements"></a>

The following element is returned by the service.

 **ConfigurationSettings.member.N**   
 A list of [ConfigurationSettingsDescription](API_ConfigurationSettingsDescription.md).   
Type: Array of [ConfigurationSettingsDescription](API_ConfigurationSettingsDescription.md) objects

## Errors
<a name="API_DescribeConfigurationSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** TooManyBuckets **   
The specified account has reached its limit of Amazon S3 buckets.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeConfigurationSettings_Examples"></a>

### Example
<a name="API_DescribeConfigurationSettings_Example_1"></a>

This example illustrates one usage of DescribeConfigurationSettings.

#### Sample Request
<a name="API_DescribeConfigurationSettings_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&TemplateName=default
&Operation=DescribeConfigurationSettings
&AuthParams
```

#### Sample Response
<a name="API_DescribeConfigurationSettings_Example_1_Response"></a>

```
<DescribeConfigurationSettingsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <DescribeConfigurationSettingsResult>
    <ConfigurationSettings>
      <member>
        <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
        <OptionSettings>
      <member>
        <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
        <OptionSettings>
          <member>
            <OptionName>ImageId</OptionName>
            <Value>ami-f2f0069b</Value>
            <Namespace>aws:autoscaling:launchconfiguration</Namespace>
          </member>
          <member>
            <OptionName>Notification Endpoint</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
          </member>
          <member>
            <OptionName>PARAM4</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
          </member>
          <member>
            <OptionName>JDBC_CONNECTION_STRING</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
          </member>
          <member>
            <OptionName>SecurityGroups</OptionName>
            <Value>elasticbeanstalk-default</Value>
            <Namespace>aws:autoscaling:launchconfiguration</Namespace>
          </member>
          <member>
            <OptionName>UnhealthyThreshold</OptionName>
            <Value>5</Value>
            <Namespace>aws:elb:healthcheck</Namespace>
          </member>
          <member>
            <OptionName>InstanceType</OptionName>
            <Value>t1.micro</Value>
            <Namespace>aws:autoscaling:launchconfiguration</Namespace>
          </member>
          <member>
            <OptionName>Statistic</OptionName>
            <Value>Average</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>LoadBalancerHTTPSPort</OptionName>
            <Value>OFF</Value>
            <Namespace>aws:elb:loadbalancer</Namespace>
          </member>
          <member>
            <OptionName>Stickiness Cookie Expiration</OptionName>
            <Value>0</Value>
            <Namespace>aws:elb:policies</Namespace>
          </member>
          <member>
            <OptionName>PARAM5</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
          </member>
          <member>
            <OptionName>MeasureName</OptionName>
            <Value>NetworkOut</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>Interval</OptionName>
            <Value>30</Value>
            <Namespace>aws:elb:healthcheck</Namespace>
          </member>
          <member>
            <OptionName>Application Healthcheck URL</OptionName>
            <Value>/</Value>
            <Namespace>aws:elasticbeanstalk:application</Namespace>
          </member>
          <member>
            <OptionName>Notification Topic ARN</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
          </member>
          <member>
            <OptionName>LowerBreachScaleIncrement</OptionName>
            <Value>-1</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>XX:MaxPermSize</OptionName>
            <Value>64m</Value>
            <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
          </member>
          <member>
            <OptionName>UpperBreachScaleIncrement</OptionName>
            <Value>1</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>MinSize</OptionName>
            <Value>1</Value>
            <Namespace>aws:autoscaling:asg</Namespace>
          </member>
          <member>
            <OptionName>Custom Availability Zones</OptionName>
            <Value>us-east-1a</Value>
            <Namespace>aws:autoscaling:asg</Namespace>
          </member>
          <member>
            <OptionName>Availability Zones</OptionName>
            <Value>Any 1</Value>
            <Namespace>aws:autoscaling:asg</Namespace>
          </member>
          <member>
            <OptionName>LogPublicationControl</OptionName>
            <Value>false</Value>
            <Namespace>aws:elasticbeanstalk:hostmanager</Namespace>
          </member>
          <member>
            <OptionName>JVM Options</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
          </member>
          <member>
            <OptionName>Notification Topic Name</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
          </member>
          <member>
            <OptionName>PARAM2</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
          </member>
          <member>
            <OptionName>LoadBalancerHTTPPort</OptionName>
            <Value>80</Value>
            <Namespace>aws:elb:loadbalancer</Namespace>
          </member>
          <member>
            <OptionName>Timeout</OptionName>
            <Value>5</Value>
            <Namespace>aws:elb:healthcheck</Namespace>
          </member>
          <member>
            <OptionName>BreachDuration</OptionName>
            <Value>2</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>MonitoringInterval</OptionName>
            <Value>5 minute</Value>
            <Namespace>aws:autoscaling:launchconfiguration</Namespace>
          </member>
          <member>
            <OptionName>PARAM1</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
          </member>
          <member>
            <OptionName>MaxSize</OptionName>
            <Value>4</Value>
            <Namespace>aws:autoscaling:asg</Namespace>
          </member>
          <member>
            <OptionName>LowerThreshold</OptionName>
            <Value>2000000</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>AWS_SECRET_KEY</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
          </member>
          <member>
            <OptionName>AWS_ACCESS_KEY_ID</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
          </member>
          <member>
            <OptionName>UpperThreshold</OptionName>
            <Value>6000000</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>Notification Protocol</OptionName>
            <Value>email</Value>
            <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
          </member>
          <member>
            <OptionName>Unit</OptionName>
            <Value>Bytes</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>Xmx</OptionName>
            <Value>256m</Value>
            <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
          </member>
          <member>
            <OptionName>Cooldown</OptionName>
            <Value>360</Value>
            <Namespace>aws:autoscaling:asg</Namespace>
          </member>
          <member>
            <OptionName>Period</OptionName>
            <Value>1</Value>
            <Namespace>aws:autoscaling:trigger</Namespace>
          </member>
          <member>
            <OptionName>Xms</OptionName>
            <Value>256m</Value>
            <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
          </member>
          <member>
            <OptionName>EC2KeyName</OptionName>
            <Value/>
            <Namespace>aws:autoscaling:launchconfiguration</Namespace>
          </member>
          <member>
            <OptionName>Stickiness Policy</OptionName>
            <Value>false</Value>
            <Namespace>aws:elb:policies</Namespace>
          </member>
          <member>
            <OptionName>PARAM3</OptionName>
            <Value/>
            <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
          </member>
          <member>
            <OptionName>HealthyThreshold</OptionName>
            <Value>3</Value>
            <Namespace>aws:elb:healthcheck</Namespace>
          </member>
          <member>
            <OptionName>SSLCertificateId</OptionName>
            <Value/>
            <Namespace>aws:elb:loadbalancer</Namespace>
          </member>
        </OptionSettings>
        <Description>Default Configuration Template</Description>
        <ApplicationName>SampleApp</ApplicationName>
        <DateCreated>2010-11-17T03:20:17.832Z</DateCreated>
        <TemplateName>Default</TemplateName>
        <DateUpdated>2010-11-17T03:20:17.832Z</DateUpdated>
      </member>
    </ConfigurationSettings>
  </DescribeConfigurationSettingsResult>
  <ResponseMetadata>
    <RequestId>4bde8884-f273-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DescribeConfigurationSettingsResponse>
```

## See Also
<a name="API_DescribeConfigurationSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings) 

# DescribeEnvironmentHealth
<a name="API_DescribeEnvironmentHealth"></a>

Returns information about the overall health of the specified environment. The **DescribeEnvironmentHealth** operation is only available with AWS Elastic Beanstalk Enhanced Health.

This action only returns information about environments that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three environments. When the user calls this action, the response will only include the one environment that the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribeEnvironmentHealth_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **AttributeNames.member.N**   
Specify the response elements to return. To retrieve all attributes, set to `All`. If no attribute names are specified, returns the name of the environment.  
Type: Array of strings  
Valid Values: `Status | Color | Causes | ApplicationMetrics | InstancesHealth | All | HealthStatus | RefreshedAt`   
Required: No

 ** EnvironmentId **   
Specify the environment by ID.  
You must specify either this or an EnvironmentName, or both.  
Type: String  
Required: No

 ** EnvironmentName **   
Specify the environment by name.  
You must specify either this or an EnvironmentName, or both.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

## Response Elements
<a name="API_DescribeEnvironmentHealth_ResponseElements"></a>

The following elements are returned by the service.

 ** ApplicationMetrics **   
Application request metrics for the environment.  
Type: [ApplicationMetrics](API_ApplicationMetrics.md) object

 **Causes.member.N**   
Descriptions of the data that contributed to the environment's current health status.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** Color **   
The [health color](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) of the environment.  
Type: String

 ** EnvironmentName **   
The environment's name.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.

 ** HealthStatus **   
The [health status](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) of the environment. For example, `Ok`.  
Type: String

 ** InstancesHealth **   
Summary health information for the instances in the environment.  
Type: [InstanceHealthSummary](API_InstanceHealthSummary.md) object

 ** RefreshedAt **   
The date and time that the health information was retrieved.  
Type: Timestamp

 ** Status **   
The environment's operational status. `Ready`, `Launching`, `Updating`, `Terminating`, or `Terminated`.  
Type: String  
Valid Values: `Green | Yellow | Red | Grey` 

## Errors
<a name="API_DescribeEnvironmentHealth_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

 ** InvalidRequest **   
One or more input parameters is not valid. Please correct the input parameters and try the operation again.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeEnvironmentHealth_Examples"></a>

### Request a single environment health attribute
<a name="API_DescribeEnvironmentHealth_Example_1"></a>

This example illustrates one usage of DescribeEnvironmentHealth.

```
DescribeEnvironmentHealth
{"EnvironmentName":"test-1","AttributeNames":["HealthStatus"]}

<DescribeEnvironmentHealthResponse xmlns='http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/'>
  <DescribeEnvironmentHealthResult>
    <HealthStatus>Degraded</HealthStatus>
    <EnvironmentName>test-1</EnvironmentName>
  </DescribeEnvironmentHealthResult>
  <ResponseMetadata>
    <RequestId>93ab63d3-3a47-11e5-94eb-3d0f44fb8967</RequestId>
  </ResponseMetadata>
</DescribeEnvironmentHealthResponse>
```

### Request all environment health attributes
<a name="API_DescribeEnvironmentHealth_Example_2"></a>

This example illustrates one usage of DescribeEnvironmentHealth.

```
DescribeEnvironmentHealth
{"EnvironmentName":"test-1","AttributeNames":["All"]}

<DescribeEnvironmentHealthResponse xmlns='http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/'>
  <DescribeEnvironmentHealthResult>
    <HealthStatus>Degraded</HealthStatus>
    <Color>Red</Color>
    <Status>Ready</Status>
    <EnvironmentName>test-1</EnvironmentName>
    <ApplicationMetrics>
      <Duration>10</Duration>
      <StatusCodes>
        <Status5xx>843</Status5xx>
        <Status4xx>0</Status4xx>
        <Status3xx>0</Status3xx>
        <Status2xx>3391</Status2xx>
      </StatusCodes>
      <Latency>
        <P90>0.002</P90>
        <P999>1.367</P999>
        <P99>0.003</P99>
        <P85>0.002</P85>
        <P50>0.001</P50>
        <P75>0.001</P75>
        <P95>0.002</P95>
        <P10>0.0</P10>
      </Latency>
      <RequestCount>4234</RequestCount>
    </ApplicationMetrics>
    <RefreshedAt>2015-08-04T01:24:34Z</RefreshedAt>
    <Causes>
      <member>19.9 % of the requests are failing with HTTP 5xx.</member>
      <member>1 instance online is below Auto Scaling group minimum size 2.</member>
    </Causes>
    <InstancesHealth>
      <Degraded>1</Degraded>
      <Pending>0</Pending>
      <Ok>0</Ok>
      <NoData>0</NoData>
      <Unknown>0</Unknown>
      <Severe>0</Severe>
      <Warning>0</Warning>
      <Info>0</Info>
    </InstancesHealth>
  </DescribeEnvironmentHealthResult>
  <ResponseMetadata>
    <RequestId>9460aa20-3a47-11e5-91c3-1f9989a744d4</RequestId>
  </ResponseMetadata>
</DescribeEnvironmentHealthResponse>
```

## See Also
<a name="API_DescribeEnvironmentHealth_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth) 

# DescribeEnvironmentManagedActionHistory
<a name="API_DescribeEnvironmentManagedActionHistory"></a>

Lists an environment's completed and failed managed actions.

## Request Parameters
<a name="API_DescribeEnvironmentManagedActionHistory_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
The environment ID of the target environment.  
Type: String  
Required: No

 ** EnvironmentName **   
The name of the target environment.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** MaxItems **   
The maximum number of items to return for a single request.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The pagination token returned by a previous request.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeEnvironmentManagedActionHistory_ResponseElements"></a>

The following elements are returned by the service.

 **ManagedActionHistoryItems.member.N**   
A list of completed and failed managed actions.  
Type: Array of [ManagedActionHistoryItem](API_ManagedActionHistoryItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.

 ** NextToken **   
A pagination token that you pass to [DescribeEnvironmentManagedActionHistory](#API_DescribeEnvironmentManagedActionHistory) to get the next page of results.  
Type: String

## Errors
<a name="API_DescribeEnvironmentManagedActionHistory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

## See Also
<a name="API_DescribeEnvironmentManagedActionHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory) 

# DescribeEnvironmentManagedActions
<a name="API_DescribeEnvironmentManagedActions"></a>

Lists an environment's upcoming and in-progress managed actions.

This action only returns information about environments that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three environments. When the user calls this action, the response will only include the one environment that the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribeEnvironmentManagedActions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
The environment ID of the target environment.  
Type: String  
Required: No

 ** EnvironmentName **   
The name of the target environment.  
Type: String  
Required: No

 ** Status **   
To show only actions with a particular status, specify a status.  
Type: String  
Valid Values: `Scheduled | Pending | Running | Unknown`   
Required: No

## Response Elements
<a name="API_DescribeEnvironmentManagedActions_ResponseElements"></a>

The following element is returned by the service.

 **ManagedActions.member.N**   
A list of upcoming and in-progress managed actions.  
Type: Array of [ManagedAction](API_ManagedAction.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.

## Errors
<a name="API_DescribeEnvironmentManagedActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

## See Also
<a name="API_DescribeEnvironmentManagedActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions) 

# DescribeEnvironmentResources
<a name="API_DescribeEnvironmentResources"></a>

Returns AWS resources for this environment.

## Request Parameters
<a name="API_DescribeEnvironmentResources_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
The ID of the environment to retrieve AWS resource usage data.  
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Required: No

 ** EnvironmentName **   
The name of the environment to retrieve AWS resource usage data.  
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

## Response Elements
<a name="API_DescribeEnvironmentResources_ResponseElements"></a>

The following element is returned by the service.

 ** EnvironmentResources **   
 A list of [EnvironmentResourceDescription](API_EnvironmentResourceDescription.md).   
Type: [EnvironmentResourceDescription](API_EnvironmentResourceDescription.md) object

## Errors
<a name="API_DescribeEnvironmentResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## Examples
<a name="API_DescribeEnvironmentResources_Examples"></a>

### Example
<a name="API_DescribeEnvironmentResources_Example_1"></a>

This example illustrates one usage of DescribeEnvironmentResources.

#### Sample Request
<a name="API_DescribeEnvironmentResources_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-hc8mvnayrx
&EnvironmentName=SampleAppVersion
&Operation=DescribeEnvironmentResources
&AuthParams
```

#### Sample Response
<a name="API_DescribeEnvironmentResources_Example_1_Response"></a>

```
<DescribeEnvironmentResourcesResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <DescribeEnvironmentResourcesResult>
    <EnvironmentResources>
      <LoadBalancers>
        <member>
          <Name>elasticbeanstalk-SampleAppVersion</Name>
        </member>
      </LoadBalancers>
      <LaunchConfigurations>
        <member>
          <Name>elasticbeanstalk-SampleAppVersion-hbAc8cSZH7</Name>
        </member>
      </LaunchConfigurations>
      <LaunchTemplates>
      </LaunchTemplates>
      <AutoScalingGroups>
        <member>
          <Name>elasticbeanstalk-SampleAppVersion-us-east-1c</Name>
        </member>
      </AutoScalingGroups>
      <EnvironmentName>SampleAppVersion</EnvironmentName>
      <Triggers>
        <member>
          <Name>elasticbeanstalk-SampleAppVersion-us-east-1c</Name>
        </member>
      </Triggers>
      <Instances/>
    </EnvironmentResources>
  </DescribeEnvironmentResourcesResult>
  <ResponseMetadata>
    <RequestId>e1cb7b96-f287-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DescribeEnvironmentResourcesResponse>
```

## See Also
<a name="API_DescribeEnvironmentResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources) 

# DescribeEnvironments
<a name="API_DescribeEnvironments"></a>

Returns descriptions for existing environments.

This action only returns information about environments that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three environments. When the user calls the *DescribeEnvironments* action, the response will only include the one environment that the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribeEnvironments_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 **EnvironmentIds.member.N**   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.  
Type: Array of strings  
Required: No

 **EnvironmentNames.member.N**   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.  
Type: Array of strings  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** IncludedDeletedBackTo **   
 If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.   
Type: Timestamp  
Required: No

 ** IncludeDeleted **   
Indicates whether to include deleted environments:  
 `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.  
 `false`: Do not include deleted environments.  
Type: Boolean  
Required: No

 ** MaxRecords **   
For a paginated request. Specify a maximum number of environments to include in each response.  
If no `MaxRecords` is specified, all available environments are retrieved in a single response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** NextToken **   
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.  
If no `NextToken` is specified, the first page is retrieved.  
Type: String  
Required: No

 ** VersionLabel **   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_DescribeEnvironments_ResponseElements"></a>

The following elements are returned by the service.

 **Environments.member.N**   
 Returns an [EnvironmentDescription](API_EnvironmentDescription.md) list.   
Type: Array of [EnvironmentDescription](API_EnvironmentDescription.md) objects

 ** NextToken **   
In a paginated request, the token that you can pass in a subsequent request to get the next response page.  
Type: String

## Errors
<a name="API_DescribeEnvironments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeEnvironments_Examples"></a>

### Example
<a name="API_DescribeEnvironments_Example_1"></a>

This example illustrates one usage of DescribeEnvironments.

#### Sample Request
<a name="API_DescribeEnvironments_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&IncludeDeleted=true
&IncludedDeletedBackTo=2008-11-05T06%3A00%3A00Z
&Operation=DescribeEnvironments
&AuthParams
```

#### Sample Response
<a name="API_DescribeEnvironments_Example_1_Response"></a>

```
<DescribeEnvironmentsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <DescribeEnvironmentsResult>
    <Environments>
      <member>
        <VersionLabel>Version1</VersionLabel>
        <Status>Available</Status>
        <ApplicationName>SampleApp</ApplicationName>
        <EndpointURL>elasticbeanstalk-SampleApp-1394386994.us-east-1.elb.amazonaws.com</EndpointURL>
        <CNAME>SampleApp-jxb293wg7n.elasticbeanstalk.amazonaws.com</CNAME>
        <Health>Green</Health>
        <EnvironmentId>e-icsgecu3wf</EnvironmentId>
        <DateUpdated>2010-11-17T04:01:40.668Z</DateUpdated>
        <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
        <Description>EnvDescrip</Description>
        <EnvironmentName>SampleApp</EnvironmentName>
        <DateCreated>2010-11-17T03:59:33.520Z</DateCreated>
      </member>
    </Environments>
  </DescribeEnvironmentsResult>
  <ResponseMetadata>
    <RequestId>44790c68-f260-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DescribeEnvironmentsResponse>
```

## See Also
<a name="API_DescribeEnvironments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeEnvironments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeEnvironments) 

# DescribeEvents
<a name="API_DescribeEvents"></a>

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified `NextToken`.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribeEvents_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** EndTime **   
 If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the `EndTime`.   
Type: Timestamp  
Required: No

 ** EnvironmentId **   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.  
Type: String  
Required: No

 ** EnvironmentName **   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** MaxRecords **   
Specifies the maximum number of events that can be returned, beginning with the most recent event.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** NextToken **   
Pagination token. If specified, the events return the next batch of results.  
Type: String  
Required: No

 ** PlatformArn **   
The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.  
Type: String  
Required: No

 ** RequestId **   
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.  
Type: String  
Required: No

 ** Severity **   
If specified, limits the events returned from this call to include only those with the specified severity or higher.  
Type: String  
Valid Values: `TRACE | DEBUG | INFO | WARN | ERROR | FATAL`   
Required: No

 ** StartTime **   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.  
Type: Timestamp  
Required: No

 ** TemplateName **   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** VersionLabel **   
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_DescribeEvents_ResponseElements"></a>

The following elements are returned by the service.

 **Events.member.N**   
 A list of [EventDescription](API_EventDescription.md).   
Type: Array of [EventDescription](API_EventDescription.md) objects

 ** NextToken **   
 If returned, this indicates that there are more results to obtain. Use this token in the next [DescribeEvents](#API_DescribeEvents) call to get the next batch of events.   
Type: String

## Errors
<a name="API_DescribeEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeEvents_Examples"></a>

### Example
<a name="API_DescribeEvents_Example_1"></a>

This example illustrates one usage of DescribeEvents.

#### Sample Request
<a name="API_DescribeEvents_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&Severity=TRACE
&StartTime=2010-11-17T10%3A26%3A40Z
&Operation=DescribeEvents
&AuthParams
```

#### Sample Response
<a name="API_DescribeEvents_Example_1_Response"></a>

```
          <DescribeEventsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <DescribeEventsResult>
    <Events>
      <member>
        <Message>Successfully completed createEnvironment activity.</Message>
        <EventDate>2010-11-17T20:25:35.191Z</EventDate>
        <VersionLabel>New Version</VersionLabel>
        <RequestId>bb01fa74-f287-11df-8a78-9f77047e0d0c</RequestId>
        <ApplicationName>SampleApp</ApplicationName>
        <EnvironmentName>SampleAppVersion</EnvironmentName>
        <Severity>INFO</Severity>
      </member>
      <member>
        <Message>Launching a new EC2 instance: i-04a8c569</Message>
        <EventDate>2010-11-17T20:21:30Z</EventDate>
        <VersionLabel>New Version</VersionLabel>
        <ApplicationName>SampleApp</ApplicationName>
        <EnvironmentName>SampleAppVersion</EnvironmentName>
        <Severity>DEBUG</Severity>
      </member>
      <member>
        <Message>At least one EC2 instance has entered the InService lifecycle state.</Message>
        <EventDate>2010-11-17T20:20:32.008Z</EventDate>
        <VersionLabel>New Version</VersionLabel>
        <RequestId>bb01fa74-f287-11df-8a78-9f77047e0d0c</RequestId>
        <ApplicationName>SampleApp</ApplicationName>
        <EnvironmentName>SampleAppVersion</EnvironmentName>
        <Severity>INFO</Severity>
      </member>
      <member>
        <Message>Elastic Load Balancer elasticbeanstalk-SampleAppVersion has failed 0 healthy instances - Environment may not be available.</Message>
        <EventDate>2010-11-17T20:19:28Z</EventDate>
        <VersionLabel>New Version</VersionLabel>
        <ApplicationName>SampleApp</ApplicationName>
        <EnvironmentName>SampleAppVersion</EnvironmentName>
        <Severity>WARN</Severity>
      </member>
    </Events>
  </DescribeEventsResult>
  <ResponseMetadata>
    <RequestId>f10d02dd-f288-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</DescribeEventsResponse>
```

## See Also
<a name="API_DescribeEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeEvents) 

# DescribeInstancesHealth
<a name="API_DescribeInstancesHealth"></a>

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk environments. This operation requires [enhanced health reporting](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html).

This action only returns information about environments that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three environments. When the user calls this action, the response will only include the one environment that the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribeInstancesHealth_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **AttributeNames.member.N**   
Specifies the response elements you wish to receive. To retrieve all attributes, set to `All`. If no attribute names are specified, returns a list of instances.  
Type: Array of strings  
Valid Values: `HealthStatus | Color | Causes | ApplicationMetrics | RefreshedAt | LaunchedAt | System | Deployment | AvailabilityZone | InstanceType | All`   
Required: No

 ** EnvironmentId **   
Specify the AWS Elastic Beanstalk environment by ID.  
Type: String  
Required: No

 ** EnvironmentName **   
Specify the AWS Elastic Beanstalk environment by name.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** NextToken **   
Specify the pagination token returned by a previous call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_DescribeInstancesHealth_ResponseElements"></a>

The following elements are returned by the service.

 **InstanceHealthList.member.N**   
Detailed health information about each instance.  
The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the `<CPUUtilization>` type.  
Type: Array of [SingleInstanceHealth](API_SingleInstanceHealth.md) objects

 ** NextToken **   
Pagination token for the next page of results, if available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** RefreshedAt **   
The date and time that the health information was retrieved.  
Type: Timestamp

## Errors
<a name="API_DescribeInstancesHealth_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

 ** InvalidRequest **   
One or more input parameters is not valid. Please correct the input parameters and try the operation again.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeInstancesHealth_Examples"></a>

### Request a single instance health attribute
<a name="API_DescribeInstancesHealth_Example_1"></a>

This example illustrates one usage of DescribeInstancesHealth.

```
DescribeInstancesHealth
{"EnvironmentName":"test-1","AttributeNames":["HealthStatus"]}

<DescribeInstancesHealthResponse xmlns='http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/'>
  <DescribeInstancesHealthResult>
    <InstanceHealthList>
      <member>
        <HealthStatus>Degraded</HealthStatus>
        <InstanceId>i-dc6ee922</InstanceId>
      </member>
    </InstanceHealthList>
  </DescribeInstancesHealthResult>
  <ResponseMetadata>
    <RequestId>94808e26-3a47-11e5-94eb-3d0f44fb8967</RequestId>
  </ResponseMetadata>
</DescribeInstancesHealthResponse>
```

### Request all instance health attributes for a Linux environment
<a name="API_DescribeInstancesHealth_Example_2"></a>

This example shows the output for a Linux environment.

```
DescribeInstancesHealth
{"EnvironmentName":"test-1","AttributeNames":["All"]}

<DescribeInstancesHealthResponse xmlns='http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/'>
  <DescribeInstancesHealthResult>
    <InstanceHealthList>
      <member>
        <HealthStatus>Degraded</HealthStatus>
        <System>
          <CPUUtilization>
            <Idle>6.9</Idle>
            <System>46.2</System>
            <Privileged>null</Privileged>
            <SoftIRQ>0.6</SoftIRQ>
            <Nice>0.0</Nice>
            <IOWait>0.1</IOWait>
            <User>46.2</User>
            <IRQ>0.0</IRQ>
          </CPUUtilization>
          <LoadAverage>
            <member>3.81</member>
            <member>2.11</member>
            <member>0.93</member>
          </LoadAverage>
        </System>
        <LaunchedAt>2015-07-17T07:58:58Z</LaunchedAt>
        <Color>Red</Color>
        <InstanceId>i-dc6ee922</InstanceId>
        <ApplicationMetrics>
          <Duration>10</Duration>
          <StatusCodes>
            <Status5xx>843</Status5xx>
            <Status4xx>0</Status4xx>
            <Status3xx>0</Status3xx>
            <Status2xx>3391</Status2xx>
          </StatusCodes>
          <Latency>
            <P90>0.002</P90>
            <P999>1.367</P999>
            <P99>0.003</P99>
            <P85>0.002</P85>
            <P50>0.001</P50>
            <P75>0.001</P75>
            <P95>0.002</P95>
            <P10>0.0</P10>
          </Latency>
          <RequestCount>4234</RequestCount>
        </ApplicationMetrics>
        <Causes>
          <member>19.9 % of the requests are failing with HTTP 5xx.</member>
          <member>93 % of CPU is in use.</member>
        </Causes>
      </member>
    </InstanceHealthList>
    <RefreshedAt>2015-08-04T01:24:34Z</RefreshedAt>
  </DescribeInstancesHealthResult>
  <ResponseMetadata>
    <RequestId>94a07242-3a47-11e5-91c3-1f9989a744d4</RequestId>
  </ResponseMetadata>
</DescribeInstancesHealthResponse>
```

### Request all instance health attributes for a Windows environment
<a name="API_DescribeInstancesHealth_Example_3"></a>

In a Windows environment, there are different supported members in the `<CPUUtilization>` type:

```
        ...
          <CPUUtilization>
            <Idle>9.6</Idle>
            <System>null</System>
            <Privileged>45.2</Privileged>
            <SoftIRQ>null</SoftIRQ>
            <Nice>null</Nice>
            <IOWait>null</IOWait>
            <User>45.2</User>
            <IRQ>null</IRQ>
          </CPUUtilization>
        ...
```

## See Also
<a name="API_DescribeInstancesHealth_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribeInstancesHealth) 

# DescribePlatformVersion
<a name="API_DescribePlatformVersion"></a>

Describes a platform version. Provides full details. Compare to [ListPlatformVersions](API_ListPlatformVersions.md), which provides summary information about a list of platform versions.

For definitions of platform version and other platform-related terms, see [AWS Elastic Beanstalk Platforms Glossary](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html).

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_DescribePlatformVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** PlatformArn **   
The ARN of the platform version.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribePlatformVersion_ResponseElements"></a>

The following element is returned by the service.

 ** PlatformDescription **   
Detailed information about the platform version.  
Type: [PlatformDescription](API_PlatformDescription.md) object

## Errors
<a name="API_DescribePlatformVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## See Also
<a name="API_DescribePlatformVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DescribePlatformVersion) 

# DisassociateEnvironmentOperationsRole
<a name="API_DisassociateEnvironmentOperationsRole"></a>

**Important**  
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.

Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment.

## Request Parameters
<a name="API_DisassociateEnvironmentOperationsRole_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentName **   
The name of the environment from which to disassociate the operations role.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: Yes

## Errors
<a name="API_DisassociateEnvironmentOperationsRole_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## Examples
<a name="API_DisassociateEnvironmentOperationsRole_Examples"></a>

### Example
<a name="API_DisassociateEnvironmentOperationsRole_Example_1"></a>

This example illustrates one usage of DisassociateEnvironmentOperationsRole.

#### Sample Request
<a name="API_DisassociateEnvironmentOperationsRole_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentName=MyEnv
&Operation=DisassociateEnvironmentOperationsRole
&AuthParams
```

#### Sample Response
<a name="API_DisassociateEnvironmentOperationsRole_Example_1_Response"></a>

```
<DisassociateEnvironmentOperationsRoleResponse xmlns="http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>f4e1b145-9080-11e0-8e5a-a558e0ce1fc4</RequestId>
  </ResponseMetadata>
</DisassociateEnvironmentOperationsRoleResponse>
```

## See Also
<a name="API_DisassociateEnvironmentOperationsRole_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole) 

# ListAvailableSolutionStacks
<a name="API_ListAvailableSolutionStacks"></a>

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Response Elements
<a name="API_ListAvailableSolutionStacks_ResponseElements"></a>

The following elements are returned by the service.

 **SolutionStackDetails.member.N**   
 A list of available solution stacks and their [SolutionStackDescription](API_SolutionStackDescription.md).   
Type: Array of [SolutionStackDescription](API_SolutionStackDescription.md) objects

 **SolutionStacks.member.N**   
A list of available solution stacks.  
Type: Array of strings

## Errors
<a name="API_ListAvailableSolutionStacks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ListAvailableSolutionStacks_Examples"></a>

### Example
<a name="API_ListAvailableSolutionStacks_Example_1"></a>

This example illustrates one usage of ListAvailableSolutionStacks.

#### Sample Request
<a name="API_ListAvailableSolutionStacks_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?Operation=ListAvailableSolutionStacks
&AuthParams
```

#### Sample Response
<a name="API_ListAvailableSolutionStacks_Example_1_Response"></a>

```
<ListAvailableSolutionStacksResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ListAvailableSolutionStacksResult>
    <SolutionStacks>
      <member>64bit Amazon Linux running Tomcat 6</member>
      <member>32bit Amazon Linux running Tomcat 6</member>
      <member>64bit Amazon Linux running Tomcat 7</member>
      <member>32bit Amazon Linux running Tomcat 7</member>
    </SolutionStacks>
  </ListAvailableSolutionStacksResult>
  <ResponseMetadata>
    <RequestId>f21e2a92-f1fc-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</ListAvailableSolutionStacksResponse>
```

## See Also
<a name="API_ListAvailableSolutionStacks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks) 

# ListPlatformBranches
<a name="API_ListPlatformBranches"></a>

Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.

For definitions of platform branch and other platform-related terms, see [AWS Elastic Beanstalk Platforms Glossary](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html).

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_ListPlatformBranches_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.member.N**   
Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate `SearchFilter` terms.  
The following list shows valid attribute values for each of the `SearchFilter` terms. Most operators take a single value. The `in` and `not_in` operators can take multiple values.  
+  `Attribute = BranchName`:
  +  `Operator`: `=` \$1 `!=` \$1 `begins_with` \$1 `ends_with` \$1 `contains` \$1 `in` \$1 `not_in` 
+  `Attribute = LifecycleState`:
  +  `Operator`: `=` \$1 `!=` \$1 `in` \$1 `not_in` 
  +  `Values`: `beta` \$1 `supported` \$1 `deprecated` \$1 `retired` 
+  `Attribute = PlatformName`:
  +  `Operator`: `=` \$1 `!=` \$1 `begins_with` \$1 `ends_with` \$1 `contains` \$1 `in` \$1 `not_in` 
+  `Attribute = TierType`:
  +  `Operator`: `=` \$1 `!=` 
  +  `Values`: `WebServer/Standard` \$1 `Worker/SQS/HTTP` 
Array size: limited to 10 `SearchFilter` objects.  
Within each `SearchFilter` item, the `Values` array is limited to 10 items.  
Type: Array of [SearchFilter](API_SearchFilter.md) objects  
Required: No

 ** MaxRecords **   
The maximum number of platform branch values returned in one call.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.  
If no `NextToken` is specified, the first page is retrieved.  
Type: String  
Required: No

## Response Elements
<a name="API_ListPlatformBranches_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
In a paginated request, if this value isn't `null`, it's the token that you can pass in a subsequent request to get the next response page.  
Type: String

 **PlatformBranchSummaryList.member.N**   
Summary information about the platform branches.  
Type: Array of [PlatformBranchSummary](API_PlatformBranchSummary.md) objects

## Errors
<a name="API_ListPlatformBranches_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ListPlatformBranches_Examples"></a>

The following example requests the list of PHP platform branches that are in the Normal Maintenance state.

The request has some URL-encoded characters. `%3D` is the equals sign (`=`), and `%20` is the space character.

### Example
<a name="API_ListPlatformBranches_Example_1"></a>

This example illustrates one usage of ListPlatformBranches.

#### Sample Request
<a name="API_ListPlatformBranches_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?Filters.member.1.Attribute=PlatformName
&Filters.member.1.Operator=%3D
&Filters.member.1.Values.member.1=PHP
&Filters.member.1.Attribute=LifecycleState
&Filters.member.1.Operator=%3D
&Filters.member.1.Values.member.1=Supported
&Operation=ListPlatformBranches
&AuthParams
```

#### Sample Response
<a name="API_ListPlatformBranches_Example_1_Response"></a>

```
<ListPlatformBranches xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ListPlatformBranchesResult>
    <PlatformBranchSummaryList>
      <member>
        <BranchName>PHP 7.3</BranchName>
        <LifecycleState>Supported</BranchName>
        <PlatformName>PHP</BranchName>
      </member>
      <member>
        <BranchName>PHP 7.2</BranchName>
        <LifecycleState>Supported</BranchName>
        <PlatformName>PHP</BranchName>
      </member>
    </PlatformBranchSummaryList>
  </ListPlatformBranchesResult>
  <ResponseMetadata>
    <RequestId>7705f0bc-f28e-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</ListPlatformBranchesResponse>
```

## See Also
<a name="API_ListPlatformBranches_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/ListPlatformBranches) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/ListPlatformBranches) 

# ListPlatformVersions
<a name="API_ListPlatformVersions"></a>

Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to [DescribePlatformVersion](API_DescribePlatformVersion.md), which provides full details about a single platform version.

This action only returns information about platform versions that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of ten platform versions. When the user calls the *ListPlatformVersions* action, the response will only include the one platform version that the user has permission to access instead of all ten platform versions. If the user doesn’t have access to any of the platform versions an empty result is returned.

**Note**  
The *AWSElasticBeanstalkReadOnly* managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

For definitions of platform version and other platform-related terms, see [AWS Elastic Beanstalk Platforms Glossary](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html).

## Request Parameters
<a name="API_ListPlatformVersions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.member.N**   
Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate `PlatformFilter` terms.  
Type: Array of [PlatformFilter](API_PlatformFilter.md) objects  
Required: No

 ** MaxRecords **   
The maximum number of platform version values returned in one call.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NextToken **   
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.  
If no `NextToken` is specified, the first page is retrieved.  
Type: String  
Required: No

## Response Elements
<a name="API_ListPlatformVersions_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
In a paginated request, if this value isn't `null`, it's the token that you can pass in a subsequent request to get the next response page.  
Type: String

 **PlatformSummaryList.member.N**   
Summary information about the platform versions.  
Type: Array of [PlatformSummary](API_PlatformSummary.md) objects

## Errors
<a name="API_ListPlatformVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ElasticBeanstalkService **   
A generic service exception has occurred.    
 ** message **   
The exception error message.
HTTP Status Code: 400

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## See Also
<a name="API_ListPlatformVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/ListPlatformVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/ListPlatformVersions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see [Tagging Application Resources](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html).

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

**Note**  
The [AWSElasticBeanstalkReadOnly](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html) managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see [ Managing Elastic Beanstalk user policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html) in the * AWS Elastic Beanstalk Developer Guide*. For detailed instructions to attach a policy to a user or group, see the section [ Controlling access with managed policies](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed) in the same topic.

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceArn **   
The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.  
Must be the ARN of an Elastic Beanstalk resource.  
Type: String  
Required: Yes

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

The following elements are returned by the service.

 ** ResourceArn **   
The Amazon Resource Name (ARN) of the resource for which a tag list was requested.  
Type: String

 **ResourceTags.member.N**   
A list of tag key-value pairs.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** ResourceNotFound **   
A resource doesn't exist for the specified Amazon Resource Name (ARN).  
HTTP Status Code: 400

 ** ResourceTypeNotSupported **   
The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/ListTagsForResource) 

# RebuildEnvironment
<a name="API_RebuildEnvironment"></a>

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

## Request Parameters
<a name="API_RebuildEnvironment_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
The ID of the environment to rebuild.  
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Required: No

 ** EnvironmentName **   
The name of the environment to rebuild.  
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

## Errors
<a name="API_RebuildEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## Examples
<a name="API_RebuildEnvironment_Examples"></a>

### Example
<a name="API_RebuildEnvironment_Example_1"></a>

This example illustrates one usage of RebuildEnvironment.

#### Sample Request
<a name="API_RebuildEnvironment_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-hc8mvnayrx
&EnvironmentName=SampleAppVersion
&Operation=RebuildEnvironment
&AuthParams
```

#### Sample Response
<a name="API_RebuildEnvironment_Example_1_Response"></a>

```
<RebuildEnvironmentResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>a7d6606e-f289-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</RebuildEnvironmentResponse>
```

## See Also
<a name="API_RebuildEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/RebuildEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/RebuildEnvironment) 

# RequestEnvironmentInfo
<a name="API_RequestEnvironmentInfo"></a>

Initiates a request to compile the specified type of information of the deployed environment.

 Setting the `InfoType` to `tail` compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. 

 Setting the `InfoType` to `bundle` compresses the application server log files for every Amazon EC2 instance into a `.zip` file. Legacy and .NET containers do not support bundle logs. 

 Use [RetrieveEnvironmentInfo](API_RetrieveEnvironmentInfo.md) to obtain the set of logs. 

Related Topics
+  [RetrieveEnvironmentInfo](API_RetrieveEnvironmentInfo.md) 

## Request Parameters
<a name="API_RequestEnvironmentInfo_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
The ID of the environment of the requested data.  
If no such environment is found, `RequestEnvironmentInfo` returns an `InvalidParameterValue` error.   
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Required: No

 ** EnvironmentName **   
The name of the environment of the requested data.  
If no such environment is found, `RequestEnvironmentInfo` returns an `InvalidParameterValue` error.   
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** InfoType **   
The type of information to request.  
Type: String  
Valid Values: `tail | bundle`   
Required: Yes

## Errors
<a name="API_RequestEnvironmentInfo_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_RequestEnvironmentInfo_Examples"></a>

### Example
<a name="API_RequestEnvironmentInfo_Example_1"></a>

This example illustrates one usage of RequestEnvironmentInfo.

#### Sample Request
<a name="API_RequestEnvironmentInfo_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-hc8mvnayrx
&EnvironmentName=SampleAppVersion
&InfoType=tail
&Operation=RequestEnvironmentInfo
&AuthParams
```

#### Sample Response
<a name="API_RequestEnvironmentInfo_Example_1_Response"></a>

```
<RequestEnvironmentInfoResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>126a4ff3-f28a-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</RequestEnvironmentInfoResponse>
```

## See Also
<a name="API_RequestEnvironmentInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo) 

# RestartAppServer
<a name="API_RestartAppServer"></a>

Causes the environment to restart the application container server running on each Amazon EC2 instance.

## Request Parameters
<a name="API_RestartAppServer_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
The ID of the environment to restart the server for.  
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Required: No

 ** EnvironmentName **   
The name of the environment to restart the server for.  
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

## Errors
<a name="API_RestartAppServer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_RestartAppServer_Examples"></a>

### Example
<a name="API_RestartAppServer_Example_1"></a>

This example illustrates one usage of RestartAppServer.

#### Sample Request
<a name="API_RestartAppServer_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-hc8mvnayrx
&EnvironmentName=SampleAppVersion
&Operation=RestartAppServer
&AuthParams
```

#### Sample Response
<a name="API_RestartAppServer_Example_1_Response"></a>

```
<RestartAppServerResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>90e8d1d5-f28a-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</RestartAppServerResponse>
```

## See Also
<a name="API_RestartAppServer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/RestartAppServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/RestartAppServer) 

# RetrieveEnvironmentInfo
<a name="API_RetrieveEnvironmentInfo"></a>

Retrieves the compiled information from a [RequestEnvironmentInfo](API_RequestEnvironmentInfo.md) request.

Related Topics
+  [RequestEnvironmentInfo](API_RequestEnvironmentInfo.md) 

## Request Parameters
<a name="API_RetrieveEnvironmentInfo_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
The ID of the data's environment.  
If no such environment is found, returns an `InvalidParameterValue` error.  
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.  
Type: String  
Required: No

 ** EnvironmentName **   
The name of the data's environment.  
 If no such environment is found, returns an `InvalidParameterValue` error.   
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** InfoType **   
The type of information to retrieve.  
Type: String  
Valid Values: `tail | bundle`   
Required: Yes

## Response Elements
<a name="API_RetrieveEnvironmentInfo_ResponseElements"></a>

The following element is returned by the service.

 **EnvironmentInfo.member.N**   
 The [EnvironmentInfoDescription](API_EnvironmentInfoDescription.md) of the environment.   
Type: Array of [EnvironmentInfoDescription](API_EnvironmentInfoDescription.md) objects

## Errors
<a name="API_RetrieveEnvironmentInfo_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_RetrieveEnvironmentInfo_Examples"></a>

### Example
<a name="API_RetrieveEnvironmentInfo_Example_1"></a>

This example illustrates one usage of RetrieveEnvironmentInfo.

#### Sample Request
<a name="API_RetrieveEnvironmentInfo_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-hc8mvnayrx
&EnvironmentName=SampleAppVersion
&InfoType=tail
&Operation=RetrieveEnvironmentInfo
&AuthParams
```

#### Sample Response
<a name="API_RetrieveEnvironmentInfo_Example_1_Response"></a>

```
<RetrieveEnvironmentInfoResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <RetrieveEnvironmentInfoResult>
    <EnvironmentInfo>
      <member>
        <Message>
         https://elasticbeanstalk.us-east-1.s3.amazonaws.com/environments%2Fa514386a-709f-4888-9683-068c38d744b4%2Flogs%2Fi-92a3ceff%2F278756a8-7d83-4bc1-93db-b1763163705a.log?Expires=1291236023
         &AuthParams
        </Message>
        <SampleTimestamp>2010-11-17T20:40:23.210Z</SampleTimestamp>
        <InfoType>tail</InfoType>
        <Ec2InstanceId>i-92a3ceff</Ec2InstanceId>
      </member>
    </EnvironmentInfo>
  </RetrieveEnvironmentInfoResult>
  <ResponseMetadata>
    <RequestId>e8e785c9-f28a-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</RetrieveEnvironmentInfoResponse>
```

## See Also
<a name="API_RetrieveEnvironmentInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo) 

# SwapEnvironmentCNAMEs
<a name="API_SwapEnvironmentCNAMEs"></a>

Swaps the CNAMEs of two environments.

## Request Parameters
<a name="API_SwapEnvironmentCNAMEs_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DestinationEnvironmentId **   
The ID of the destination environment.  
 Condition: You must specify at least the `DestinationEnvironmentID` or the `DestinationEnvironmentName`. You may also specify both. You must specify the `SourceEnvironmentId` with the `DestinationEnvironmentId`.   
Type: String  
Required: No

 ** DestinationEnvironmentName **   
The name of the destination environment.  
 Condition: You must specify at least the `DestinationEnvironmentID` or the `DestinationEnvironmentName`. You may also specify both. You must specify the `SourceEnvironmentName` with the `DestinationEnvironmentName`.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** SourceEnvironmentId **   
The ID of the source environment.  
 Condition: You must specify at least the `SourceEnvironmentID` or the `SourceEnvironmentName`. You may also specify both. If you specify the `SourceEnvironmentId`, you must specify the `DestinationEnvironmentId`.   
Type: String  
Required: No

 ** SourceEnvironmentName **   
The name of the source environment.  
 Condition: You must specify at least the `SourceEnvironmentID` or the `SourceEnvironmentName`. You may also specify both. If you specify the `SourceEnvironmentName`, you must specify the `DestinationEnvironmentName`.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

## Errors
<a name="API_SwapEnvironmentCNAMEs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_SwapEnvironmentCNAMEs_Examples"></a>

### Example
<a name="API_SwapEnvironmentCNAMEs_Example_1"></a>

This example illustrates one usage of SwapEnvironmentCNAMEs.

#### Sample Request
<a name="API_SwapEnvironmentCNAMEs_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?SourceEnvironmentName=SampleApp
&DestinationEnvironmentName=SampleApp2
&Operation=SwapEnvironmentCNAMEs
&AuthParams
```

#### Sample Response
<a name="API_SwapEnvironmentCNAMEs_Example_1_Response"></a>

```
<SwapEnvironmentCNAMEsResponse xmlns="http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>f4e1b145-9080-11e0-8e5a-a558e0ce1fc4</RequestId>
  </ResponseMetadata>
</SwapEnvironmentCNAMEsResponse>
```

## See Also
<a name="API_SwapEnvironmentCNAMEs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs) 

# TerminateEnvironment
<a name="API_TerminateEnvironment"></a>

Terminates the specified environment.

## Request Parameters
<a name="API_TerminateEnvironment_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnvironmentId **   
The ID of the environment to terminate.  
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Required: No

 ** EnvironmentName **   
The name of the environment to terminate.  
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** ForceTerminate **   
Terminates the target environment even if another environment in the same group is dependent on it.  
Type: Boolean  
Required: No

 ** TerminateResources **   
Indicates whether the associated AWS resources should shut down when the environment is terminated:  
+  `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
+  `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
 For more information, see the [AWS Elastic Beanstalk User Guide. ](https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/)   
 Default: `true`   
 Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

## Response Elements
<a name="API_TerminateEnvironment_ResponseElements"></a>

The following elements are returned by the service.

 ** AbortableOperationInProgress **   
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.  
 `true:` There is an update in progress.   
 `false:` There are no updates currently in progress.   
Type: Boolean

 ** ApplicationName **   
The name of the application associated with this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** CNAME **   
The URL to the CNAME for this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** DateCreated **   
The creation date for this environment.  
Type: Timestamp

 ** DateUpdated **   
The last modified date for this environment.  
Type: Timestamp

 ** Description **   
Describes this environment.  
Type: String  
Length Constraints: Maximum length of 200.

 ** EndpointURL **   
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.  
Type: String

 ** EnvironmentArn **   
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.  
Type: String

 ** EnvironmentId **   
The ID of this environment.  
Type: String

 **EnvironmentLinks.member.N**   
A list of links to other environments in the same group.  
Type: Array of [EnvironmentLink](API_EnvironmentLink.md) objects

 ** EnvironmentName **   
The name of this environment.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.

 ** Health **   
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:  
+  `Red`: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
+  `Yellow`: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
+  `Green`: Indicates the environment is healthy and fully functional.
+  `Grey`: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an `UpdateEnvironment` or `RestartEnvironment` request.
 Default: `Grey`   
Type: String  
Valid Values: `Green | Yellow | Red | Grey` 

 ** HealthStatus **   
Returns the health status of the application running in your environment. For more information, see [Health Colors and Statuses](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html).  
Type: String  
Valid Values: `NoData | Unknown | Pending | Ok | Info | Warning | Degraded | Severe | Suspended` 

 ** OperationsRole **   
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
The Amazon Resource Name (ARN) of the environment's operations role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** PlatformArn **   
The ARN of the platform version.  
Type: String

 ** Resources **   
The description of the AWS resources used by this environment.  
Type: [EnvironmentResourcesDescription](API_EnvironmentResourcesDescription.md) object

 ** SolutionStackName **   
 The name of the `SolutionStack` deployed with this environment.   
Type: String

 ** Status **   
The current operational status of the environment:  
+  `Aborting`: Environment is in the process of aborting a deployment.
+  `Launching`: Environment is in the process of initial deployment.
+  `LinkingFrom`: Environment is in the process of being linked to by another environment. See [Environment links](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html) for details.
+  `LinkingTo`: Environment is in the process of linking to another environment. See [Environment links](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html) for details.
+  `Updating`: Environment is in the process of updating its configuration settings or application version.
+  `Ready`: Environment is available to have an action performed on it, such as update or terminate.
+  `Terminating`: Environment is in the shut-down process.
+  `Terminated`: Environment is not running.
Type: String  
Valid Values: `Aborting | Launching | Updating | LinkingFrom | LinkingTo | Ready | Terminating | Terminated` 

 ** TemplateName **   
The name of the configuration template used to originally launch this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** Tier **   
Describes the current tier of this environment.  
Type: [EnvironmentTier](API_EnvironmentTier.md) object

 ** VersionLabel **   
The application version deployed in this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_TerminateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## Examples
<a name="API_TerminateEnvironment_Examples"></a>

### Example
<a name="API_TerminateEnvironment_Example_1"></a>

This example illustrates one usage of TerminateEnvironment.

#### Sample Request
<a name="API_TerminateEnvironment_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-icsgecu3wf
&EnvironmentName=SampleApp
&TerminateResources=true
&Operation=TerminateEnvironment
&AuthParams
```

#### Sample Response
<a name="API_TerminateEnvironment_Example_1_Response"></a>

```
<TerminateEnvironmentResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <TerminateEnvironmentResult>
    <VersionLabel>Version1</VersionLabel>
    <Status>Terminating</Status>
    <ApplicationName>SampleApp</ApplicationName>
    <EndpointURL>elasticbeanstalk-SampleApp-1394386994.us-east-1.elb.amazonaws.com</EndpointURL>
    <CNAME>SampleApp-jxb293wg7n.elasticbeanstalk.amazonaws.com</CNAME>
    <Health>Grey</Health>
    <EnvironmentId>e-icsgecu3wf</EnvironmentId>
    <DateUpdated>2010-11-17T17:10:41.976Z</DateUpdated>
    <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
    <Description>EnvDescrip</Description>
    <EnvironmentName>SampleApp</EnvironmentName>
    <DateCreated>2010-11-17T03:59:33.520Z</DateCreated>
  </TerminateEnvironmentResult>
  <ResponseMetadata>
    <RequestId>9b71af21-f26d-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</TerminateEnvironmentResponse>
```

## See Also
<a name="API_TerminateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/TerminateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/TerminateEnvironment) 

# UpdateApplication
<a name="API_UpdateApplication"></a>

Updates the specified application to have the specified properties.

**Note**  
If a property (for example, `description`) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

## Request Parameters
<a name="API_UpdateApplication_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application to update. If no such application is found, `UpdateApplication` returns an `InvalidParameterValue` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** Description **   
A new description for the application.  
Default: If not specified, AWS Elastic Beanstalk does not update the description.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

## Response Elements
<a name="API_UpdateApplication_ResponseElements"></a>

The following element is returned by the service.

 ** Application **   
 The [ApplicationDescription](API_ApplicationDescription.md) of the application.   
Type: [ApplicationDescription](API_ApplicationDescription.md) object

## Errors
<a name="API_UpdateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_UpdateApplication_Examples"></a>

### Example
<a name="API_UpdateApplication_Example_1"></a>

This example illustrates one usage of UpdateApplication.

#### Sample Request
<a name="API_UpdateApplication_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&Description=Another%20Description
&Operation=UpdateApplication
&AuthParams
```

#### Sample Response
<a name="API_UpdateApplication_Example_1_Response"></a>

```
<UpdateApplicationResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <UpdateApplicationResult>
    <Application>
      <Versions>
        <member>New Version</member>
      </Versions>
      <Description>Another Description</Description>
      <ApplicationName>SampleApp</ApplicationName>
      <DateCreated>2010-11-17T19:26:20.410Z</DateCreated>
      <DateUpdated>2010-11-17T20:42:54.611Z</DateUpdated>
      <ConfigurationTemplates>
        <member>Default</member>
      </ConfigurationTemplates>
    </Application>
  </UpdateApplicationResult>
  <ResponseMetadata>
    <RequestId>40be666b-f28b-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</UpdateApplicationResponse>
```

## See Also
<a name="API_UpdateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/UpdateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/UpdateApplication) 

# UpdateApplicationResourceLifecycle
<a name="API_UpdateApplicationResourceLifecycle"></a>

Modifies lifecycle settings for an application.

## Request Parameters
<a name="API_UpdateApplicationResourceLifecycle_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** ResourceLifecycleConfig **   
The lifecycle configuration.  
Type: [ApplicationResourceLifecycleConfig](API_ApplicationResourceLifecycleConfig.md) object  
Required: Yes

## Response Elements
<a name="API_UpdateApplicationResourceLifecycle_ResponseElements"></a>

The following elements are returned by the service.

 ** ApplicationName **   
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** ResourceLifecycleConfig **   
The lifecycle configuration.  
Type: [ApplicationResourceLifecycleConfig](API_ApplicationResourceLifecycleConfig.md) object

## Errors
<a name="API_UpdateApplicationResourceLifecycle_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

## See Also
<a name="API_UpdateApplicationResourceLifecycle_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle) 

# UpdateApplicationVersion
<a name="API_UpdateApplicationVersion"></a>

Updates the specified application version to have the specified properties.

**Note**  
If a property (for example, `description`) is not provided, the value remains unchanged. To clear properties, specify an empty string.

## Request Parameters
<a name="API_UpdateApplicationVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application associated with this version.  
 If no application is found with this name, `UpdateApplication` returns an `InvalidParameterValue` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** Description **   
A new description for this version.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

 ** VersionLabel **   
The name of the version to update.  
If no application version is found with this label, `UpdateApplication` returns an `InvalidParameterValue` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Elements
<a name="API_UpdateApplicationVersion_ResponseElements"></a>

The following element is returned by the service.

 ** ApplicationVersion **   
 The [ApplicationVersionDescription](API_ApplicationVersionDescription.md) of the application version.   
Type: [ApplicationVersionDescription](API_ApplicationVersionDescription.md) object

## Errors
<a name="API_UpdateApplicationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_UpdateApplicationVersion_Examples"></a>

### Example
<a name="API_UpdateApplicationVersion_Example_1"></a>

This example illustrates one usage of UpdateApplicationVersion.

#### Sample Request
<a name="API_UpdateApplicationVersion_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&VersionLabel=New%20Version
&Description=New%20Release%20Description
&Operation=UpdateApplicationVersion
&AuthParams
```

#### Sample Response
<a name="API_UpdateApplicationVersion_Example_1_Response"></a>

```
<UpdateApplicationVersionResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <UpdateApplicationVersionResult>
    <ApplicationVersion>
      <SourceBundle>
        <S3Bucket>awsemr</S3Bucket>
        <S3Key>sample.war</S3Key>
      </SourceBundle>
      <VersionLabel>New Version</VersionLabel>
      <Description>New Release Description</Description>
      <ApplicationName>SampleApp</ApplicationName>
      <DateCreated>2010-11-17T19:26:20.699Z</DateCreated>
      <DateUpdated>2010-11-17T20:48:16.632Z</DateUpdated>
    </ApplicationVersion>
  </UpdateApplicationVersionResult>
  <ResponseMetadata>
    <RequestId>00b10aa1-f28c-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</UpdateApplicationVersionResponse>
```

## See Also
<a name="API_UpdateApplicationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/UpdateApplicationVersion) 

# UpdateConfigurationTemplate
<a name="API_UpdateConfigurationTemplate"></a>

Updates the specified configuration template to have the specified properties or configuration option values.

**Note**  
If a property (for example, `ApplicationName`) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics
+  [DescribeConfigurationOptions](API_DescribeConfigurationOptions.md) 

## Request Parameters
<a name="API_UpdateConfigurationTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application associated with the configuration template to update.  
 If no application is found with this name, `UpdateConfigurationTemplate` returns an `InvalidParameterValue` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** Description **   
A new description for the configuration.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

 **OptionSettings.member.N**   
A list of configuration option settings to update with the new specified option value.  
Type: Array of [ConfigurationOptionSetting](API_ConfigurationOptionSetting.md) objects  
Required: No

 **OptionsToRemove.member.N**   
A list of configuration options to remove from the configuration set.  
 Constraint: You can remove only `UserDefined` configuration options.   
Type: Array of [OptionSpecification](API_OptionSpecification.md) objects  
Required: No

 ** TemplateName **   
The name of the configuration template to update.  
 If no configuration template is found with this name, `UpdateConfigurationTemplate` returns an `InvalidParameterValue` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Elements
<a name="API_UpdateConfigurationTemplate_ResponseElements"></a>

The following elements are returned by the service.

 ** ApplicationName **   
The name of the application associated with this configuration set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** DateCreated **   
The date (in UTC time) when this configuration set was created.  
Type: Timestamp

 ** DateUpdated **   
The date (in UTC time) when this configuration set was last modified.  
Type: Timestamp

 ** DeploymentStatus **   
 If this configuration set is associated with an environment, the `DeploymentStatus` parameter indicates the deployment status of this configuration set:   
+  `null`: This configuration is not associated with a running environment.
+  `pending`: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
+  `deployed`: This is the configuration that is currently deployed to the associated running environment.
+  `failed`: This is a draft configuration that failed to successfully deploy.
Type: String  
Valid Values: `deployed | pending | failed` 

 ** Description **   
Describes this configuration set.  
Type: String  
Length Constraints: Maximum length of 200.

 ** EnvironmentName **   
 If not `null`, the name of the environment for this configuration set.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.

 **OptionSettings.member.N**   
A list of the configuration options and their values in this configuration set.  
Type: Array of [ConfigurationOptionSetting](API_ConfigurationOptionSetting.md) objects

 ** PlatformArn **   
The ARN of the platform version.  
Type: String

 ** SolutionStackName **   
The name of the solution stack this configuration set uses.  
Type: String

 ** TemplateName **   
 If not `null`, the name of the configuration template for this configuration set.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_UpdateConfigurationTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** TooManyBuckets **   
The specified account has reached its limit of Amazon S3 buckets.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateConfigurationTemplate_Examples"></a>

### Example
<a name="API_UpdateConfigurationTemplate_Example_1"></a>

This example illustrates one usage of UpdateConfigurationTemplate.

#### Sample Request
<a name="API_UpdateConfigurationTemplate_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&TemplateName=default
&Description=changed%20description
&OptionSettings.member.1.Namespace=aws%3Aautoscaling%3Atrigger
&OptionSettings.member.1.OptionName=LowerThreshold
&OptionSettings.member.1.Value=1000000
&Operation=UpdateConfigurationTemplate
&AuthParams
```

#### Sample Response
<a name="API_UpdateConfigurationTemplate_Example_1_Response"></a>

```
<UpdateConfigurationTemplateResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <UpdateConfigurationTemplateResult>
    <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
    <OptionSettings>
      <member>
        <OptionName>Availability Zones</OptionName>
        <Value>Any 1</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>PARAM5</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>LowerThreshold</OptionName>
        <Value>1000000</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>UpperThreshold</OptionName>
        <Value>9000000</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>LowerBreachScaleIncrement</OptionName>
        <Value>-1</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>MeasureName</OptionName>
        <Value>NetworkOut</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>Period</OptionName>
        <Value>60</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>Xmx</OptionName>
        <Value>256m</Value>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <OptionName>PARAM3</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>EC2KeyName</OptionName>
        <Value/>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <OptionName>MinSize</OptionName>
        <Value>1</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>JVM Options</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <OptionName>XX:MaxPermSize</OptionName>
        <Value>64m</Value>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
      <member>
        <OptionName>AWS_SECRET_KEY</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>UpperBreachScaleIncrement</OptionName>
        <Value>1</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>Notification Topic ARN</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <OptionName>InstanceType</OptionName>
        <Value>t1.micro</Value>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <OptionName>Custom Availability Zones</OptionName>
        <Value>us-east-1a</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>Statistic</OptionName>
        <Value>Average</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>Notification Protocol</OptionName>
        <Value>email</Value>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <OptionName>JDBC_CONNECTION_STRING</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>PARAM2</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>Stickiness Cookie Expiration</OptionName>
        <Value>0</Value>
        <Namespace>aws:elb:policies</Namespace>
      </member>
      <member>
        <OptionName>SSLCertificateId</OptionName>
        <Value/>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
      <member>
        <OptionName>MaxSize</OptionName>
        <Value>4</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>Stickiness Policy</OptionName>
        <Value>false</Value>
        <Namespace>aws:elb:policies</Namespace>
      </member>
      <member>
        <OptionName>Notification Topic Name</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <OptionName>SecurityGroups</OptionName>
        <Value>elasticbeanstalk-default</Value>
        <Namespace>aws:autoscaling:launchconfiguration</Namespace>
      </member>
      <member>
        <OptionName>LoadBalancerHTTPPort</OptionName>
        <Value>80</Value>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
      <member>
        <OptionName>Unit</OptionName>
        <Value>None</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>AWS_ACCESS_KEY_ID</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>PARAM4</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>Application Healthcheck URL</OptionName>
        <Value>/</Value>
        <Namespace>aws:elasticbeanstalk:application</Namespace>
      </member>
      <member>
        <OptionName>LoadBalancerHTTPSPort</OptionName>
        <Value>OFF</Value>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
      <member>
        <OptionName>HealthyThreshold</OptionName>
        <Value>3</Value>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <OptionName>Timeout</OptionName>
        <Value>5</Value>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <OptionName>Cooldown</OptionName>
        <Value>0</Value>
        <Namespace>aws:autoscaling:asg</Namespace>
      </member>
      <member>
        <OptionName>UnhealthyThreshold</OptionName>
        <Value>5</Value>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <OptionName>Interval</OptionName>
        <Value>30</Value>
        <Namespace>aws:elb:healthcheck</Namespace>
      </member>
      <member>
        <OptionName>LogPublicationControl</OptionName>
        <Value>false</Value>
        <Namespace>aws:elasticbeanstalk:hostmanager</Namespace>
      </member>
      <member>
        <OptionName>BreachDuration</OptionName>
        <Value>120</Value>
        <Namespace>aws:autoscaling:trigger</Namespace>
      </member>
      <member>
        <OptionName>PARAM1</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:application:environment</Namespace>
      </member>
      <member>
        <OptionName>Notification Endpoint</OptionName>
        <Value/>
        <Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
      </member>
      <member>
        <OptionName>Protocol</OptionName>
        <Value>HTTP</Value>
        <Namespace>aws:elb:loadbalancer</Namespace>
      </member>
      <member>
        <OptionName>Xms</OptionName>
        <Value>256m</Value>
        <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
      </member>
    </OptionSettings>
    <Description>changed description</Description>
    <ApplicationName>SampleApp</ApplicationName>
    <DateCreated>2010-11-17T19:26:20.420Z</DateCreated>
    <TemplateName>Default</TemplateName>
    <DateUpdated>2010-11-17T20:58:27.508Z</DateUpdated>
  </UpdateConfigurationTemplateResult>
  <ResponseMetadata>
    <RequestId>6cbcb09a-f28d-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</UpdateConfigurationTemplateResponse>
```

## See Also
<a name="API_UpdateConfigurationTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate) 

# UpdateEnvironment
<a name="API_UpdateEnvironment"></a>

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

 Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. 

 When updating the configuration settings to a new template or individual settings, a draft configuration is created and [DescribeConfigurationSettings](API_DescribeConfigurationSettings.md) for this environment returns two setting descriptions with different `DeploymentStatus` values. 

## Request Parameters
<a name="API_UpdateEnvironment_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application with which the environment is associated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** Description **   
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

 ** EnvironmentId **   
The ID of the environment to update.  
If no environment with this ID exists, AWS Elastic Beanstalk returns an `InvalidParameterValue` error.  
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Required: No

 ** EnvironmentName **   
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an `InvalidParameterValue` error.   
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 ** GroupName **   
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See [Environment Manifest (env.yaml)](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) for details.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 19.  
Required: No

 **OptionSettings.member.N**   
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.  
Type: Array of [ConfigurationOptionSetting](API_ConfigurationOptionSetting.md) objects  
Required: No

 **OptionsToRemove.member.N**   
A list of custom user-defined configuration options to remove from the configuration set for this environment.  
Type: Array of [OptionSpecification](API_OptionSpecification.md) objects  
Required: No

 ** PlatformArn **   
The ARN of the platform, if used.  
Type: String  
Required: No

 ** SolutionStackName **   
This specifies the platform version that the environment will run after the environment is updated.  
Type: String  
Required: No

 ** TemplateName **   
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an `InvalidParameterValue` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** Tier **   
This specifies the tier to use to update the environment.  
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns `InvalidParameterValue` error.   
Type: [EnvironmentTier](API_EnvironmentTier.md) object  
Required: No

 ** VersionLabel **   
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an `InvalidParameterValue` error.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_UpdateEnvironment_ResponseElements"></a>

The following elements are returned by the service.

 ** AbortableOperationInProgress **   
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.  
 `true:` There is an update in progress.   
 `false:` There are no updates currently in progress.   
Type: Boolean

 ** ApplicationName **   
The name of the application associated with this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** CNAME **   
The URL to the CNAME for this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** DateCreated **   
The creation date for this environment.  
Type: Timestamp

 ** DateUpdated **   
The last modified date for this environment.  
Type: Timestamp

 ** Description **   
Describes this environment.  
Type: String  
Length Constraints: Maximum length of 200.

 ** EndpointURL **   
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.  
Type: String

 ** EnvironmentArn **   
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.  
Type: String

 ** EnvironmentId **   
The ID of this environment.  
Type: String

 **EnvironmentLinks.member.N**   
A list of links to other environments in the same group.  
Type: Array of [EnvironmentLink](API_EnvironmentLink.md) objects

 ** EnvironmentName **   
The name of this environment.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.

 ** Health **   
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:  
+  `Red`: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
+  `Yellow`: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
+  `Green`: Indicates the environment is healthy and fully functional.
+  `Grey`: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an `UpdateEnvironment` or `RestartEnvironment` request.
 Default: `Grey`   
Type: String  
Valid Values: `Green | Yellow | Red | Grey` 

 ** HealthStatus **   
Returns the health status of the application running in your environment. For more information, see [Health Colors and Statuses](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html).  
Type: String  
Valid Values: `NoData | Unknown | Pending | Ok | Info | Warning | Degraded | Severe | Suspended` 

 ** OperationsRole **   
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
The Amazon Resource Name (ARN) of the environment's operations role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** PlatformArn **   
The ARN of the platform version.  
Type: String

 ** Resources **   
The description of the AWS resources used by this environment.  
Type: [EnvironmentResourcesDescription](API_EnvironmentResourcesDescription.md) object

 ** SolutionStackName **   
 The name of the `SolutionStack` deployed with this environment.   
Type: String

 ** Status **   
The current operational status of the environment:  
+  `Aborting`: Environment is in the process of aborting a deployment.
+  `Launching`: Environment is in the process of initial deployment.
+  `LinkingFrom`: Environment is in the process of being linked to by another environment. See [Environment links](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html) for details.
+  `LinkingTo`: Environment is in the process of linking to another environment. See [Environment links](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html) for details.
+  `Updating`: Environment is in the process of updating its configuration settings or application version.
+  `Ready`: Environment is available to have an action performed on it, such as update or terminate.
+  `Terminating`: Environment is in the shut-down process.
+  `Terminated`: Environment is not running.
Type: String  
Valid Values: `Aborting | Launching | Updating | LinkingFrom | LinkingTo | Ready | Terminating | Terminated` 

 ** TemplateName **   
The name of the configuration template used to originally launch this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** Tier **   
Describes the current tier of this environment.  
Type: [EnvironmentTier](API_EnvironmentTier.md) object

 ** VersionLabel **   
The application version deployed in this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_UpdateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** TooManyBuckets **   
The specified account has reached its limit of Amazon S3 buckets.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateEnvironment_Examples"></a>

### Example
<a name="API_UpdateEnvironment_Example_1"></a>

This example illustrates one usage of UpdateEnvironment.

#### Sample Request
<a name="API_UpdateEnvironment_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-hc8mvnayrx
&EnvironmentName=SampleAppVersion
&TemplateName=default
&OptionsToRemove.member.1.Namespace=aws%3Aautoscaling%3Atrigger
&OptionsToRemove.member.1.OptionName=MeasureName
&Operation=UpdateEnvironment
&AuthParams
```

#### Sample Response
<a name="API_UpdateEnvironment_Example_1_Response"></a>

```
<UpdateEnvironmentResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <UpdateEnvironmentResult>
    <VersionLabel>New Version</VersionLabel>
    <Status>Deploying</Status>
    <ApplicationName>SampleApp</ApplicationName>
    <EndpointURL>elasticbeanstalk-SampleAppVersion-246126201.us-east-1.elb.amazonaws.com</EndpointURL>
    <CNAME>SampleApp.elasticbeanstalk.amazonaws.com</CNAME>
    <Health>Grey</Health>
    <EnvironmentId>e-hc8mvnayrx</EnvironmentId>
    <DateUpdated>2010-11-17T21:05:55.251Z</DateUpdated>
    <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
    <Description>SampleAppDescription</Description>
    <EnvironmentName>SampleAppVersion</EnvironmentName>
    <DateCreated>2010-11-17T20:17:42.339Z</DateCreated>
  </UpdateEnvironmentResult>
  <ResponseMetadata>
    <RequestId>7705f0bc-f28e-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</UpdateEnvironmentResponse>
```

## See Also
<a name="API_UpdateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/UpdateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/UpdateEnvironment) 

# UpdateTagsForResource
<a name="API_UpdateTagsForResource"></a>

Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: `TagsToAdd` for tags to add or update, and `TagsToRemove`.

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see [Tagging Application Resources](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html).

If you create a custom policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:

elasticbeanstalk:AddTags  
Controls permission to call `UpdateTagsForResource` and pass a list of tags to add in the `TagsToAdd` parameter.

elasticbeanstalk:RemoveTags  
Controls permission to call `UpdateTagsForResource` and pass a list of tag keys to remove in the `TagsToRemove` parameter.

For details about creating a custom user policy, see [Creating a Custom User Policy](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies).

## Request Parameters
<a name="API_UpdateTagsForResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceArn **   
The Amazon Resource Name (ARN) of the resouce to be updated.  
Must be the ARN of an Elastic Beanstalk resource.  
Type: String  
Required: Yes

 **TagsToAdd.member.N**   
A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated.  
Specify at least one of these parameters: `TagsToAdd`, `TagsToRemove`.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagsToRemove.member.N**   
A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored.  
Specify at least one of these parameters: `TagsToAdd`, `TagsToRemove`.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

## Errors
<a name="API_UpdateTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** OperationInProgressFailure **   
Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.  
HTTP Status Code: 400

 ** ResourceNotFound **   
A resource doesn't exist for the specified Amazon Resource Name (ARN).  
HTTP Status Code: 400

 ** ResourceTypeNotSupported **   
The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.  
HTTP Status Code: 400

 ** TooManyTags **   
The number of tags in the resource would exceed the number of tags that each resource can have.  
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.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/UpdateTagsForResource) 

# ValidateConfigurationSettings
<a name="API_ValidateConfigurationSettings"></a>

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

## Request Parameters
<a name="API_ValidateConfigurationSettings_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplicationName **   
The name of the application that the configuration template or environment belongs to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** EnvironmentName **   
The name of the environment to validate the settings against.  
Condition: You cannot specify both this and a configuration template name.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 40.  
Required: No

 **OptionSettings.member.N**   
A list of the options and desired values to evaluate.  
Type: Array of [ConfigurationOptionSetting](API_ConfigurationOptionSetting.md) objects  
Required: Yes

 ** TemplateName **   
The name of the configuration template to validate the settings against.  
Condition: You cannot specify both this and an environment name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Elements
<a name="API_ValidateConfigurationSettings_ResponseElements"></a>

The following element is returned by the service.

 **Messages.member.N**   
 A list of [ValidationMessage](API_ValidationMessage.md).   
Type: Array of [ValidationMessage](API_ValidationMessage.md) objects

## Errors
<a name="API_ValidateConfigurationSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientPrivileges **   
The specified account does not have sufficient privileges for one or more AWS services.  
HTTP Status Code: 403

 ** TooManyBuckets **   
The specified account has reached its limit of Amazon S3 buckets.  
HTTP Status Code: 400

## Examples
<a name="API_ValidateConfigurationSettings_Examples"></a>

### Example
<a name="API_ValidateConfigurationSettings_Example_1"></a>

This example illustrates one usage of ValidateConfigurationSettings.

#### Sample Request
<a name="API_ValidateConfigurationSettings_Example_1_Request"></a>

```
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp
&EnvironmentName=SampleAppVersion
&OptionSettings.member.1.Namespace=aws%3Aautoscaling%3Atrigger
&OptionSettings.member.1.OptionName=LowerThreshold
&OptionSettings.member.1.Value=1000000
&Operation=ValidateConfigurationSettings
&AuthParams
```

#### Sample Response
<a name="API_ValidateConfigurationSettings_Example_1_Response"></a>

```
<ValidateConfigurationSettingsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ValidateConfigurationSettingsResult>
    <Messages/>
  </ValidateConfigurationSettingsResult>
  <ResponseMetadata>
    <RequestId>06f1cfff-f28f-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</ValidateConfigurationSettingsResponse>
```

## See Also
<a name="API_ValidateConfigurationSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings)