SDK for PHP 3.x

Client: Aws\ElasticBeanstalk\ElasticBeanstalkClient
Service ID: elasticbeanstalk
Version: 2010-12-01

This page describes the parameters and results for the operations of the AWS Elastic Beanstalk (2010-12-01), and shows how to use the Aws\ElasticBeanstalk\ElasticBeanstalkClient object to call the described operations. This documentation is specific to the 2010-12-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AbortEnvironmentUpdate ( array $params = [] )
Cancels in-progress environment configuration update or application version deployment.
ApplyEnvironmentManagedAction ( array $params = [] )
Applies a scheduled managed action immediately.
AssociateEnvironmentOperationsRole ( array $params = [] )
Add or change the operations role used by an environment.
CheckDNSAvailability ( array $params = [] )
Checks if the specified CNAME is available.
ComposeEnvironments ( array $params = [] )
Create or update a group of environments that each run a separate component of a single application.
CreateApplication ( array $params = [] )
Creates an application that has one configuration template named default and no application versions.
CreateApplicationVersion ( array $params = [] )
Creates an application version for the specified application.
CreateConfigurationTemplate ( array $params = [] )
Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application.
CreateEnvironment ( array $params = [] )
Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
CreatePlatformVersion ( array $params = [] )
Create a new version of your custom platform.
CreateStorageLocation ( array $params = [] )
Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments.
DeleteApplication ( array $params = [] )
Deletes the specified application along with all associated versions and configurations.
DeleteApplicationVersion ( array $params = [] )
Deletes the specified version from the specified application.
DeleteConfigurationTemplate ( array $params = [] )
Deletes the specified configuration template.
DeleteEnvironmentConfiguration ( array $params = [] )
Deletes the draft configuration associated with the running environment.
DeletePlatformVersion ( array $params = [] )
Deletes the specified version of a custom platform.
DescribeAccountAttributes ( array $params = [] )
Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
DescribeApplicationVersions ( array $params = [] )
Retrieve a list of application versions.
DescribeApplications ( array $params = [] )
Returns the descriptions of existing applications.
DescribeConfigurationOptions ( array $params = [] )
Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.
DescribeConfigurationSettings ( array $params = [] )
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.
DescribeEnvironmentHealth ( array $params = [] )
Returns information about the overall health of the specified environment.
DescribeEnvironmentManagedActionHistory ( array $params = [] )
Lists an environment's completed and failed managed actions.
DescribeEnvironmentManagedActions ( array $params = [] )
Lists an environment's upcoming and in-progress managed actions.
DescribeEnvironmentResources ( array $params = [] )
Returns AWS resources for this environment.
DescribeEnvironments ( array $params = [] )
Returns descriptions for existing environments.
DescribeEvents ( array $params = [] )
Returns list of event descriptions matching criteria up to the last 6 weeks.
DescribeInstancesHealth ( array $params = [] )
Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk.
DescribePlatformVersion ( array $params = [] )
Describes a platform version.
DisassociateEnvironmentOperationsRole ( array $params = [] )
Disassociate the operations role from an environment.
ListAvailableSolutionStacks ( array $params = [] )
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
ListPlatformBranches ( array $params = [] )
Lists the platform branches available for your account in an AWS Region.
ListPlatformVersions ( array $params = [] )
Lists the platform versions available for your account in an AWS Region.
ListTagsForResource ( array $params = [] )
Return the tags applied to an AWS Elastic Beanstalk resource.
RebuildEnvironment ( array $params = [] )
Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.
RequestEnvironmentInfo ( array $params = [] )
Initiates a request to compile the specified type of information of the deployed environment.
RestartAppServer ( array $params = [] )
Causes the environment to restart the application container server running on each Amazon EC2 instance.
RetrieveEnvironmentInfo ( array $params = [] )
Retrieves the compiled information from a RequestEnvironmentInfo request.
SwapEnvironmentCNAMEs ( array $params = [] )
Swaps the CNAMEs of two environments.
TerminateEnvironment ( array $params = [] )
Terminates the specified environment.
UpdateApplication ( array $params = [] )
Updates the specified application to have the specified properties.
UpdateApplicationResourceLifecycle ( array $params = [] )
Modifies lifecycle settings for an application.
UpdateApplicationVersion ( array $params = [] )
Updates the specified application version to have the specified properties.
UpdateConfigurationTemplate ( array $params = [] )
Updates the specified configuration template to have the specified properties or configuration option values.
UpdateEnvironment ( array $params = [] )
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.
UpdateTagsForResource ( array $params = [] )
Update the list of tags applied to an AWS Elastic Beanstalk resource.
ValidateConfigurationSettings ( array $params = [] )
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeApplicationVersions
DescribeApplications
DescribeConfigurationOptions
DescribeEnvironmentManagedActionHistory
DescribeEnvironments
DescribeEvents
ListAvailableSolutionStacks
ListPlatformBranches
ListPlatformVersions

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
EnvironmentExists DescribeEnvironments 20 20
EnvironmentUpdated DescribeEnvironments 20 20
EnvironmentTerminated DescribeEnvironments 20 20

Operations

AbortEnvironmentUpdate

$result = $client->abortEnvironmentUpdate([/* ... */]);
$promise = $client->abortEnvironmentUpdateAsync([/* ... */]);

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

Parameter Syntax

$result = $client->abortEnvironmentUpdate([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
]);

Parameter Details

Members
EnvironmentId
Type: string

This specifies the ID of the environment with the in-progress update that you want to cancel.

EnvironmentName
Type: string

This specifies the name of the environment with the in-progress update that you want to cancel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

Examples

Example 1: To abort a deployment

The following code aborts a running application version deployment for an environment named my-env:

$result = $client->abortEnvironmentUpdate([
    'EnvironmentName' => 'my-env',
]);

ApplyEnvironmentManagedAction

$result = $client->applyEnvironmentManagedAction([/* ... */]);
$promise = $client->applyEnvironmentManagedActionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->applyEnvironmentManagedAction([
    'ActionId' => '<string>', // REQUIRED
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
]);

Parameter Details

Members
ActionId
Required: Yes
Type: string

The action ID of the scheduled managed action to execute.

EnvironmentId
Type: string

The environment ID of the target environment.

EnvironmentName
Type: string

The name of the target environment.

Result Syntax

[
    'ActionDescription' => '<string>',
    'ActionId' => '<string>',
    'ActionType' => 'InstanceRefresh|PlatformUpdate|Unknown',
    'Status' => '<string>',
]

Result Details

Members
ActionDescription
Type: string

A description of the managed action.

ActionId
Type: string

The action ID of the managed action.

ActionType
Type: string

The type of managed action.

Status
Type: string

The status of the managed action.

Errors

ElasticBeanstalkServiceException:

A generic service exception has occurred.

ManagedActionInvalidStateException:

Cannot modify the managed action in its current state.

AssociateEnvironmentOperationsRole

$result = $client->associateEnvironmentOperationsRole([/* ... */]);
$promise = $client->associateEnvironmentOperationsRoleAsync([/* ... */]);

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. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Parameter Syntax

$result = $client->associateEnvironmentOperationsRole([
    'EnvironmentName' => '<string>', // REQUIRED
    'OperationsRole' => '<string>', // REQUIRED
]);

Parameter Details

Members
EnvironmentName
Required: Yes
Type: string

The name of the environment to which to set the operations role.

OperationsRole
Required: Yes
Type: string

The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

CheckDNSAvailability

$result = $client->checkDNSAvailability([/* ... */]);
$promise = $client->checkDNSAvailabilityAsync([/* ... */]);

Checks if the specified CNAME is available.

Parameter Syntax

$result = $client->checkDNSAvailability([
    'CNAMEPrefix' => '<string>', // REQUIRED
]);

Parameter Details

Members
CNAMEPrefix
Required: Yes
Type: string

The prefix used when this CNAME is reserved.

Result Syntax

[
    'Available' => true || false,
    'FullyQualifiedCNAME' => '<string>',
]

Result Details

Members
Available
Type: boolean

Indicates if the specified CNAME is available:

  • true : The CNAME is available.

  • false : The CNAME is not available.

FullyQualifiedCNAME
Type: string

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

Errors

There are no errors described for this operation.

Examples

Example 1: To check the availability of a CNAME

The following operation checks the availability of the subdomain my-cname:

$result = $client->checkDNSAvailability([
    'CNAMEPrefix' => 'my-cname',
]);

Result syntax:

[
    'Available' => 1,
    'FullyQualifiedCNAME' => 'my-cname.us-west-2.elasticbeanstalk.com',
]

ComposeEnvironments

$result = $client->composeEnvironments([/* ... */]);
$promise = $client->composeEnvironmentsAsync([/* ... */]);

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 for details.

Parameter Syntax

$result = $client->composeEnvironments([
    'ApplicationName' => '<string>',
    'GroupName' => '<string>',
    'VersionLabels' => ['<string>', ...],
]);

Parameter Details

Members
ApplicationName
Type: string

The name of the application to which the specified source bundles belong.

GroupName
Type: string

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 + (plus) character. See Environment Manifest (env.yaml) for details.

VersionLabels
Type: Array of strings

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.

Result Syntax

[
    'Environments' => [
        [
            'AbortableOperationInProgress' => true || false,
            'ApplicationName' => '<string>',
            'CNAME' => '<string>',
            'DateCreated' => <DateTime>,
            'DateUpdated' => <DateTime>,
            'Description' => '<string>',
            'EndpointURL' => '<string>',
            'EnvironmentArn' => '<string>',
            'EnvironmentId' => '<string>',
            'EnvironmentLinks' => [
                [
                    'EnvironmentName' => '<string>',
                    'LinkName' => '<string>',
                ],
                // ...
            ],
            'EnvironmentName' => '<string>',
            'Health' => 'Green|Yellow|Red|Grey',
            'HealthStatus' => 'NoData|Unknown|Pending|Ok|Info|Warning|Degraded|Severe|Suspended',
            'OperationsRole' => '<string>',
            'PlatformArn' => '<string>',
            'Resources' => [
                'LoadBalancer' => [
                    'Domain' => '<string>',
                    'Listeners' => [
                        [
                            'Port' => <integer>,
                            'Protocol' => '<string>',
                        ],
                        // ...
                    ],
                    'LoadBalancerName' => '<string>',
                ],
            ],
            'SolutionStackName' => '<string>',
            'Status' => 'Aborting|Launching|Updating|LinkingFrom|LinkingTo|Ready|Terminating|Terminated',
            'TemplateName' => '<string>',
            'Tier' => [
                'Name' => '<string>',
                'Type' => '<string>',
                'Version' => '<string>',
            ],
            'VersionLabel' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Environments
Type: Array of EnvironmentDescription structures

Returns an EnvironmentDescription list.

NextToken
Type: string

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Errors

TooManyEnvironmentsException:

The specified account has reached its limit of environments.

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createApplication([
    'ApplicationName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ResourceLifecycleConfig' => [
        'ServiceRole' => '<string>',
        'VersionLifecycleConfig' => [
            'MaxAgeRule' => [
                'DeleteSourceFromS3' => true || false,
                'Enabled' => true || false, // REQUIRED
                'MaxAgeInDays' => <integer>,
            ],
            'MaxCountRule' => [
                'DeleteSourceFromS3' => true || false,
                'Enabled' => true || false, // REQUIRED
                'MaxCount' => <integer>,
            ],
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application. Must be unique within your account.

Description
Type: string

Your description of the application.

ResourceLifecycleConfig

Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.

Tags
Type: Array of Tag structures

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.

Result Syntax

[
    'Application' => [
        'ApplicationArn' => '<string>',
        'ApplicationName' => '<string>',
        'ConfigurationTemplates' => ['<string>', ...],
        'DateCreated' => <DateTime>,
        'DateUpdated' => <DateTime>,
        'Description' => '<string>',
        'ResourceLifecycleConfig' => [
            'ServiceRole' => '<string>',
            'VersionLifecycleConfig' => [
                'MaxAgeRule' => [
                    'DeleteSourceFromS3' => true || false,
                    'Enabled' => true || false,
                    'MaxAgeInDays' => <integer>,
                ],
                'MaxCountRule' => [
                    'DeleteSourceFromS3' => true || false,
                    'Enabled' => true || false,
                    'MaxCount' => <integer>,
                ],
            ],
        ],
        'Versions' => ['<string>', ...],
    ],
]

Result Details

Members
Application
Type: ApplicationDescription structure

The ApplicationDescription of the application.

Errors

TooManyApplicationsException:

The specified account has reached its limit of applications.

Examples

Example 1: To create a new application

The following operation creates a new application named my-app:

$result = $client->createApplication([
    'ApplicationName' => 'my-app',
    'Description' => 'my application',
]);

Result syntax:

[
    'Application' => [
        'ApplicationName' => 'my-app',
        'ConfigurationTemplates' => [
        ],
        'DateCreated' => ,
        'DateUpdated' => ,
        'Description' => 'my application',
    ],
]

CreateApplicationVersion

$result = $client->createApplicationVersion([/* ... */]);
$promise = $client->createApplicationVersionAsync([/* ... */]);

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 S3 with SourceBundle

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

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.

Parameter Syntax

$result = $client->createApplicationVersion([
    'ApplicationName' => '<string>', // REQUIRED
    'AutoCreateApplication' => true || false,
    'BuildConfiguration' => [
        'ArtifactName' => '<string>',
        'CodeBuildServiceRole' => '<string>', // REQUIRED
        'ComputeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE',
        'Image' => '<string>', // REQUIRED
        'TimeoutInMinutes' => <integer>,
    ],
    'Description' => '<string>',
    'Process' => true || false,
    'SourceBuildInformation' => [
        'SourceLocation' => '<string>', // REQUIRED
        'SourceRepository' => 'CodeCommit|S3', // REQUIRED
        'SourceType' => 'Git|Zip', // REQUIRED
    ],
    'SourceBundle' => [
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VersionLabel' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.

AutoCreateApplication
Type: boolean

Set to true to create an application with the specified name if it doesn't already exist.

BuildConfiguration
Type: BuildConfiguration structure

Settings for an AWS CodeBuild build.

Description
Type: string

A description of this application version.

Process
Type: boolean

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.

SourceBuildInformation
Type: SourceBuildInformation structure

Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.

SourceBundle
Type: S3Location structure

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.

Specify a source bundle in 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.

Tags
Type: Array of Tag structures

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.

VersionLabel
Required: Yes
Type: string

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.

Result Syntax

[
    'ApplicationVersion' => [
        'ApplicationName' => '<string>',
        'ApplicationVersionArn' => '<string>',
        'BuildArn' => '<string>',
        'DateCreated' => <DateTime>,
        'DateUpdated' => <DateTime>,
        'Description' => '<string>',
        'SourceBuildInformation' => [
            'SourceLocation' => '<string>',
            'SourceRepository' => 'CodeCommit|S3',
            'SourceType' => 'Git|Zip',
        ],
        'SourceBundle' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'Status' => 'Processed|Unprocessed|Failed|Processing|Building',
        'VersionLabel' => '<string>',
    ],
]

Result Details

Members
ApplicationVersion

The ApplicationVersionDescription of the application version.

Errors

TooManyApplicationsException:

The specified account has reached its limit of applications.

TooManyApplicationVersionsException:

The specified account has reached its limit of application versions.

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

S3LocationNotInServiceRegionException:

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

CodeBuildNotInServiceRegionException:

AWS CodeBuild is not available in the specified region.

Examples

Example 1: To create a new application

The following operation creates a new version (v1) of an application named my-app:

$result = $client->createApplicationVersion([
    'ApplicationName' => 'my-app',
    'AutoCreateApplication' => 1,
    'Description' => 'my-app-v1',
    'Process' => 1,
    'SourceBundle' => [
        'S3Bucket' => 'my-bucket',
        'S3Key' => 'sample.war',
    ],
    'VersionLabel' => 'v1',
]);

Result syntax:

[
    'ApplicationVersion' => [
        'ApplicationName' => 'my-app',
        'DateCreated' => ,
        'DateUpdated' => ,
        'Description' => 'my-app-v1',
        'SourceBundle' => [
            'S3Bucket' => 'my-bucket',
            'S3Key' => 'sample.war',
        ],
        'VersionLabel' => 'v1',
    ],
]

CreateConfigurationTemplate

$result = $client->createConfigurationTemplate([/* ... */]);
$promise = $client->createConfigurationTemplateAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createConfigurationTemplate([
    'ApplicationName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'EnvironmentId' => '<string>',
    'OptionSettings' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'PlatformArn' => '<string>',
    'SolutionStackName' => '<string>',
    'SourceConfiguration' => [
        'ApplicationName' => '<string>',
        'TemplateName' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the Elastic Beanstalk application to associate with this configuration template.

Description
Type: string

An optional description for this configuration.

EnvironmentId
Type: string

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.

OptionSettings
Type: Array of ConfigurationOptionSetting structures

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 in the AWS Elastic Beanstalk Developer Guide.

PlatformArn
Type: string

The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.

If you specify PlatformArn, then don't specify SolutionStackName.

SolutionStackName
Type: string

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 in the AWS Elastic Beanstalk Developer Guide.

You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.

Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

SourceConfiguration
Type: SourceConfiguration structure

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.

Tags
Type: Array of Tag structures

Specifies the tags applied to the configuration template.

TemplateName
Required: Yes
Type: string

The name of the configuration template.

Constraint: This name must be unique per application.

Result Syntax

[
    'ApplicationName' => '<string>',
    'DateCreated' => <DateTime>,
    'DateUpdated' => <DateTime>,
    'DeploymentStatus' => 'deployed|pending|failed',
    'Description' => '<string>',
    'EnvironmentName' => '<string>',
    'OptionSettings' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'PlatformArn' => '<string>',
    'SolutionStackName' => '<string>',
    'TemplateName' => '<string>',
]

Result Details

Members
ApplicationName
Type: string

The name of the application associated with this configuration set.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date (in UTC time) when this configuration set was created.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date (in UTC time) when this configuration set was last modified.

DeploymentStatus
Type: string

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.

Description
Type: string

Describes this configuration set.

EnvironmentName
Type: string

If not null, the name of the environment for this configuration set.

OptionSettings
Type: Array of ConfigurationOptionSetting structures

A list of the configuration options and their values in this configuration set.

PlatformArn
Type: string

The ARN of the platform version.

SolutionStackName
Type: string

The name of the solution stack this configuration set uses.

TemplateName
Type: string

If not null, the name of the configuration template for this configuration set.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

TooManyBucketsException:

The specified account has reached its limit of Amazon S3 buckets.

TooManyConfigurationTemplatesException:

The specified account has reached its limit of configuration templates.

Examples

Example 1: To create a configuration template

The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j:

$result = $client->createConfigurationTemplate([
    'ApplicationName' => 'my-app',
    'EnvironmentId' => 'e-rpqsewtp2j',
    'TemplateName' => 'my-app-v1',
]);

Result syntax:

[
    'ApplicationName' => 'my-app',
    'DateCreated' => ,
    'DateUpdated' => ,
    'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
    'TemplateName' => 'my-app-v1',
]

CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createEnvironment([
    'ApplicationName' => '<string>', // REQUIRED
    'CNAMEPrefix' => '<string>',
    'Description' => '<string>',
    'EnvironmentName' => '<string>',
    'GroupName' => '<string>',
    'OperationsRole' => '<string>',
    'OptionSettings' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'OptionsToRemove' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
        ],
        // ...
    ],
    'PlatformArn' => '<string>',
    'SolutionStackName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TemplateName' => '<string>',
    'Tier' => [
        'Name' => '<string>',
        'Type' => '<string>',
        'Version' => '<string>',
    ],
    'VersionLabel' => '<string>',
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application that is associated with this environment.

CNAMEPrefix
Type: string

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.

Description
Type: string

Your description for this environment.

EnvironmentName
Type: string

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.

GroupName
Type: string

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) for details.

OperationsRole
Type: string

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. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

OptionSettings
Type: Array of ConfigurationOptionSetting structures

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.

OptionsToRemove
Type: Array of OptionSpecification structures

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

PlatformArn
Type: string

The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.

If you specify PlatformArn, don't specify SolutionStackName.

SolutionStackName
Type: string

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 in the AWS Elastic Beanstalk Platforms guide.

If you specify SolutionStackName, don't specify PlatformArn or TemplateName.

Tags
Type: Array of Tag structures

Specifies the tags applied to resources in the environment.

TemplateName
Type: string

The name of the Elastic Beanstalk configuration template to use with the environment.

If you specify TemplateName, then don't specify SolutionStackName.

Tier
Type: EnvironmentTier structure

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.

VersionLabel
Type: string

The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

Result Syntax

[
    'AbortableOperationInProgress' => true || false,
    'ApplicationName' => '<string>',
    'CNAME' => '<string>',
    'DateCreated' => <DateTime>,
    'DateUpdated' => <DateTime>,
    'Description' => '<string>',
    'EndpointURL' => '<string>',
    'EnvironmentArn' => '<string>',
    'EnvironmentId' => '<string>',
    'EnvironmentLinks' => [
        [
            'EnvironmentName' => '<string>',
            'LinkName' => '<string>',
        ],
        // ...
    ],
    'EnvironmentName' => '<string>',
    'Health' => 'Green|Yellow|Red|Grey',
    'HealthStatus' => 'NoData|Unknown|Pending|Ok|Info|Warning|Degraded|Severe|Suspended',
    'OperationsRole' => '<string>',
    'PlatformArn' => '<string>',
    'Resources' => [
        'LoadBalancer' => [
            'Domain' => '<string>',
            'Listeners' => [
                [
                    'Port' => <integer>,
                    'Protocol' => '<string>',
                ],
                // ...
            ],
            'LoadBalancerName' => '<string>',
        ],
    ],
    'SolutionStackName' => '<string>',
    'Status' => 'Aborting|Launching|Updating|LinkingFrom|LinkingTo|Ready|Terminating|Terminated',
    'TemplateName' => '<string>',
    'Tier' => [
        'Name' => '<string>',
        'Type' => '<string>',
        'Version' => '<string>',
    ],
    'VersionLabel' => '<string>',
]

Result Details

Members
AbortableOperationInProgress
Type: boolean

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.

ApplicationName
Type: string

The name of the application associated with this environment.

CNAME
Type: string

The URL to the CNAME for this environment.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date for this environment.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last modified date for this environment.

Description
Type: string

Describes this environment.

EndpointURL
Type: string

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

EnvironmentArn
Type: string

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

EnvironmentId
Type: string

The ID of this environment.

EnvironmentLinks
Type: Array of EnvironmentLink structures

A list of links to other environments in the same group.

EnvironmentName
Type: string

The name of this environment.

Health
Type: string

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

HealthStatus
Type: string

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

OperationsRole
Type: string

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

PlatformArn
Type: string

The ARN of the platform version.

Resources

The description of the AWS resources used by this environment.

SolutionStackName
Type: string

The name of the SolutionStack deployed with this environment.

Status
Type: string

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • 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.

TemplateName
Type: string

The name of the configuration template used to originally launch this environment.

Tier
Type: EnvironmentTier structure

Describes the current tier of this environment.

VersionLabel
Type: string

The application version deployed in this environment.

Errors

TooManyEnvironmentsException:

The specified account has reached its limit of environments.

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

Examples

Example 1: To create a new environment for an application

The following operation creates a new environment for version v1 of a java application named my-app:

$result = $client->createEnvironment([
    'ApplicationName' => 'my-app',
    'CNAMEPrefix' => 'my-app',
    'EnvironmentName' => 'my-env',
    'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
    'VersionLabel' => 'v1',
]);

Result syntax:

[
    'ApplicationName' => 'my-app',
    'CNAME' => 'my-app.elasticbeanstalk.com',
    'DateCreated' => ,
    'DateUpdated' => ,
    'EnvironmentId' => 'e-izqpassy4h',
    'EnvironmentName' => 'my-env',
    'Health' => 'Grey',
    'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
    'Status' => 'Launching',
    'Tier' => [
        'Name' => 'WebServer',
        'Type' => 'Standard',
        'Version' => ' ',
    ],
    'VersionLabel' => 'v1',
]

CreatePlatformVersion

$result = $client->createPlatformVersion([/* ... */]);
$promise = $client->createPlatformVersionAsync([/* ... */]);

Create a new version of your custom platform.

Parameter Syntax

$result = $client->createPlatformVersion([
    'EnvironmentName' => '<string>',
    'OptionSettings' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'PlatformDefinitionBundle' => [ // REQUIRED
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
    ],
    'PlatformName' => '<string>', // REQUIRED
    'PlatformVersion' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
EnvironmentName
Type: string

The name of the builder environment.

OptionSettings
Type: Array of ConfigurationOptionSetting structures

The configuration option settings to apply to the builder environment.

PlatformDefinitionBundle
Required: Yes
Type: S3Location structure

The location of the platform definition archive in Amazon S3.

PlatformName
Required: Yes
Type: string

The name of your custom platform.

PlatformVersion
Required: Yes
Type: string

The number, such as 1.0.2, for the new platform version.

Tags
Type: Array of Tag structures

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.

Result Syntax

[
    'Builder' => [
        'ARN' => '<string>',
    ],
    'PlatformSummary' => [
        'OperatingSystemName' => '<string>',
        'OperatingSystemVersion' => '<string>',
        'PlatformArn' => '<string>',
        'PlatformBranchLifecycleState' => '<string>',
        'PlatformBranchName' => '<string>',
        'PlatformCategory' => '<string>',
        'PlatformLifecycleState' => '<string>',
        'PlatformOwner' => '<string>',
        'PlatformStatus' => 'Creating|Failed|Ready|Deleting|Deleted',
        'PlatformVersion' => '<string>',
        'SupportedAddonList' => ['<string>', ...],
        'SupportedTierList' => ['<string>', ...],
    ],
]

Result Details

Members
Builder
Type: Builder structure

The builder used to create the custom platform.

PlatformSummary
Type: PlatformSummary structure

Detailed information about the new version of the custom platform.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

ElasticBeanstalkServiceException:

A generic service exception has occurred.

TooManyPlatformsException:

You have exceeded the maximum number of allowed platforms associated with the account.

CreateStorageLocation

$result = $client->createStorageLocation([/* ... */]);
$promise = $client->createStorageLocationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createStorageLocation([
]);

Parameter Details

Members

Result Syntax

[
    'S3Bucket' => '<string>',
]

Result Details

Members
S3Bucket
Type: string

The name of the Amazon S3 bucket created.

Errors

TooManyBucketsException:

The specified account has reached its limit of Amazon S3 buckets.

S3SubscriptionRequiredException:

The specified account does not have a subscription to Amazon S3.

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

Examples

Example 1: To create a new environment for an application

The following operation creates a new environment for version v1 of a java application named my-app:

$result = $client->createStorageLocation([
]);

Result syntax:

[
    'S3Bucket' => 'elasticbeanstalk-us-west-2-0123456789012',
]

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

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

You cannot delete an application that has a running environment.

Parameter Syntax

$result = $client->deleteApplication([
    'ApplicationName' => '<string>', // REQUIRED
    'TerminateEnvByForce' => true || false,
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application to delete.

TerminateEnvByForce
Type: boolean

When set to true, running environments will be terminated before deleting the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

OperationInProgressException:

Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

Examples

Example 1: To delete an application

The following operation deletes an application named my-app:

$result = $client->deleteApplication([
    'ApplicationName' => 'my-app',
]);

DeleteApplicationVersion

$result = $client->deleteApplicationVersion([/* ... */]);
$promise = $client->deleteApplicationVersionAsync([/* ... */]);

Deletes the specified version from the specified application.

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

Parameter Syntax

$result = $client->deleteApplicationVersion([
    'ApplicationName' => '<string>', // REQUIRED
    'DeleteSourceBundle' => true || false,
    'VersionLabel' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application to which the version belongs.

DeleteSourceBundle
Type: boolean

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.

VersionLabel
Required: Yes
Type: string

The label of the version to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

SourceBundleDeletionException:

Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

OperationInProgressException:

Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

S3LocationNotInServiceRegionException:

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

Examples

Example 1: To delete an application version

The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app:

$result = $client->deleteApplicationVersion([
    'ApplicationName' => 'my-app',
    'DeleteSourceBundle' => 1,
    'VersionLabel' => '22a0-stage-150819_182129',
]);

DeleteConfigurationTemplate

$result = $client->deleteConfigurationTemplate([/* ... */]);
$promise = $client->deleteConfigurationTemplateAsync([/* ... */]);

Deletes the specified configuration template.

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.

Parameter Syntax

$result = $client->deleteConfigurationTemplate([
    'ApplicationName' => '<string>', // REQUIRED
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application to delete the configuration template from.

TemplateName
Required: Yes
Type: string

The name of the configuration template to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

OperationInProgressException:

Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

Examples

Example 1: To delete a configuration template

The following operation deletes a configuration template named my-template for an application named my-app:

$result = $client->deleteConfigurationTemplate([
    'ApplicationName' => 'my-app',
    'TemplateName' => 'my-template',
]);

DeleteEnvironmentConfiguration

$result = $client->deleteEnvironmentConfiguration([/* ... */]);
$promise = $client->deleteEnvironmentConfigurationAsync([/* ... */]);

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 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.

Parameter Syntax

$result = $client->deleteEnvironmentConfiguration([
    'ApplicationName' => '<string>', // REQUIRED
    'EnvironmentName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application the environment is associated with.

EnvironmentName
Required: Yes
Type: string

The name of the environment to delete the draft configuration from.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete a draft configuration

The following operation deletes a draft configuration for an environment named my-env:

$result = $client->deleteEnvironmentConfiguration([
    'ApplicationName' => 'my-app',
    'EnvironmentName' => 'my-env',
]);

DeletePlatformVersion

$result = $client->deletePlatformVersion([/* ... */]);
$promise = $client->deletePlatformVersionAsync([/* ... */]);

Deletes the specified version of a custom platform.

Parameter Syntax

$result = $client->deletePlatformVersion([
    'PlatformArn' => '<string>',
]);

Parameter Details

Members
PlatformArn
Type: string

The ARN of the version of the custom platform.

Result Syntax

[
    'PlatformSummary' => [
        'OperatingSystemName' => '<string>',
        'OperatingSystemVersion' => '<string>',
        'PlatformArn' => '<string>',
        'PlatformBranchLifecycleState' => '<string>',
        'PlatformBranchName' => '<string>',
        'PlatformCategory' => '<string>',
        'PlatformLifecycleState' => '<string>',
        'PlatformOwner' => '<string>',
        'PlatformStatus' => 'Creating|Failed|Ready|Deleting|Deleted',
        'PlatformVersion' => '<string>',
        'SupportedAddonList' => ['<string>', ...],
        'SupportedTierList' => ['<string>', ...],
    ],
]

Result Details

Members
PlatformSummary
Type: PlatformSummary structure

Detailed information about the version of the custom platform.

Errors

OperationInProgressException:

Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

ElasticBeanstalkServiceException:

A generic service exception has occurred.

PlatformVersionStillReferencedException:

You cannot delete the platform version because there are still environments running on it.

DescribeAccountAttributes

$result = $client->describeAccountAttributes([/* ... */]);
$promise = $client->describeAccountAttributesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeAccountAttributes([
]);

Parameter Details

Members

Result Syntax

[
    'ResourceQuotas' => [
        'ApplicationQuota' => [
            'Maximum' => <integer>,
        ],
        'ApplicationVersionQuota' => [
            'Maximum' => <integer>,
        ],
        'ConfigurationTemplateQuota' => [
            'Maximum' => <integer>,
        ],
        'CustomPlatformQuota' => [
            'Maximum' => <integer>,
        ],
        'EnvironmentQuota' => [
            'Maximum' => <integer>,
        ],
    ],
]

Result Details

Members
ResourceQuotas
Type: ResourceQuotas structure

The Elastic Beanstalk resource quotas associated with the calling AWS account.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

DescribeApplicationVersions

$result = $client->describeApplicationVersions([/* ... */]);
$promise = $client->describeApplicationVersionsAsync([/* ... */]);

Retrieve a list of application versions.

Parameter Syntax

$result = $client->describeApplicationVersions([
    'ApplicationName' => '<string>',
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
    'VersionLabels' => ['<string>', ...],
]);

Parameter Details

Members
ApplicationName
Type: string

Specify an application name to show only application versions for that application.

MaxRecords
Type: int

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.

NextToken
Type: string

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.

VersionLabels
Type: Array of strings

Specify a version label to show a specific application version.

Result Syntax

[
    'ApplicationVersions' => [
        [
            'ApplicationName' => '<string>',
            'ApplicationVersionArn' => '<string>',
            'BuildArn' => '<string>',
            'DateCreated' => <DateTime>,
            'DateUpdated' => <DateTime>,
            'Description' => '<string>',
            'SourceBuildInformation' => [
                'SourceLocation' => '<string>',
                'SourceRepository' => 'CodeCommit|S3',
                'SourceType' => 'Git|Zip',
            ],
            'SourceBundle' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'Status' => 'Processed|Unprocessed|Failed|Processing|Building',
            'VersionLabel' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ApplicationVersions
Type: Array of ApplicationVersionDescription structures

List of ApplicationVersionDescription objects sorted in order of creation.

NextToken
Type: string

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Errors

There are no errors described for this operation.

Examples

Example 1: To view information about an application version

The following operation retrieves information about an application version labeled v2:

$result = $client->describeApplicationVersions([
    'ApplicationName' => 'my-app',
    'VersionLabels' => [
        'v2',
    ],
]);

Result syntax:

[
    'ApplicationVersions' => [
        [
            'ApplicationName' => 'my-app',
            'DateCreated' => ,
            'DateUpdated' => ,
            'Description' => 'update cover page',
            'SourceBundle' => [
                'S3Bucket' => 'elasticbeanstalk-us-west-2-015321684451',
                'S3Key' => 'my-app/5026-stage-150723_224258.war',
            ],
            'VersionLabel' => 'v2',
        ],
        [
            'ApplicationName' => 'my-app',
            'DateCreated' => ,
            'DateUpdated' => ,
            'Description' => 'initial version',
            'SourceBundle' => [
                'S3Bucket' => 'elasticbeanstalk-us-west-2-015321684451',
                'S3Key' => 'my-app/5026-stage-150723_222618.war',
            ],
            'VersionLabel' => 'v1',
        ],
    ],
]

DescribeApplications

$result = $client->describeApplications([/* ... */]);
$promise = $client->describeApplicationsAsync([/* ... */]);

Returns the descriptions of existing applications.

Parameter Syntax

$result = $client->describeApplications([
    'ApplicationNames' => ['<string>', ...],
]);

Parameter Details

Members
ApplicationNames
Type: Array of strings

If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

Result Syntax

[
    'Applications' => [
        [
            'ApplicationArn' => '<string>',
            'ApplicationName' => '<string>',
            'ConfigurationTemplates' => ['<string>', ...],
            'DateCreated' => <DateTime>,
            'DateUpdated' => <DateTime>,
            'Description' => '<string>',
            'ResourceLifecycleConfig' => [
                'ServiceRole' => '<string>',
                'VersionLifecycleConfig' => [
                    'MaxAgeRule' => [
                        'DeleteSourceFromS3' => true || false,
                        'Enabled' => true || false,
                        'MaxAgeInDays' => <integer>,
                    ],
                    'MaxCountRule' => [
                        'DeleteSourceFromS3' => true || false,
                        'Enabled' => true || false,
                        'MaxCount' => <integer>,
                    ],
                ],
            ],
            'Versions' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
Applications
Type: Array of ApplicationDescription structures

This parameter contains a list of ApplicationDescription.

Errors

There are no errors described for this operation.

Examples

Example 1: To view a list of applications

The following operation retrieves information about applications in the current region:

$result = $client->describeApplications([
]);

Result syntax:

[
    'Applications' => [
        [
            'ApplicationName' => 'ruby',
            'ConfigurationTemplates' => [
            ],
            'DateCreated' => ,
            'DateUpdated' => ,
            'Versions' => [
                'Sample Application',
            ],
        ],
        [
            'ApplicationName' => 'pythonsample',
            'ConfigurationTemplates' => [
            ],
            'DateCreated' => ,
            'DateUpdated' => ,
            'Description' => 'Application created from the EB CLI using "eb init"',
            'Versions' => [
                'Sample Application',
            ],
        ],
        [
            'ApplicationName' => 'nodejs-example',
            'ConfigurationTemplates' => [
            ],
            'DateCreated' => ,
            'DateUpdated' => ,
            'Versions' => [
                'add elasticache',
                'First Release',
            ],
        ],
    ],
]

DescribeConfigurationOptions

$result = $client->describeConfigurationOptions([/* ... */]);
$promise = $client->describeConfigurationOptionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeConfigurationOptions([
    'ApplicationName' => '<string>',
    'EnvironmentName' => '<string>',
    'Options' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
        ],
        // ...
    ],
    'PlatformArn' => '<string>',
    'SolutionStackName' => '<string>',
    'TemplateName' => '<string>',
]);

Parameter Details

Members
ApplicationName
Type: string

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.

EnvironmentName
Type: string

The name of the environment whose configuration options you want to describe.

Options
Type: Array of OptionSpecification structures

If specified, restricts the descriptions to only the specified options.

PlatformArn
Type: string

The ARN of the custom platform.

SolutionStackName
Type: string

The name of the solution stack whose configuration options you want to describe.

TemplateName
Type: string

The name of the configuration template whose configuration options you want to describe.

Result Syntax

[
    'Options' => [
        [
            'ChangeSeverity' => '<string>',
            'DefaultValue' => '<string>',
            'MaxLength' => <integer>,
            'MaxValue' => <integer>,
            'MinValue' => <integer>,
            'Name' => '<string>',
            'Namespace' => '<string>',
            'Regex' => [
                'Label' => '<string>',
                'Pattern' => '<string>',
            ],
            'UserDefined' => true || false,
            'ValueOptions' => ['<string>', ...],
            'ValueType' => 'Scalar|List',
        ],
        // ...
    ],
    'PlatformArn' => '<string>',
    'SolutionStackName' => '<string>',
]

Result Details

Members
Options
Type: Array of ConfigurationOptionDescription structures
PlatformArn
Type: string

The ARN of the platform version.

SolutionStackName
Type: string

The name of the solution stack these configuration options belong to.

Errors

TooManyBucketsException:

The specified account has reached its limit of Amazon S3 buckets.

Examples

Example 1: To view configuration options for an environment

The following operation retrieves descriptions of all available configuration options for an environment named my-env:

$result = $client->describeConfigurationOptions([
    'ApplicationName' => 'my-app',
    'EnvironmentName' => 'my-env',
]);

Result syntax:

[
    'Options' => [
        [
            'ChangeSeverity' => 'NoInterruption',
            'DefaultValue' => '30',
            'MaxValue' => 300,
            'MinValue' => 5,
            'Name' => 'Interval',
            'Namespace' => 'aws:elb:healthcheck',
            'UserDefined' => ,
            'ValueType' => 'Scalar',
        ],
        [
            'ChangeSeverity' => 'NoInterruption',
            'DefaultValue' => '2000000',
            'MinValue' => 0,
            'Name' => 'LowerThreshold',
            'Namespace' => 'aws:autoscaling:trigger',
            'UserDefined' => ,
            'ValueType' => 'Scalar',
        ],
    ],
]

DescribeConfigurationSettings

$result = $client->describeConfigurationSettings([/* ... */]);
$promise = $client->describeConfigurationSettingsAsync([/* ... */]);

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.

Related Topics

Parameter Syntax

$result = $client->describeConfigurationSettings([
    'ApplicationName' => '<string>', // REQUIRED
    'EnvironmentName' => '<string>',
    'TemplateName' => '<string>',
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The application for the environment or configuration template.

EnvironmentName
Type: string

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.

TemplateName
Type: string

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.

Result Syntax

[
    'ConfigurationSettings' => [
        [
            'ApplicationName' => '<string>',
            'DateCreated' => <DateTime>,
            'DateUpdated' => <DateTime>,
            'DeploymentStatus' => 'deployed|pending|failed',
            'Description' => '<string>',
            'EnvironmentName' => '<string>',
            'OptionSettings' => [
                [
                    'Namespace' => '<string>',
                    'OptionName' => '<string>',
                    'ResourceName' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'PlatformArn' => '<string>',
            'SolutionStackName' => '<string>',
            'TemplateName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ConfigurationSettings
Type: Array of ConfigurationSettingsDescription structures

Errors

TooManyBucketsException:

The specified account has reached its limit of Amazon S3 buckets.

Examples

Example 1: To view configurations settings for an environment

The following operation retrieves configuration settings for an environment named my-env:

$result = $client->describeConfigurationSettings([
    'ApplicationName' => 'my-app',
    'EnvironmentName' => 'my-env',
]);

Result syntax:

[
    'ConfigurationSettings' => [
        [
            'ApplicationName' => 'my-app',
            'DateCreated' => ,
            'DateUpdated' => ,
            'DeploymentStatus' => 'deployed',
            'Description' => 'Environment created from the EB CLI using "eb create"',
            'EnvironmentName' => 'my-env',
            'OptionSettings' => [
                [
                    'Namespace' => 'aws:autoscaling:asg',
                    'OptionName' => 'Availability Zones',
                    'ResourceName' => 'AWSEBAutoScalingGroup',
                    'Value' => 'Any',
                ],
                [
                    'Namespace' => 'aws:autoscaling:asg',
                    'OptionName' => 'Cooldown',
                    'ResourceName' => 'AWSEBAutoScalingGroup',
                    'Value' => '360',
                ],
                [
                    'Namespace' => 'aws:elb:policies',
                    'OptionName' => 'ConnectionDrainingTimeout',
                    'ResourceName' => 'AWSEBLoadBalancer',
                    'Value' => '20',
                ],
                [
                    'Namespace' => 'aws:elb:policies',
                    'OptionName' => 'ConnectionSettingIdleTimeout',
                    'ResourceName' => 'AWSEBLoadBalancer',
                    'Value' => '60',
                ],
            ],
            'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
        ],
    ],
]

DescribeEnvironmentHealth

$result = $client->describeEnvironmentHealth([/* ... */]);
$promise = $client->describeEnvironmentHealthAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEnvironmentHealth([
    'AttributeNames' => ['<string>', ...],
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
]);

Parameter Details

Members
AttributeNames
Type: Array of strings

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.

EnvironmentId
Type: string

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

EnvironmentName
Type: string

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

Result Syntax

[
    'ApplicationMetrics' => [
        'Duration' => <integer>,
        'Latency' => [
            'P10' => <float>,
            'P50' => <float>,
            'P75' => <float>,
            'P85' => <float>,
            'P90' => <float>,
            'P95' => <float>,
            'P99' => <float>,
            'P999' => <float>,
        ],
        'RequestCount' => <integer>,
        'StatusCodes' => [
            'Status2xx' => <integer>,
            'Status3xx' => <integer>,
            'Status4xx' => <integer>,
            'Status5xx' => <integer>,
        ],
    ],
    'Causes' => ['<string>', ...],
    'Color' => '<string>',
    'EnvironmentName' => '<string>',
    'HealthStatus' => '<string>',
    'InstancesHealth' => [
        'Degraded' => <integer>,
        'Info' => <integer>,
        'NoData' => <integer>,
        'Ok' => <integer>,
        'Pending' => <integer>,
        'Severe' => <integer>,
        'Unknown' => <integer>,
        'Warning' => <integer>,
    ],
    'RefreshedAt' => <DateTime>,
    'Status' => 'Green|Yellow|Red|Grey',
]

Result Details

Members
ApplicationMetrics
Type: ApplicationMetrics structure

Application request metrics for the environment.

Causes
Type: Array of strings

Descriptions of the data that contributed to the environment's current health status.

Color
Type: string

The health color of the environment.

EnvironmentName
Type: string

The environment's name.

HealthStatus
Type: string

The health status of the environment. For example, Ok.

InstancesHealth
Type: InstanceHealthSummary structure

Summary health information for the instances in the environment.

RefreshedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the health information was retrieved.

Status
Type: string

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

Errors

InvalidRequestException:

One or more input parameters is not valid. Please correct the input parameters and try the operation again.

ElasticBeanstalkServiceException:

A generic service exception has occurred.

Examples

Example 1: To view environment health

The following operation retrieves overall health information for an environment named my-env:

$result = $client->describeEnvironmentHealth([
    'AttributeNames' => [
        'All',
    ],
    'EnvironmentName' => 'my-env',
]);

Result syntax:

[
    'ApplicationMetrics' => [
        'Duration' => 10,
        'Latency' => [
            'P10' => 0.001,
            'P50' => 0.001,
            'P75' => 0.002,
            'P85' => 0.003,
            'P90' => 0.003,
            'P95' => 0.004,
            'P99' => 0.004,
            'P999' => 0.004,
        ],
        'RequestCount' => 45,
        'StatusCodes' => [
            'Status2xx' => 45,
            'Status3xx' => 0,
            'Status4xx' => 0,
            'Status5xx' => 0,
        ],
    ],
    'Causes' => [
    ],
    'Color' => 'Green',
    'EnvironmentName' => 'my-env',
    'HealthStatus' => 'Ok',
    'InstancesHealth' => [
        'Degraded' => 0,
        'Info' => 0,
        'NoData' => 0,
        'Ok' => 1,
        'Pending' => 0,
        'Severe' => 0,
        'Unknown' => 0,
        'Warning' => 0,
    ],
    'RefreshedAt' => ,
]

DescribeEnvironmentManagedActionHistory

$result = $client->describeEnvironmentManagedActionHistory([/* ... */]);
$promise = $client->describeEnvironmentManagedActionHistoryAsync([/* ... */]);

Lists an environment's completed and failed managed actions.

Parameter Syntax

$result = $client->describeEnvironmentManagedActionHistory([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
    'MaxItems' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
EnvironmentId
Type: string

The environment ID of the target environment.

EnvironmentName
Type: string

The name of the target environment.

MaxItems
Type: int

The maximum number of items to return for a single request.

NextToken
Type: string

The pagination token returned by a previous request.

Result Syntax

[
    'ManagedActionHistoryItems' => [
        [
            'ActionDescription' => '<string>',
            'ActionId' => '<string>',
            'ActionType' => 'InstanceRefresh|PlatformUpdate|Unknown',
            'ExecutedTime' => <DateTime>,
            'FailureDescription' => '<string>',
            'FailureType' => 'UpdateCancelled|CancellationFailed|RollbackFailed|RollbackSuccessful|InternalFailure|InvalidEnvironmentState|PermissionsError',
            'FinishedTime' => <DateTime>,
            'Status' => 'Completed|Failed|Unknown',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ManagedActionHistoryItems
Type: Array of ManagedActionHistoryItem structures

A list of completed and failed managed actions.

NextToken
Type: string

A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.

Errors

ElasticBeanstalkServiceException:

A generic service exception has occurred.

DescribeEnvironmentManagedActions

$result = $client->describeEnvironmentManagedActions([/* ... */]);
$promise = $client->describeEnvironmentManagedActionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEnvironmentManagedActions([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
    'Status' => 'Scheduled|Pending|Running|Unknown',
]);

Parameter Details

Members
EnvironmentId
Type: string

The environment ID of the target environment.

EnvironmentName
Type: string

The name of the target environment.

Status
Type: string

To show only actions with a particular status, specify a status.

Result Syntax

[
    'ManagedActions' => [
        [
            'ActionDescription' => '<string>',
            'ActionId' => '<string>',
            'ActionType' => 'InstanceRefresh|PlatformUpdate|Unknown',
            'Status' => 'Scheduled|Pending|Running|Unknown',
            'WindowStartTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
ManagedActions
Type: Array of ManagedAction structures

A list of upcoming and in-progress managed actions.

Errors

ElasticBeanstalkServiceException:

A generic service exception has occurred.

DescribeEnvironmentResources

$result = $client->describeEnvironmentResources([/* ... */]);
$promise = $client->describeEnvironmentResourcesAsync([/* ... */]);

Returns AWS resources for this environment.

Parameter Syntax

$result = $client->describeEnvironmentResources([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
]);

Parameter Details

Members
EnvironmentId
Type: string

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.

EnvironmentName
Type: string

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.

Result Syntax

[
    'EnvironmentResources' => [
        'AutoScalingGroups' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'EnvironmentName' => '<string>',
        'Instances' => [
            [
                'Id' => '<string>',
            ],
            // ...
        ],
        'LaunchConfigurations' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'LaunchTemplates' => [
            [
                'Id' => '<string>',
            ],
            // ...
        ],
        'LoadBalancers' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'Queues' => [
            [
                'Name' => '<string>',
                'URL' => '<string>',
            ],
            // ...
        ],
        'Triggers' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
EnvironmentResources

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

Examples

Example 1: To view information about the AWS resources in your environment

The following operation retrieves information about resources in an environment named my-env:

$result = $client->describeEnvironmentResources([
    'EnvironmentName' => 'my-env',
]);

Result syntax:

[
    'EnvironmentResources' => [
        'AutoScalingGroups' => [
            [
                'Name' => 'awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT',
            ],
        ],
        'EnvironmentName' => 'my-env',
        'Instances' => [
            [
                'Id' => 'i-0c91c786',
            ],
        ],
        'LaunchConfigurations' => [
            [
                'Name' => 'awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2',
            ],
        ],
        'LoadBalancers' => [
            [
                'Name' => 'awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0',
            ],
        ],
        'Queues' => [
        ],
        'Triggers' => [
        ],
    ],
]

DescribeEnvironments

$result = $client->describeEnvironments([/* ... */]);
$promise = $client->describeEnvironmentsAsync([/* ... */]);

Returns descriptions for existing environments.

Parameter Syntax

$result = $client->describeEnvironments([
    'ApplicationName' => '<string>',
    'EnvironmentIds' => ['<string>', ...],
    'EnvironmentNames' => ['<string>', ...],
    'IncludeDeleted' => true || false,
    'IncludedDeletedBackTo' => <integer || string || DateTime>,
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
    'VersionLabel' => '<string>',
]);

Parameter Details

Members
ApplicationName
Type: string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

EnvironmentIds
Type: Array of strings

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

EnvironmentNames
Type: Array of strings

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

IncludeDeleted
Type: boolean

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

IncludedDeletedBackTo
Type: timestamp (string|DateTime or anything parsable by strtotime)

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

MaxRecords
Type: int

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.

NextToken
Type: string

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.

VersionLabel
Type: string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Result Syntax

[
    'Environments' => [
        [
            'AbortableOperationInProgress' => true || false,
            'ApplicationName' => '<string>',
            'CNAME' => '<string>',
            'DateCreated' => <DateTime>,
            'DateUpdated' => <DateTime>,
            'Description' => '<string>',
            'EndpointURL' => '<string>',
            'EnvironmentArn' => '<string>',
            'EnvironmentId' => '<string>',
            'EnvironmentLinks' => [
                [
                    'EnvironmentName' => '<string>',
                    'LinkName' => '<string>',
                ],
                // ...
            ],
            'EnvironmentName' => '<string>',
            'Health' => 'Green|Yellow|Red|Grey',
            'HealthStatus' => 'NoData|Unknown|Pending|Ok|Info|Warning|Degraded|Severe|Suspended',
            'OperationsRole' => '<string>',
            'PlatformArn' => '<string>',
            'Resources' => [
                'LoadBalancer' => [
                    'Domain' => '<string>',
                    'Listeners' => [
                        [
                            'Port' => <integer>,
                            'Protocol' => '<string>',
                        ],
                        // ...
                    ],
                    'LoadBalancerName' => '<string>',
                ],
            ],
            'SolutionStackName' => '<string>',
            'Status' => 'Aborting|Launching|Updating|LinkingFrom|LinkingTo|Ready|Terminating|Terminated',
            'TemplateName' => '<string>',
            'Tier' => [
                'Name' => '<string>',
                'Type' => '<string>',
                'Version' => '<string>',
            ],
            'VersionLabel' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Environments
Type: Array of EnvironmentDescription structures

Returns an EnvironmentDescription list.

NextToken
Type: string

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Errors

There are no errors described for this operation.

Examples

Example 1: To view information about an environment

The following operation retrieves information about an environment named my-env:

$result = $client->describeEnvironments([
    'EnvironmentNames' => [
        'my-env',
    ],
]);

Result syntax:

[
    'Environments' => [
        [
            'AbortableOperationInProgress' => ,
            'ApplicationName' => 'my-app',
            'CNAME' => 'my-env.elasticbeanstalk.com',
            'DateCreated' => ,
            'DateUpdated' => ,
            'EndpointURL' => 'awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com',
            'EnvironmentId' => 'e-rpqsewtp2j',
            'EnvironmentName' => 'my-env',
            'Health' => 'Green',
            'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
            'Status' => 'Ready',
            'Tier' => [
                'Name' => 'WebServer',
                'Type' => 'Standard',
                'Version' => ' ',
            ],
            'VersionLabel' => '7f58-stage-150812_025409',
        ],
    ],
]

DescribeEvents

$result = $client->describeEvents([/* ... */]);
$promise = $client->describeEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeEvents([
    'ApplicationName' => '<string>',
    'EndTime' => <integer || string || DateTime>,
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
    'PlatformArn' => '<string>',
    'RequestId' => '<string>',
    'Severity' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
    'StartTime' => <integer || string || DateTime>,
    'TemplateName' => '<string>',
    'VersionLabel' => '<string>',
]);

Parameter Details

Members
ApplicationName
Type: string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

EnvironmentId
Type: string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

EnvironmentName
Type: string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

MaxRecords
Type: int

Specifies the maximum number of events that can be returned, beginning with the most recent event.

NextToken
Type: string

Pagination token. If specified, the events return the next batch of results.

PlatformArn
Type: string

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

RequestId
Type: string

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

Severity
Type: string

If specified, limits the events returned from this call to include only those with the specified severity or higher.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

TemplateName
Type: string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

VersionLabel
Type: string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Result Syntax

[
    'Events' => [
        [
            'ApplicationName' => '<string>',
            'EnvironmentName' => '<string>',
            'EventDate' => <DateTime>,
            'Message' => '<string>',
            'PlatformArn' => '<string>',
            'RequestId' => '<string>',
            'Severity' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
            'TemplateName' => '<string>',
            'VersionLabel' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Events
Type: Array of EventDescription structures

A list of EventDescription.

NextToken
Type: string

If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.

Errors

There are no errors described for this operation.

Examples

Example 1: To view events for an environment

The following operation retrieves events for an environment named my-env:

$result = $client->describeEvents([
    'EnvironmentName' => 'my-env',
]);

Result syntax:

[
    'Events' => [
        [
            'ApplicationName' => 'my-app',
            'EnvironmentName' => 'my-env',
            'EventDate' => ,
            'Message' => 'Environment health has transitioned from Info to Ok.',
            'Severity' => 'INFO',
        ],
        [
            'ApplicationName' => 'my-app',
            'EnvironmentName' => 'my-env',
            'EventDate' => ,
            'Message' => 'Environment update completed successfully.',
            'RequestId' => 'b7f3960b-4709-11e5-ba1e-07e16200da41',
            'Severity' => 'INFO',
        ],
        [
            'ApplicationName' => 'my-app',
            'EnvironmentName' => 'my-env',
            'EventDate' => ,
            'Message' => 'Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.',
            'RequestId' => 'ca8dfbf6-41ef-11e5-988b-651aa638f46b',
            'Severity' => 'INFO',
        ],
        [
            'ApplicationName' => 'my-app',
            'EnvironmentName' => 'my-env',
            'EventDate' => ,
            'Message' => 'createEnvironment is starting.',
            'RequestId' => 'cdfba8f6-41ef-11e5-988b-65638f41aa6b',
            'Severity' => 'INFO',
        ],
    ],
]

DescribeInstancesHealth

$result = $client->describeInstancesHealth([/* ... */]);
$promise = $client->describeInstancesHealthAsync([/* ... */]);

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

Parameter Syntax

$result = $client->describeInstancesHealth([
    'AttributeNames' => ['<string>', ...],
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
AttributeNames
Type: Array of strings

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.

EnvironmentId
Type: string

Specify the AWS Elastic Beanstalk environment by ID.

EnvironmentName
Type: string

Specify the AWS Elastic Beanstalk environment by name.

NextToken
Type: string

Specify the pagination token returned by a previous call.

Result Syntax

[
    'InstanceHealthList' => [
        [
            'ApplicationMetrics' => [
                'Duration' => <integer>,
                'Latency' => [
                    'P10' => <float>,
                    'P50' => <float>,
                    'P75' => <float>,
                    'P85' => <float>,
                    'P90' => <float>,
                    'P95' => <float>,
                    'P99' => <float>,
                    'P999' => <float>,
                ],
                'RequestCount' => <integer>,
                'StatusCodes' => [
                    'Status2xx' => <integer>,
                    'Status3xx' => <integer>,
                    'Status4xx' => <integer>,
                    'Status5xx' => <integer>,
                ],
            ],
            'AvailabilityZone' => '<string>',
            'Causes' => ['<string>', ...],
            'Color' => '<string>',
            'Deployment' => [
                'DeploymentId' => <integer>,
                'DeploymentTime' => <DateTime>,
                'Status' => '<string>',
                'VersionLabel' => '<string>',
            ],
            'HealthStatus' => '<string>',
            'InstanceId' => '<string>',
            'InstanceType' => '<string>',
            'LaunchedAt' => <DateTime>,
            'System' => [
                'CPUUtilization' => [
                    'IOWait' => <float>,
                    'IRQ' => <float>,
                    'Idle' => <float>,
                    'Nice' => <float>,
                    'Privileged' => <float>,
                    'SoftIRQ' => <float>,
                    'System' => <float>,
                    'User' => <float>,
                ],
                'LoadAverage' => [<float>, ...],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'RefreshedAt' => <DateTime>,
]

Result Details

Members
InstanceHealthList
Type: Array of SingleInstanceHealth structures

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.

NextToken
Type: string

Pagination token for the next page of results, if available.

RefreshedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the health information was retrieved.

Errors

InvalidRequestException:

One or more input parameters is not valid. Please correct the input parameters and try the operation again.

ElasticBeanstalkServiceException:

A generic service exception has occurred.

Examples

Example 1: To view environment health

The following operation retrieves health information for instances in an environment named my-env:

$result = $client->describeInstancesHealth([
    'AttributeNames' => [
        'All',
    ],
    'EnvironmentName' => 'my-env',
]);

Result syntax:

[
    'InstanceHealthList' => [
        [
            'ApplicationMetrics' => [
                'Duration' => 10,
                'Latency' => [
                    'P10' => 0,
                    'P50' => 0.001,
                    'P75' => 0.002,
                    'P85' => 0.003,
                    'P90' => 0.004,
                    'P95' => 0.005,
                    'P99' => 0.006,
                    'P999' => 0.006,
                ],
                'RequestCount' => 48,
                'StatusCodes' => [
                    'Status2xx' => 47,
                    'Status3xx' => 0,
                    'Status4xx' => 1,
                    'Status5xx' => 0,
                ],
            ],
            'Causes' => [
            ],
            'Color' => 'Green',
            'HealthStatus' => 'Ok',
            'InstanceId' => 'i-08691cc7',
            'LaunchedAt' => ,
            'System' => [
                'CPUUtilization' => [
                    'IOWait' => 0.2,
                    'IRQ' => 0,
                    'Idle' => 97.8,
                    'Nice' => 0.1,
                    'SoftIRQ' => 0.1,
                    'System' => 0.3,
                    'User' => 1.5,
                ],
                'LoadAverage' => [
                    0,
                    0.02,
                    0.05,
                ],
            ],
        ],
    ],
    'RefreshedAt' => ,
]

DescribePlatformVersion

$result = $client->describePlatformVersion([/* ... */]);
$promise = $client->describePlatformVersionAsync([/* ... */]);

Describes a platform version. Provides full details. Compare to ListPlatformVersions, 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.

Parameter Syntax

$result = $client->describePlatformVersion([
    'PlatformArn' => '<string>',
]);

Parameter Details

Members
PlatformArn
Type: string

The ARN of the platform version.

Result Syntax

[
    'PlatformDescription' => [
        'CustomAmiList' => [
            [
                'ImageId' => '<string>',
                'VirtualizationType' => '<string>',
            ],
            // ...
        ],
        'DateCreated' => <DateTime>,
        'DateUpdated' => <DateTime>,
        'Description' => '<string>',
        'Frameworks' => [
            [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'Maintainer' => '<string>',
        'OperatingSystemName' => '<string>',
        'OperatingSystemVersion' => '<string>',
        'PlatformArn' => '<string>',
        'PlatformBranchLifecycleState' => '<string>',
        'PlatformBranchName' => '<string>',
        'PlatformCategory' => '<string>',
        'PlatformLifecycleState' => '<string>',
        'PlatformName' => '<string>',
        'PlatformOwner' => '<string>',
        'PlatformStatus' => 'Creating|Failed|Ready|Deleting|Deleted',
        'PlatformVersion' => '<string>',
        'ProgrammingLanguages' => [
            [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'SolutionStackName' => '<string>',
        'SupportedAddonList' => ['<string>', ...],
        'SupportedTierList' => ['<string>', ...],
    ],
]

Result Details

Members
PlatformDescription
Type: PlatformDescription structure

Detailed information about the platform version.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

ElasticBeanstalkServiceException:

A generic service exception has occurred.

DisassociateEnvironmentOperationsRole

$result = $client->disassociateEnvironmentOperationsRole([/* ... */]);
$promise = $client->disassociateEnvironmentOperationsRoleAsync([/* ... */]);

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. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Parameter Syntax

$result = $client->disassociateEnvironmentOperationsRole([
    'EnvironmentName' => '<string>', // REQUIRED
]);

Parameter Details

Members
EnvironmentName
Required: Yes
Type: string

The name of the environment from which to disassociate the operations role.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

ListAvailableSolutionStacks

$result = $client->listAvailableSolutionStacks([/* ... */]);
$promise = $client->listAvailableSolutionStacksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAvailableSolutionStacks([
]);

Parameter Details

Members

Result Syntax

[
    'SolutionStackDetails' => [
        [
            'PermittedFileTypes' => ['<string>', ...],
            'SolutionStackName' => '<string>',
        ],
        // ...
    ],
    'SolutionStacks' => ['<string>', ...],
]

Result Details

Members
SolutionStackDetails
Type: Array of SolutionStackDescription structures

A list of available solution stacks and their SolutionStackDescription.

SolutionStacks
Type: Array of strings

A list of available solution stacks.

Errors

There are no errors described for this operation.

Examples

Example 1: To view solution stacks

The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:

$result = $client->listAvailableSolutionStacks([
]);

Result syntax:

[
    'SolutionStackDetails' => [
        [
            'PermittedFileTypes' => [
                'zip',
            ],
            'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Node.js',
        ],
    ],
    'SolutionStacks' => [
        '64bit Amazon Linux 2015.03 v2.0.0 running Node.js',
        '64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6',
        '64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5',
        '64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4',
        '64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4',
        '64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7',
        '64bit Amazon Linux 2015.03 v2.0.0 running Python',
        '64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)',
        '64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)',
        '64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)',
        '64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)',
        '64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)',
        '64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)',
        '64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3',
        '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
        '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7',
        '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6',
        '64bit Windows Server Core 2012 R2 running IIS 8.5',
        '64bit Windows Server 2012 R2 running IIS 8.5',
        '64bit Windows Server 2012 running IIS 8',
        '64bit Windows Server 2008 R2 running IIS 7.5',
        '64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2',
        '64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)',
        '64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)',
        '64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)',
        '64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)',
        '64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)',
        '64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)',
    ],
]

ListPlatformBranches

$result = $client->listPlatformBranches([/* ... */]);
$promise = $client->listPlatformBranchesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listPlatformBranches([
    'Filters' => [
        [
            'Attribute' => '<string>',
            'Operator' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
Type: Array of SearchFilter structures

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: = | != | begins_with | ends_with | contains | in | not_in

  • Attribute = LifecycleState:

    • Operator: = | != | in | not_in

    • Values: beta | supported | deprecated | retired

  • Attribute = PlatformName:

    • Operator: = | != | begins_with | ends_with | contains | in | not_in

  • Attribute = TierType:

    • Operator: = | !=

    • Values: WebServer/Standard | Worker/SQS/HTTP

Array size: limited to 10 SearchFilter objects.

Within each SearchFilter item, the Values array is limited to 10 items.

MaxRecords
Type: int

The maximum number of platform branch values returned in one call.

NextToken
Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'PlatformBranchSummaryList' => [
        [
            'BranchName' => '<string>',
            'BranchOrder' => <integer>,
            'LifecycleState' => '<string>',
            'PlatformName' => '<string>',
            'SupportedTierList' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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.

PlatformBranchSummaryList
Type: Array of PlatformBranchSummary structures

Summary information about the platform branches.

Errors

There are no errors described for this operation.

ListPlatformVersions

$result = $client->listPlatformVersions([/* ... */]);
$promise = $client->listPlatformVersionsAsync([/* ... */]);

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

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Parameter Syntax

$result = $client->listPlatformVersions([
    'Filters' => [
        [
            'Operator' => '<string>',
            'Type' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
Type: Array of PlatformFilter structures

Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.

MaxRecords
Type: int

The maximum number of platform version values returned in one call.

NextToken
Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'PlatformSummaryList' => [
        [
            'OperatingSystemName' => '<string>',
            'OperatingSystemVersion' => '<string>',
            'PlatformArn' => '<string>',
            'PlatformBranchLifecycleState' => '<string>',
            'PlatformBranchName' => '<string>',
            'PlatformCategory' => '<string>',
            'PlatformLifecycleState' => '<string>',
            'PlatformOwner' => '<string>',
            'PlatformStatus' => 'Creating|Failed|Ready|Deleting|Deleted',
            'PlatformVersion' => '<string>',
            'SupportedAddonList' => ['<string>', ...],
            'SupportedTierList' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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.

PlatformSummaryList
Type: Array of PlatformSummary structures

Summary information about the platform versions.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

ElasticBeanstalkServiceException:

A generic service exception has occurred.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.

Must be the ARN of an Elastic Beanstalk resource.

Result Syntax

[
    'ResourceArn' => '<string>',
    'ResourceTags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ResourceArn
Type: string

The Amazon Resource Name (ARN) of the resource for which a tag list was requested.

ResourceTags
Type: Array of Tag structures

A list of tag key-value pairs.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

ResourceNotFoundException:

A resource doesn't exist for the specified Amazon Resource Name (ARN).

ResourceTypeNotSupportedException:

The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.

RebuildEnvironment

$result = $client->rebuildEnvironment([/* ... */]);
$promise = $client->rebuildEnvironmentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->rebuildEnvironment([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
]);

Parameter Details

Members
EnvironmentId
Type: string

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.

EnvironmentName
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

Examples

Example 1: To rebuild an environment

The following operation terminates and recreates the resources in an environment named my-env:

$result = $client->rebuildEnvironment([
    'EnvironmentName' => 'my-env',
]);

RequestEnvironmentInfo

$result = $client->requestEnvironmentInfo([/* ... */]);
$promise = $client->requestEnvironmentInfoAsync([/* ... */]);

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 to obtain the set of logs.

Related Topics

Parameter Syntax

$result = $client->requestEnvironmentInfo([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
    'InfoType' => 'tail|bundle', // REQUIRED
]);

Parameter Details

Members
EnvironmentId
Type: string

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.

EnvironmentName
Type: string

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.

InfoType
Required: Yes
Type: string

The type of information to request.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To request tailed logs

The following operation requests logs from an environment named my-env:

$result = $client->requestEnvironmentInfo([
    'EnvironmentName' => 'my-env',
    'InfoType' => 'tail',
]);

RestartAppServer

$result = $client->restartAppServer([/* ... */]);
$promise = $client->restartAppServerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->restartAppServer([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
]);

Parameter Details

Members
EnvironmentId
Type: string

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.

EnvironmentName
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To restart application servers

The following operation restarts application servers on all instances in an environment named my-env:

$result = $client->restartAppServer([
    'EnvironmentName' => 'my-env',
]);

RetrieveEnvironmentInfo

$result = $client->retrieveEnvironmentInfo([/* ... */]);
$promise = $client->retrieveEnvironmentInfoAsync([/* ... */]);

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

Parameter Syntax

$result = $client->retrieveEnvironmentInfo([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
    'InfoType' => 'tail|bundle', // REQUIRED
]);

Parameter Details

Members
EnvironmentId
Type: string

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.

EnvironmentName
Type: string

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.

InfoType
Required: Yes
Type: string

The type of information to retrieve.

Result Syntax

[
    'EnvironmentInfo' => [
        [
            'Ec2InstanceId' => '<string>',
            'InfoType' => 'tail|bundle',
            'Message' => '<string>',
            'SampleTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
EnvironmentInfo
Type: Array of EnvironmentInfoDescription structures

The EnvironmentInfoDescription of the environment.

Errors

There are no errors described for this operation.

Examples

Example 1: To retrieve tailed logs

The following operation retrieves a link to logs from an environment named my-env:

$result = $client->retrieveEnvironmentInfo([
    'EnvironmentName' => 'my-env',
    'InfoType' => 'tail',
]);

Result syntax:

[
    'EnvironmentInfo' => [
        [
            'Ec2InstanceId' => 'i-09c1c867',
            'InfoType' => 'tail',
            'Message' => 'https://elasticbeanstalk-us-west-2-0123456789012.s3.amazonaws.com/resources/environments/logs/tail/e-fyqyju3yjs/i-09c1c867/TailLogs-1440109397703.out?AWSAccessKeyId=AKGPT4J56IAJ2EUBL5CQ&Expires=1440195891&Signature=n%2BEalOV6A2HIOx4Rcfb7LT16bBM%3D',
            'SampleTimestamp' => ,
        ],
    ],
]

SwapEnvironmentCNAMEs

$result = $client->swapEnvironmentCNAMEs([/* ... */]);
$promise = $client->swapEnvironmentCNAMEsAsync([/* ... */]);

Swaps the CNAMEs of two environments.

Parameter Syntax

$result = $client->swapEnvironmentCNAMEs([
    'DestinationEnvironmentId' => '<string>',
    'DestinationEnvironmentName' => '<string>',
    'SourceEnvironmentId' => '<string>',
    'SourceEnvironmentName' => '<string>',
]);

Parameter Details

Members
DestinationEnvironmentId
Type: string

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.

DestinationEnvironmentName
Type: string

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.

SourceEnvironmentId
Type: string

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.

SourceEnvironmentName
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To swap environment CNAMES

The following operation swaps the assigned subdomains of two environments:

$result = $client->swapEnvironmentCNAMEs([
    'DestinationEnvironmentName' => 'my-env-green',
    'SourceEnvironmentName' => 'my-env-blue',
]);

TerminateEnvironment

$result = $client->terminateEnvironment([/* ... */]);
$promise = $client->terminateEnvironmentAsync([/* ... */]);

Terminates the specified environment.

Parameter Syntax

$result = $client->terminateEnvironment([
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
    'ForceTerminate' => true || false,
    'TerminateResources' => true || false,
]);

Parameter Details

Members
EnvironmentId
Type: string

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.

EnvironmentName
Type: string

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.

ForceTerminate
Type: boolean

Terminates the target environment even if another environment in the same group is dependent on it.

TerminateResources
Type: boolean

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.

Default: true

Valid Values: true | false

Result Syntax

[
    'AbortableOperationInProgress' => true || false,
    'ApplicationName' => '<string>',
    'CNAME' => '<string>',
    'DateCreated' => <DateTime>,
    'DateUpdated' => <DateTime>,
    'Description' => '<string>',
    'EndpointURL' => '<string>',
    'EnvironmentArn' => '<string>',
    'EnvironmentId' => '<string>',
    'EnvironmentLinks' => [
        [
            'EnvironmentName' => '<string>',
            'LinkName' => '<string>',
        ],
        // ...
    ],
    'EnvironmentName' => '<string>',
    'Health' => 'Green|Yellow|Red|Grey',
    'HealthStatus' => 'NoData|Unknown|Pending|Ok|Info|Warning|Degraded|Severe|Suspended',
    'OperationsRole' => '<string>',
    'PlatformArn' => '<string>',
    'Resources' => [
        'LoadBalancer' => [
            'Domain' => '<string>',
            'Listeners' => [
                [
                    'Port' => <integer>,
                    'Protocol' => '<string>',
                ],
                // ...
            ],
            'LoadBalancerName' => '<string>',
        ],
    ],
    'SolutionStackName' => '<string>',
    'Status' => 'Aborting|Launching|Updating|LinkingFrom|LinkingTo|Ready|Terminating|Terminated',
    'TemplateName' => '<string>',
    'Tier' => [
        'Name' => '<string>',
        'Type' => '<string>',
        'Version' => '<string>',
    ],
    'VersionLabel' => '<string>',
]

Result Details

Members
AbortableOperationInProgress
Type: boolean

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.

ApplicationName
Type: string

The name of the application associated with this environment.

CNAME
Type: string

The URL to the CNAME for this environment.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date for this environment.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last modified date for this environment.

Description
Type: string

Describes this environment.

EndpointURL
Type: string

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

EnvironmentArn
Type: string

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

EnvironmentId
Type: string

The ID of this environment.

EnvironmentLinks
Type: Array of EnvironmentLink structures

A list of links to other environments in the same group.

EnvironmentName
Type: string

The name of this environment.

Health
Type: string

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

HealthStatus
Type: string

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

OperationsRole
Type: string

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

PlatformArn
Type: string

The ARN of the platform version.

Resources

The description of the AWS resources used by this environment.

SolutionStackName
Type: string

The name of the SolutionStack deployed with this environment.

Status
Type: string

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • 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.

TemplateName
Type: string

The name of the configuration template used to originally launch this environment.

Tier
Type: EnvironmentTier structure

Describes the current tier of this environment.

VersionLabel
Type: string

The application version deployed in this environment.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

Examples

Example 1: To terminate an environment

The following operation terminates an Elastic Beanstalk environment named my-env:

$result = $client->terminateEnvironment([
    'EnvironmentName' => 'my-env',
]);

Result syntax:

[
    'AbortableOperationInProgress' => ,
    'ApplicationName' => 'my-app',
    'CNAME' => 'my-env.elasticbeanstalk.com',
    'DateCreated' => ,
    'DateUpdated' => ,
    'EndpointURL' => 'awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com',
    'EnvironmentId' => 'e-fh2eravpns',
    'EnvironmentName' => 'my-env',
    'Health' => 'Grey',
    'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
    'Status' => 'Terminating',
    'Tier' => [
        'Name' => 'WebServer',
        'Type' => 'Standard',
        'Version' => ' ',
    ],
]

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates the specified application to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

Parameter Syntax

$result = $client->updateApplication([
    'ApplicationName' => '<string>', // REQUIRED
    'Description' => '<string>',
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.

Description
Type: string

A new description for the application.

Default: If not specified, AWS Elastic Beanstalk does not update the description.

Result Syntax

[
    'Application' => [
        'ApplicationArn' => '<string>',
        'ApplicationName' => '<string>',
        'ConfigurationTemplates' => ['<string>', ...],
        'DateCreated' => <DateTime>,
        'DateUpdated' => <DateTime>,
        'Description' => '<string>',
        'ResourceLifecycleConfig' => [
            'ServiceRole' => '<string>',
            'VersionLifecycleConfig' => [
                'MaxAgeRule' => [
                    'DeleteSourceFromS3' => true || false,
                    'Enabled' => true || false,
                    'MaxAgeInDays' => <integer>,
                ],
                'MaxCountRule' => [
                    'DeleteSourceFromS3' => true || false,
                    'Enabled' => true || false,
                    'MaxCount' => <integer>,
                ],
            ],
        ],
        'Versions' => ['<string>', ...],
    ],
]

Result Details

Members
Application
Type: ApplicationDescription structure

The ApplicationDescription of the application.

Errors

There are no errors described for this operation.

Examples

Example 1: To change an application's description

The following operation updates the description of an application named my-app:

$result = $client->updateApplication([
    'ApplicationName' => 'my-app',
    'Description' => 'my Elastic Beanstalk application',
]);

Result syntax:

[
    'Application' => [
        'ApplicationName' => 'my-app',
        'ConfigurationTemplates' => [
        ],
        'DateCreated' => ,
        'DateUpdated' => ,
        'Description' => 'my Elastic Beanstalk application',
        'Versions' => [
            '2fba-stage-150819_234450',
            'bf07-stage-150820_214945',
            '93f8',
            'fd7c-stage-150820_000431',
            '22a0-stage-150819_185942',
        ],
    ],
]

UpdateApplicationResourceLifecycle

$result = $client->updateApplicationResourceLifecycle([/* ... */]);
$promise = $client->updateApplicationResourceLifecycleAsync([/* ... */]);

Modifies lifecycle settings for an application.

Parameter Syntax

$result = $client->updateApplicationResourceLifecycle([
    'ApplicationName' => '<string>', // REQUIRED
    'ResourceLifecycleConfig' => [ // REQUIRED
        'ServiceRole' => '<string>',
        'VersionLifecycleConfig' => [
            'MaxAgeRule' => [
                'DeleteSourceFromS3' => true || false,
                'Enabled' => true || false, // REQUIRED
                'MaxAgeInDays' => <integer>,
            ],
            'MaxCountRule' => [
                'DeleteSourceFromS3' => true || false,
                'Enabled' => true || false, // REQUIRED
                'MaxCount' => <integer>,
            ],
        ],
    ],
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application.

ResourceLifecycleConfig
Required: Yes
Type: ApplicationResourceLifecycleConfig structure

The lifecycle configuration.

Result Syntax

[
    'ApplicationName' => '<string>',
    'ResourceLifecycleConfig' => [
        'ServiceRole' => '<string>',
        'VersionLifecycleConfig' => [
            'MaxAgeRule' => [
                'DeleteSourceFromS3' => true || false,
                'Enabled' => true || false,
                'MaxAgeInDays' => <integer>,
            ],
            'MaxCountRule' => [
                'DeleteSourceFromS3' => true || false,
                'Enabled' => true || false,
                'MaxCount' => <integer>,
            ],
        ],
    ],
]

Result Details

Members
ApplicationName
Type: string

The name of the application.

ResourceLifecycleConfig

The lifecycle configuration.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

UpdateApplicationVersion

$result = $client->updateApplicationVersion([/* ... */]);
$promise = $client->updateApplicationVersionAsync([/* ... */]);

Updates the specified application version to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

Parameter Syntax

$result = $client->updateApplicationVersion([
    'ApplicationName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'VersionLabel' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application associated with this version.

If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.

Description
Type: string

A new description for this version.

VersionLabel
Required: Yes
Type: string

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

Result Syntax

[
    'ApplicationVersion' => [
        'ApplicationName' => '<string>',
        'ApplicationVersionArn' => '<string>',
        'BuildArn' => '<string>',
        'DateCreated' => <DateTime>,
        'DateUpdated' => <DateTime>,
        'Description' => '<string>',
        'SourceBuildInformation' => [
            'SourceLocation' => '<string>',
            'SourceRepository' => 'CodeCommit|S3',
            'SourceType' => 'Git|Zip',
        ],
        'SourceBundle' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'Status' => 'Processed|Unprocessed|Failed|Processing|Building',
        'VersionLabel' => '<string>',
    ],
]

Result Details

Members
ApplicationVersion

The ApplicationVersionDescription of the application version.

Errors

There are no errors described for this operation.

Examples

Example 1: To change an application version's description

The following operation updates the description of an application version named 22a0-stage-150819_185942:

$result = $client->updateApplicationVersion([
    'ApplicationName' => 'my-app',
    'Description' => 'new description',
    'VersionLabel' => '22a0-stage-150819_185942',
]);

Result syntax:

[
    'ApplicationVersion' => [
        'ApplicationName' => 'my-app',
        'DateCreated' => ,
        'DateUpdated' => ,
        'Description' => 'new description',
        'SourceBundle' => [
            'S3Bucket' => 'elasticbeanstalk-us-west-2-0123456789012',
            'S3Key' => 'my-app/22a0-stage-150819_185942.war',
        ],
        'VersionLabel' => '22a0-stage-150819_185942',
    ],
]

UpdateConfigurationTemplate

$result = $client->updateConfigurationTemplate([/* ... */]);
$promise = $client->updateConfigurationTemplateAsync([/* ... */]);

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

Parameter Syntax

$result = $client->updateConfigurationTemplate([
    'ApplicationName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'OptionSettings' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'OptionsToRemove' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
        ],
        // ...
    ],
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

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.

Description
Type: string

A new description for the configuration.

OptionSettings
Type: Array of ConfigurationOptionSetting structures

A list of configuration option settings to update with the new specified option value.

OptionsToRemove
Type: Array of OptionSpecification structures

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

TemplateName
Required: Yes
Type: string

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Result Syntax

[
    'ApplicationName' => '<string>',
    'DateCreated' => <DateTime>,
    'DateUpdated' => <DateTime>,
    'DeploymentStatus' => 'deployed|pending|failed',
    'Description' => '<string>',
    'EnvironmentName' => '<string>',
    'OptionSettings' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'PlatformArn' => '<string>',
    'SolutionStackName' => '<string>',
    'TemplateName' => '<string>',
]

Result Details

Members
ApplicationName
Type: string

The name of the application associated with this configuration set.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date (in UTC time) when this configuration set was created.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date (in UTC time) when this configuration set was last modified.

DeploymentStatus
Type: string

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.

Description
Type: string

Describes this configuration set.

EnvironmentName
Type: string

If not null, the name of the environment for this configuration set.

OptionSettings
Type: Array of ConfigurationOptionSetting structures

A list of the configuration options and their values in this configuration set.

PlatformArn
Type: string

The ARN of the platform version.

SolutionStackName
Type: string

The name of the solution stack this configuration set uses.

TemplateName
Type: string

If not null, the name of the configuration template for this configuration set.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

TooManyBucketsException:

The specified account has reached its limit of Amazon S3 buckets.

Examples

Example 1: To update a configuration template

The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:

$result = $client->updateConfigurationTemplate([
    'ApplicationName' => 'my-app',
    'OptionsToRemove' => [
        [
            'Namespace' => 'aws:elasticbeanstalk:healthreporting:system',
            'OptionName' => 'ConfigDocument',
        ],
    ],
    'TemplateName' => 'my-template',
]);

Result syntax:

[
    'ApplicationName' => 'my-app',
    'DateCreated' => ,
    'DateUpdated' => ,
    'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
    'TemplateName' => 'my-template',
]

UpdateEnvironment

$result = $client->updateEnvironment([/* ... */]);
$promise = $client->updateEnvironmentAsync([/* ... */]);

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 for this environment returns two setting descriptions with different DeploymentStatus values.

Parameter Syntax

$result = $client->updateEnvironment([
    'ApplicationName' => '<string>',
    'Description' => '<string>',
    'EnvironmentId' => '<string>',
    'EnvironmentName' => '<string>',
    'GroupName' => '<string>',
    'OptionSettings' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'OptionsToRemove' => [
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
        ],
        // ...
    ],
    'PlatformArn' => '<string>',
    'SolutionStackName' => '<string>',
    'TemplateName' => '<string>',
    'Tier' => [
        'Name' => '<string>',
        'Type' => '<string>',
        'Version' => '<string>',
    ],
    'VersionLabel' => '<string>',
]);

Parameter Details

Members
ApplicationName
Type: string

The name of the application with which the environment is associated.

Description
Type: string

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

EnvironmentId
Type: string

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.

EnvironmentName
Type: string

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.

GroupName
Type: string

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) for details.

OptionSettings
Type: Array of ConfigurationOptionSetting structures

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

OptionsToRemove
Type: Array of OptionSpecification structures

A list of custom user-defined configuration options to remove from the configuration set for this environment.

PlatformArn
Type: string

The ARN of the platform, if used.

SolutionStackName
Type: string

This specifies the platform version that the environment will run after the environment is updated.

TemplateName
Type: string

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.

Tier
Type: EnvironmentTier structure

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.

VersionLabel
Type: string

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.

Result Syntax

[
    'AbortableOperationInProgress' => true || false,
    'ApplicationName' => '<string>',
    'CNAME' => '<string>',
    'DateCreated' => <DateTime>,
    'DateUpdated' => <DateTime>,
    'Description' => '<string>',
    'EndpointURL' => '<string>',
    'EnvironmentArn' => '<string>',
    'EnvironmentId' => '<string>',
    'EnvironmentLinks' => [
        [
            'EnvironmentName' => '<string>',
            'LinkName' => '<string>',
        ],
        // ...
    ],
    'EnvironmentName' => '<string>',
    'Health' => 'Green|Yellow|Red|Grey',
    'HealthStatus' => 'NoData|Unknown|Pending|Ok|Info|Warning|Degraded|Severe|Suspended',
    'OperationsRole' => '<string>',
    'PlatformArn' => '<string>',
    'Resources' => [
        'LoadBalancer' => [
            'Domain' => '<string>',
            'Listeners' => [
                [
                    'Port' => <integer>,
                    'Protocol' => '<string>',
                ],
                // ...
            ],
            'LoadBalancerName' => '<string>',
        ],
    ],
    'SolutionStackName' => '<string>',
    'Status' => 'Aborting|Launching|Updating|LinkingFrom|LinkingTo|Ready|Terminating|Terminated',
    'TemplateName' => '<string>',
    'Tier' => [
        'Name' => '<string>',
        'Type' => '<string>',
        'Version' => '<string>',
    ],
    'VersionLabel' => '<string>',
]

Result Details

Members
AbortableOperationInProgress
Type: boolean

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.

ApplicationName
Type: string

The name of the application associated with this environment.

CNAME
Type: string

The URL to the CNAME for this environment.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date for this environment.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last modified date for this environment.

Description
Type: string

Describes this environment.

EndpointURL
Type: string

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

EnvironmentArn
Type: string

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

EnvironmentId
Type: string

The ID of this environment.

EnvironmentLinks
Type: Array of EnvironmentLink structures

A list of links to other environments in the same group.

EnvironmentName
Type: string

The name of this environment.

Health
Type: string

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

HealthStatus
Type: string

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

OperationsRole
Type: string

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

PlatformArn
Type: string

The ARN of the platform version.

Resources

The description of the AWS resources used by this environment.

SolutionStackName
Type: string

The name of the SolutionStack deployed with this environment.

Status
Type: string

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • 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.

TemplateName
Type: string

The name of the configuration template used to originally launch this environment.

Tier
Type: EnvironmentTier structure

Describes the current tier of this environment.

VersionLabel
Type: string

The application version deployed in this environment.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

TooManyBucketsException:

The specified account has reached its limit of Amazon S3 buckets.

Examples

Example 1: To update an environment to a new version

The following operation updates an environment named "my-env" to version "v2" of the application to which it belongs:

$result = $client->updateEnvironment([
    'EnvironmentName' => 'my-env',
    'VersionLabel' => 'v2',
]);

Result syntax:

[
    'ApplicationName' => 'my-app',
    'CNAME' => 'my-env.elasticbeanstalk.com',
    'DateCreated' => ,
    'DateUpdated' => ,
    'EndpointURL' => 'awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com',
    'EnvironmentId' => 'e-szqipays4h',
    'EnvironmentName' => 'my-env',
    'Health' => 'Grey',
    'SolutionStackName' => '64bit Amazon Linux running Tomcat 7',
    'Status' => 'Updating',
    'Tier' => [
        'Name' => 'WebServer',
        'Type' => 'Standard',
        'Version' => ' ',
    ],
    'VersionLabel' => 'v2',
]
Example 2: To configure option settings

The following operation configures several options in the aws:elb:loadbalancer namespace:

$result = $client->updateEnvironment([
    'EnvironmentName' => 'my-env',
    'OptionSettings' => [
        [
            'Namespace' => 'aws:elb:healthcheck',
            'OptionName' => 'Interval',
            'Value' => '15',
        ],
        [
            'Namespace' => 'aws:elb:healthcheck',
            'OptionName' => 'Timeout',
            'Value' => '8',
        ],
        [
            'Namespace' => 'aws:elb:healthcheck',
            'OptionName' => 'HealthyThreshold',
            'Value' => '2',
        ],
        [
            'Namespace' => 'aws:elb:healthcheck',
            'OptionName' => 'UnhealthyThreshold',
            'Value' => '3',
        ],
    ],
]);

Result syntax:

[
    'AbortableOperationInProgress' => 1,
    'ApplicationName' => 'my-app',
    'CNAME' => 'my-env.elasticbeanstalk.com',
    'DateCreated' => ,
    'DateUpdated' => ,
    'EndpointURL' => 'awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com',
    'EnvironmentId' => 'e-wtp2rpqsej',
    'EnvironmentName' => 'my-env',
    'Health' => 'Grey',
    'SolutionStackName' => '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
    'Status' => 'Updating',
    'Tier' => [
        'Name' => 'WebServer',
        'Type' => 'Standard',
        'Version' => ' ',
    ],
    'VersionLabel' => '7f58-stage-150812_025409',
]

UpdateTagsForResource

$result = $client->updateTagsForResource([/* ... */]);
$promise = $client->updateTagsForResourceAsync([/* ... */]);

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.

If you create a custom IAM user 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.

Parameter Syntax

$result = $client->updateTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagsToAdd' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TagsToRemove' => ['<string>', ...],
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resouce to be updated.

Must be the ARN of an Elastic Beanstalk resource.

TagsToAdd
Type: Array of Tag structures

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.

TagsToRemove
Type: Array of strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

OperationInProgressException:

Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

TooManyTagsException:

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.

ResourceNotFoundException:

A resource doesn't exist for the specified Amazon Resource Name (ARN).

ResourceTypeNotSupportedException:

The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.

ValidateConfigurationSettings

$result = $client->validateConfigurationSettings([/* ... */]);
$promise = $client->validateConfigurationSettingsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->validateConfigurationSettings([
    'ApplicationName' => '<string>', // REQUIRED
    'EnvironmentName' => '<string>',
    'OptionSettings' => [ // REQUIRED
        [
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'ResourceName' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TemplateName' => '<string>',
]);

Parameter Details

Members
ApplicationName
Required: Yes
Type: string

The name of the application that the configuration template or environment belongs to.

EnvironmentName
Type: string

The name of the environment to validate the settings against.

Condition: You cannot specify both this and a configuration template name.

OptionSettings
Required: Yes
Type: Array of ConfigurationOptionSetting structures

A list of the options and desired values to evaluate.

TemplateName
Type: string

The name of the configuration template to validate the settings against.

Condition: You cannot specify both this and an environment name.

Result Syntax

[
    'Messages' => [
        [
            'Message' => '<string>',
            'Namespace' => '<string>',
            'OptionName' => '<string>',
            'Severity' => 'error|warning',
        ],
        // ...
    ],
]

Result Details

Members
Messages
Type: Array of ValidationMessage structures

A list of ValidationMessage.

Errors

InsufficientPrivilegesException:

The specified account does not have sufficient privileges for one or more AWS services.

TooManyBucketsException:

The specified account has reached its limit of Amazon S3 buckets.

Examples

Example 1: To validate configuration settings

The following operation validates a CloudWatch custom metrics config document:

$result = $client->validateConfigurationSettings([
    'ApplicationName' => 'my-app',
    'EnvironmentName' => 'my-env',
    'OptionSettings' => [
        [
            'Namespace' => 'aws:elasticbeanstalk:healthreporting:system',
            'OptionName' => 'ConfigDocument',
            'Value' => '{"CloudWatchMetrics": {"Environment": {"ApplicationLatencyP99.9": null,"InstancesSevere": 60,"ApplicationLatencyP90": 60,"ApplicationLatencyP99": null,"ApplicationLatencyP95": 60,"InstancesUnknown": 60,"ApplicationLatencyP85": 60,"InstancesInfo": null,"ApplicationRequests2xx": null,"InstancesDegraded": null,"InstancesWarning": 60,"ApplicationLatencyP50": 60,"ApplicationRequestsTotal": null,"InstancesNoData": null,"InstancesPending": 60,"ApplicationLatencyP10": null,"ApplicationRequests5xx": null,"ApplicationLatencyP75": null,"InstancesOk": 60,"ApplicationRequests3xx": null,"ApplicationRequests4xx": null},"Instance": {"ApplicationLatencyP99.9": null,"ApplicationLatencyP90": 60,"ApplicationLatencyP99": null,"ApplicationLatencyP95": null,"ApplicationLatencyP85": null,"CPUUser": 60,"ApplicationRequests2xx": null,"CPUIdle": null,"ApplicationLatencyP50": null,"ApplicationRequestsTotal": 60,"RootFilesystemUtil": null,"LoadAverage1min": null,"CPUIrq": null,"CPUNice": 60,"CPUIowait": 60,"ApplicationLatencyP10": null,"LoadAverage5min": null,"ApplicationRequests5xx": null,"ApplicationLatencyP75": 60,"CPUSystem": 60,"ApplicationRequests3xx": 60,"ApplicationRequests4xx": null,"InstanceHealth": null,"CPUSoftirq": 60}},"Version": 1}',
        ],
    ],
]);

Result syntax:

[
    'Messages' => [
    ],
]

Shapes

ApplicationDescription

Description

Describes the properties of an application.

Members
ApplicationArn
Type: string

The Amazon Resource Name (ARN) of the application.

ApplicationName
Type: string

The name of the application.

ConfigurationTemplates
Type: Array of strings

The names of the configuration templates associated with this application.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the application was created.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the application was last modified.

Description
Type: string

User-defined description of the application.

ResourceLifecycleConfig

The lifecycle settings for the application.

Versions
Type: Array of strings

The names of the versions for this application.

ApplicationDescriptionsMessage

Description

Result message containing a list of application descriptions.

Members
Applications
Type: Array of ApplicationDescription structures

This parameter contains a list of ApplicationDescription.

ApplicationMetrics

Description

Application request metrics for an AWS Elastic Beanstalk environment.

Members
Duration
Type: int

The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration).

Latency
Type: Latency structure

Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.

RequestCount
Type: int

Average number of requests handled by the web server per second over the last 10 seconds.

StatusCodes
Type: StatusCodes structure

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.

ApplicationResourceLifecycleConfig

Description

The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.

Members
ServiceRole
Type: string

The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

VersionLifecycleConfig

Defines lifecycle settings for application versions.

ApplicationResourceLifecycleDescriptionMessage

Members
ApplicationName
Type: string

The name of the application.

ResourceLifecycleConfig

The lifecycle configuration.

ApplicationVersionDescription

Description

Describes the properties of an application version.

Members
ApplicationName
Type: string

The name of the application to which the application version belongs.

ApplicationVersionArn
Type: string

The Amazon Resource Name (ARN) of the application version.

BuildArn
Type: string

Reference to the artifact from the AWS CodeBuild build.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date of the application version.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last modified date of the application version.

Description
Type: string

The description of the application version.

SourceBuildInformation
Type: SourceBuildInformation structure

If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.

SourceBundle
Type: S3Location structure

The storage location of the application version's source bundle in Amazon S3.

Status
Type: string

The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values.

  • Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.

  • Processing – Elastic Beanstalk is currently processing the application version.

  • Building – Application version is currently undergoing an AWS CodeBuild build.

  • Processed – Elastic Beanstalk was successfully pre-processed and validated.

  • Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.

VersionLabel
Type: string

A unique identifier for the application version.

ApplicationVersionDescriptionsMessage

Description

Result message wrapping a list of application version descriptions.

Members
ApplicationVersions
Type: Array of ApplicationVersionDescription structures

List of ApplicationVersionDescription objects sorted in order of creation.

NextToken
Type: string

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

ApplicationVersionLifecycleConfig

Description

The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.

When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.

Members
MaxAgeRule
Type: MaxAgeRule structure

Specify a max age rule to restrict the length of time that application versions are retained for an application.

MaxCountRule
Type: MaxCountRule structure

Specify a max count rule to restrict the number of application versions that are retained for an application.

ApplyEnvironmentManagedActionResult

Description

The result message containing information about the managed action.

Members
ActionDescription
Type: string

A description of the managed action.

ActionId
Type: string

The action ID of the managed action.

ActionType
Type: string

The type of managed action.

Status
Type: string

The status of the managed action.

AutoScalingGroup

Description

Describes an Auto Scaling launch configuration.

Members
Name
Type: string

The name of the AutoScalingGroup .

BuildConfiguration

Description

Settings for an AWS CodeBuild build.

Members
ArtifactName
Type: string

The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.

CodeBuildServiceRole
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

ComputeType
Type: string

Information about the compute resources the build project will use.

  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds

  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds

  • BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds

Image
Required: Yes
Type: string

The ID of the Docker image to use for this build project.

TimeoutInMinutes
Type: int

How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.

Builder

Description

The builder used to build the custom platform.

Members
ARN
Type: string

The ARN of the builder.

CPUUtilization

Description

CPU utilization metrics for an instance.

Members
IOWait
Type: double

Available on Linux environments only.

Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.

IRQ
Type: double

Available on Linux environments only.

Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.

Idle
Type: double

Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.

Nice
Type: double

Available on Linux environments only.

Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.

Privileged
Type: double

Available on Windows environments only.

Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.

SoftIRQ
Type: double

Available on Linux environments only.

Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.

System
Type: double

Available on Linux environments only.

Percentage of time that the CPU has spent in the System state over the last 10 seconds.

User
Type: double

Percentage of time that the CPU has spent in the User state over the last 10 seconds.

CheckDNSAvailabilityResultMessage

Description

Indicates if the specified CNAME is available.

Members
Available
Type: boolean

Indicates if the specified CNAME is available:

  • true : The CNAME is available.

  • false : The CNAME is not available.

FullyQualifiedCNAME
Type: string

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

CodeBuildNotInServiceRegionException

Description

AWS CodeBuild is not available in the specified region.

Members

ConfigurationOptionDescription

Description

Describes the possible values for a configuration option.

Members
ChangeSeverity
Type: string

An indication of which action is required if the value for this configuration option changes:

  • NoInterruption : There is no interruption to the environment or application availability.

  • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

  • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

DefaultValue
Type: string

The default value for this configuration option.

MaxLength
Type: int

If specified, the configuration option must be a string value no longer than this value.

MaxValue
Type: int

If specified, the configuration option must be a numeric value less than this value.

MinValue
Type: int

If specified, the configuration option must be a numeric value greater than this value.

Name
Type: string

The name of the configuration option.

Namespace
Type: string

A unique namespace identifying the option's associated AWS resource.

Regex
Type: OptionRestrictionRegex structure

If specified, the configuration option must be a string value that satisfies this regular expression.

UserDefined
Type: boolean

An indication of whether the user defined this configuration option:

  • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

  • false : This configuration was not defined by the user.

Constraint: You can remove only UserDefined options from a configuration.

Valid Values: true | false

ValueOptions
Type: Array of strings

If specified, values for the configuration option are selected from this list.

ValueType
Type: string

An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

  • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

  • List : Values for this option are multiple selections from the possible values.

  • Boolean : Values for this option are either true or false .

  • Json : Values for this option are a JSON representation of a ConfigDocument.

ConfigurationOptionSetting

Description

A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide.

Members
Namespace
Type: string

A unique namespace that identifies the option's associated AWS resource.

OptionName
Type: string

The name of the configuration option.

ResourceName
Type: string

A unique resource name for the option setting. Use it for a time–based scaling configuration option.

Value
Type: string

The current value for the configuration option.

ConfigurationOptionsDescription

Description

Describes the settings for a specified configuration set.

Members
Options
Type: Array of ConfigurationOptionDescription structures
PlatformArn
Type: string

The ARN of the platform version.

SolutionStackName
Type: string

The name of the solution stack these configuration options belong to.

ConfigurationSettingsDescription

Description

Describes the settings for a configuration set.

Members
ApplicationName
Type: string

The name of the application associated with this configuration set.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date (in UTC time) when this configuration set was created.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date (in UTC time) when this configuration set was last modified.

DeploymentStatus
Type: string

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.

Description
Type: string

Describes this configuration set.

EnvironmentName
Type: string

If not null, the name of the environment for this configuration set.

OptionSettings
Type: Array of ConfigurationOptionSetting structures

A list of the configuration options and their values in this configuration set.

PlatformArn
Type: string

The ARN of the platform version.

SolutionStackName
Type: string

The name of the solution stack this configuration set uses.

TemplateName
Type: string

If not null, the name of the configuration template for this configuration set.

ConfigurationSettingsValidationMessages

Description

Provides a list of validation messages.

Members
Messages
Type: Array of ValidationMessage structures

A list of ValidationMessage.

CreatePlatformVersionResult

Members
Builder
Type: Builder structure

The builder used to create the custom platform.

PlatformSummary
Type: PlatformSummary structure

Detailed information about the new version of the custom platform.

CreateStorageLocationResultMessage

Description

Results of a CreateStorageLocationResult call.

Members
S3Bucket
Type: string

The name of the Amazon S3 bucket created.

CustomAmi

Description

A custom AMI available to platforms.

Members
ImageId
Type: string

THe ID of the image used to create the custom AMI.

VirtualizationType
Type: string

The type of virtualization used to create the custom AMI.

DeletePlatformVersionResult

Members
PlatformSummary
Type: PlatformSummary structure

Detailed information about the version of the custom platform.

Deployment

Description

Information about an application version deployment.

Members
DeploymentId
Type: long (int|float)

The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.

DeploymentTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

For in-progress deployments, the time that the deployment started.

For completed deployments, the time that the deployment ended.

Status
Type: string

The status of the deployment:

  • In Progress : The deployment is in progress.

  • Deployed : The deployment succeeded.

  • Failed : The deployment failed.

VersionLabel
Type: string

The version label of the application version in the deployment.

DescribeAccountAttributesResult

Members
ResourceQuotas
Type: ResourceQuotas structure

The Elastic Beanstalk resource quotas associated with the calling AWS account.

DescribeEnvironmentHealthResult

Description

Health details for an AWS Elastic Beanstalk environment.

Members
ApplicationMetrics
Type: ApplicationMetrics structure

Application request metrics for the environment.

Causes
Type: Array of strings

Descriptions of the data that contributed to the environment's current health status.

Color
Type: string

The health color of the environment.

EnvironmentName
Type: string

The environment's name.

HealthStatus
Type: string

The health status of the environment. For example, Ok.

InstancesHealth
Type: InstanceHealthSummary structure

Summary health information for the instances in the environment.

RefreshedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the health information was retrieved.

Status
Type: string

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

DescribeEnvironmentManagedActionHistoryResult

Description

A result message containing a list of completed and failed managed actions.

Members
ManagedActionHistoryItems
Type: Array of ManagedActionHistoryItem structures

A list of completed and failed managed actions.

NextToken
Type: string

A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.

DescribeEnvironmentManagedActionsResult

Description

The result message containing a list of managed actions.

Members
ManagedActions
Type: Array of ManagedAction structures

A list of upcoming and in-progress managed actions.

DescribeInstancesHealthResult

Description

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

Members
InstanceHealthList
Type: Array of SingleInstanceHealth structures

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.

NextToken
Type: string

Pagination token for the next page of results, if available.

RefreshedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the health information was retrieved.

DescribePlatformVersionResult

Members
PlatformDescription
Type: PlatformDescription structure

Detailed information about the platform version.

ElasticBeanstalkServiceException

Description

A generic service exception has occurred.

Members
message
Type: string

The exception error message.

EnvironmentDescription

Description

Describes the properties of an environment.

Members
AbortableOperationInProgress
Type: boolean

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.

ApplicationName
Type: string

The name of the application associated with this environment.

CNAME
Type: string

The URL to the CNAME for this environment.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date for this environment.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last modified date for this environment.

Description
Type: string

Describes this environment.

EndpointURL
Type: string

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

EnvironmentArn
Type: string

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

EnvironmentId
Type: string

The ID of this environment.

EnvironmentLinks
Type: Array of EnvironmentLink structures

A list of links to other environments in the same group.

EnvironmentName
Type: string

The name of this environment.

Health
Type: string

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

HealthStatus
Type: string

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

OperationsRole
Type: string

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

PlatformArn
Type: string

The ARN of the platform version.

Resources

The description of the AWS resources used by this environment.

SolutionStackName
Type: string

The name of the SolutionStack deployed with this environment.

Status
Type: string

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • 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.

TemplateName
Type: string

The name of the configuration template used to originally launch this environment.

Tier
Type: EnvironmentTier structure

Describes the current tier of this environment.

VersionLabel
Type: string

The application version deployed in this environment.

EnvironmentDescriptionsMessage

Description

Result message containing a list of environment descriptions.

Members
Environments
Type: Array of EnvironmentDescription structures

Returns an EnvironmentDescription list.

NextToken
Type: string

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

EnvironmentInfoDescription

Description

The information retrieved from the Amazon EC2 instances.

Members
Ec2InstanceId
Type: string

The Amazon EC2 Instance ID for this information.

InfoType
Type: string

The type of information retrieved.

Message
Type: string

The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.

Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.

SampleTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time stamp when this information was retrieved.

Description

A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.

Members
EnvironmentName
Type: string

The name of the linked environment (the dependency).

LinkName
Type: string

The name of the link.

EnvironmentResourceDescription

Description

Describes the AWS resources in use by this environment. This data is live.

Members
AutoScalingGroups
Type: Array of AutoScalingGroup structures

The AutoScalingGroups used by this environment.

EnvironmentName
Type: string

The name of the environment.

Instances
Type: Array of Instance structures

The Amazon EC2 instances used by this environment.

LaunchConfigurations
Type: Array of LaunchConfiguration structures

The Auto Scaling launch configurations in use by this environment.

LaunchTemplates
Type: Array of LaunchTemplate structures

The Amazon EC2 launch templates in use by this environment.

LoadBalancers
Type: Array of LoadBalancer structures

The LoadBalancers in use by this environment.

Queues
Type: Array of Queue structures

The queues used by this environment.

Triggers
Type: Array of Trigger structures

The AutoScaling triggers in use by this environment.

EnvironmentResourcesDescription

Description

Describes the AWS resources in use by this environment. This data is not live data.

Members
LoadBalancer
Type: LoadBalancerDescription structure

Describes the LoadBalancer.

EnvironmentTier

Description

Describes the properties of an environment tier

Members
Name
Type: string

The name of this environment tier.

Valid values:

  • For Web server tierWebServer

  • For Worker tierWorker

Type
Type: string

The type of this environment tier.

Valid values:

  • For Web server tierStandard

  • For Worker tierSQS/HTTP

Version
Type: string

The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.

EventDescription

Description

Describes an event.

Members
ApplicationName
Type: string

The application associated with the event.

EnvironmentName
Type: string

The name of the environment associated with this event.

EventDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the event occurred.

Message
Type: string

The event message.

PlatformArn
Type: string

The ARN of the platform version.

RequestId
Type: string

The web service request ID for the activity of this event.

Severity
Type: string

The severity level of this event.

TemplateName
Type: string

The name of the configuration associated with this event.

VersionLabel
Type: string

The release label for the application version associated with this event.

EventDescriptionsMessage

Description

Result message wrapping a list of event descriptions.

Members
Events
Type: Array of EventDescription structures

A list of EventDescription.

NextToken
Type: string

If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.

Instance

Description

The description of an Amazon EC2 instance.

Members
Id
Type: string

The ID of the Amazon EC2 instance.

InstanceHealthSummary

Description

Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.

Members
Degraded
Type: int

Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.

Info
Type: int

Green. An operation is in progress on an instance.

NoData
Type: int

Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.

Ok
Type: int

Green. An instance is passing health checks and the health agent is not reporting any problems.

Pending
Type: int

Grey. An operation is in progress on an instance within the command timeout.

Severe
Type: int

Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.

Unknown
Type: int

Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.

Warning
Type: int

Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.

InsufficientPrivilegesException

Description

The specified account does not have sufficient privileges for one or more AWS services.

Members

InvalidRequestException

Description

One or more input parameters is not valid. Please correct the input parameters and try the operation again.

Members

Latency

Description

Represents the average latency for the slowest X percent of requests over the last 10 seconds.

Members
P10
Type: double

The average latency for the slowest 90 percent of requests over the last 10 seconds.

P50
Type: double

The average latency for the slowest 50 percent of requests over the last 10 seconds.

P75
Type: double

The average latency for the slowest 25 percent of requests over the last 10 seconds.

P85
Type: double

The average latency for the slowest 15 percent of requests over the last 10 seconds.

P90
Type: double

The average latency for the slowest 10 percent of requests over the last 10 seconds.

P95
Type: double

The average latency for the slowest 5 percent of requests over the last 10 seconds.

P99
Type: double

The average latency for the slowest 1 percent of requests over the last 10 seconds.

P999
Type: double

The average latency for the slowest 0.1 percent of requests over the last 10 seconds.

LaunchConfiguration

Description

Describes an Auto Scaling launch configuration.

Members
Name
Type: string

The name of the launch configuration.

LaunchTemplate

Description

Describes an Amazon EC2 launch template.

Members
Id
Type: string

The ID of the launch template.

ListAvailableSolutionStacksResultMessage

Description

A list of available AWS Elastic Beanstalk solution stacks.

Members
SolutionStackDetails
Type: Array of SolutionStackDescription structures

A list of available solution stacks and their SolutionStackDescription.

SolutionStacks
Type: Array of strings

A list of available solution stacks.

ListPlatformBranchesResult

Members
NextToken
Type: string

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.

PlatformBranchSummaryList
Type: Array of PlatformBranchSummary structures

Summary information about the platform branches.

ListPlatformVersionsResult

Members
NextToken
Type: string

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.

PlatformSummaryList
Type: Array of PlatformSummary structures

Summary information about the platform versions.

Listener

Description

Describes the properties of a Listener for the LoadBalancer.

Members
Port
Type: int

The port that is used by the Listener.

Protocol
Type: string

The protocol that is used by the Listener.

LoadBalancer

Description

Describes a LoadBalancer.

Members
Name
Type: string

The name of the LoadBalancer.

LoadBalancerDescription

Description

Describes the details of a LoadBalancer.

Members
Domain
Type: string

The domain name of the LoadBalancer.

Listeners
Type: Array of Listener structures

A list of Listeners used by the LoadBalancer.

LoadBalancerName
Type: string

The name of the LoadBalancer.

ManagedAction

Description

The record of an upcoming or in-progress managed action.

Members
ActionDescription
Type: string

A description of the managed action.

ActionId
Type: string

A unique identifier for the managed action.

ActionType
Type: string

The type of managed action.

Status
Type: string

The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction.

WindowStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the maintenance window in which the managed action will execute.

ManagedActionHistoryItem

Description

The record of a completed or failed managed action.

Members
ActionDescription
Type: string

A description of the managed action.

ActionId
Type: string

A unique identifier for the managed action.

ActionType
Type: string

The type of the managed action.

ExecutedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the action started executing.

FailureDescription
Type: string

If the action failed, a description of the failure.

FailureType
Type: string

If the action failed, the type of failure.

FinishedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the action finished executing.

Status
Type: string

The status of the action.

ManagedActionInvalidStateException

Description

Cannot modify the managed action in its current state.

Members

MaxAgeRule

Description

A lifecycle rule that deletes application versions after the specified number of days.

Members
DeleteSourceFromS3
Type: boolean

Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Enabled
Required: Yes
Type: boolean

Specify true to apply the rule, or false to disable it.

MaxAgeInDays
Type: int

Specify the number of days to retain an application versions.

MaxCountRule

Description

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

Members
DeleteSourceFromS3
Type: boolean

Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Enabled
Required: Yes
Type: boolean

Specify true to apply the rule, or false to disable it.

MaxCount
Type: int

Specify the maximum number of application versions to retain.

OperationInProgressException

Description

Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

Members

OptionRestrictionRegex

Description

A regular expression representing a restriction on a string configuration option value.

Members
Label
Type: string

A unique name representing this regular expression.

Pattern
Type: string

The regular expression pattern that a string configuration option value with this restriction must match.

OptionSpecification

Description

A specification identifying an individual configuration option.

Members
Namespace
Type: string

A unique namespace identifying the option's associated AWS resource.

OptionName
Type: string

The name of the configuration option.

ResourceName
Type: string

A unique resource name for a time-based scaling configuration option.

PlatformBranchSummary

Description

Summary information about a platform branch.

Members
BranchName
Type: string

The name of the platform branch.

BranchOrder
Type: int

An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches.

A larger BranchOrder value designates a newer platform branch within the platform.

LifecycleState
Type: string

The support life cycle state of the platform branch.

Possible values: beta | supported | deprecated | retired

PlatformName
Type: string

The name of the platform to which this platform branch belongs.

SupportedTierList
Type: Array of strings

The environment tiers that platform versions in this branch support.

Possible values: WebServer/Standard | Worker/SQS/HTTP

PlatformDescription

Description

Detailed information about a platform version.

Members
CustomAmiList
Type: Array of CustomAmi structures

The custom AMIs supported by the platform version.

DateCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the platform version was created.

DateUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the platform version was last updated.

Description
Type: string

The description of the platform version.

Frameworks
Type: Array of PlatformFramework structures

The frameworks supported by the platform version.

Maintainer
Type: string

Information about the maintainer of the platform version.

OperatingSystemName
Type: string

The operating system used by the platform version.

OperatingSystemVersion
Type: string

The version of the operating system used by the platform version.

PlatformArn
Type: string

The ARN of the platform version.

PlatformBranchLifecycleState
Type: string

The state of the platform version's branch in its lifecycle.

Possible values: Beta | Supported | Deprecated | Retired

PlatformBranchName
Type: string

The platform branch to which the platform version belongs.

PlatformCategory
Type: string

The category of the platform version.

PlatformLifecycleState
Type: string

The state of the platform version in its lifecycle.

Possible values: Recommended | null

If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.

PlatformName
Type: string

The name of the platform version.

PlatformOwner
Type: string

The AWS account ID of the person who created the platform version.

PlatformStatus
Type: string

The status of the platform version.

PlatformVersion
Type: string

The version of the platform version.

ProgrammingLanguages
Type: Array of PlatformProgrammingLanguage structures

The programming languages supported by the platform version.

SolutionStackName
Type: string

The name of the solution stack used by the platform version.

SupportedAddonList
Type: Array of strings

The additions supported by the platform version.

SupportedTierList
Type: Array of strings

The tiers supported by the platform version.

PlatformFilter

Description

Describes criteria to restrict the results when listing platform versions.

The filter is evaluated as follows: Type Operator Values[1]

Members
Operator
Type: string

The operator to apply to the Type with each of the Values.

Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with

Type
Type: string

The platform version attribute to which the filter values are applied.

Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName

Values
Type: Array of strings

The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.

The following list shows valid filter values for some filter attributes.

  • PlatformStatus: Creating | Failed | Ready | Deleting | Deleted

  • PlatformLifecycleState: recommended

  • SupportedTier: WebServer/Standard | Worker/SQS/HTTP

  • SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD

PlatformFramework

Description

A framework supported by the platform.

Members
Name
Type: string

The name of the framework.

Version
Type: string

The version of the framework.

PlatformProgrammingLanguage

Description

A programming language supported by the platform.

Members
Name
Type: string

The name of the programming language.

Version
Type: string

The version of the programming language.

PlatformSummary

Description

Summary information about a platform version.

Members
OperatingSystemName
Type: string

The operating system used by the platform version.

OperatingSystemVersion
Type: string

The version of the operating system used by the platform version.

PlatformArn
Type: string

The ARN of the platform version.

PlatformBranchLifecycleState
Type: string

The state of the platform version's branch in its lifecycle.

Possible values: beta | supported | deprecated | retired

PlatformBranchName
Type: string

The platform branch to which the platform version belongs.

PlatformCategory
Type: string

The category of platform version.

PlatformLifecycleState
Type: string

The state of the platform version in its lifecycle.

Possible values: recommended | empty

If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.

PlatformOwner
Type: string

The AWS account ID of the person who created the platform version.

PlatformStatus
Type: string

The status of the platform version. You can create an environment from the platform version once it is ready.

PlatformVersion
Type: string

The version string of the platform version.

SupportedAddonList
Type: Array of strings

The additions associated with the platform version.

SupportedTierList
Type: Array of strings

The tiers in which the platform version runs.

PlatformVersionStillReferencedException

Description

You cannot delete the platform version because there are still environments running on it.

Members

Queue

Description

Describes a queue.

Members
Name
Type: string

The name of the queue.

URL
Type: string

The URL of the queue.

ResourceNotFoundException

Description

A resource doesn't exist for the specified Amazon Resource Name (ARN).

Members

ResourceQuota

Description

The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.

Members
Maximum
Type: int

The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.

ResourceQuotas

Description

A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.

Members
ApplicationQuota
Type: ResourceQuota structure

The quota for applications in the AWS account.

ApplicationVersionQuota
Type: ResourceQuota structure

The quota for application versions in the AWS account.

ConfigurationTemplateQuota
Type: ResourceQuota structure

The quota for configuration templates in the AWS account.

CustomPlatformQuota
Type: ResourceQuota structure

The quota for custom platforms in the AWS account.

EnvironmentQuota
Type: ResourceQuota structure

The quota for environments in the AWS account.

ResourceTagsDescriptionMessage

Members
ResourceArn
Type: string

The Amazon Resource Name (ARN) of the resource for which a tag list was requested.

ResourceTags
Type: Array of Tag structures

A list of tag key-value pairs.

ResourceTypeNotSupportedException

Description

The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.

Members

S3Location

Description

The bucket and key of an item stored in Amazon S3.

Members
S3Bucket
Type: string

The Amazon S3 bucket where the data is located.

S3Key
Type: string

The Amazon S3 key where the data is located.

S3LocationNotInServiceRegionException

Description

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

Members

S3SubscriptionRequiredException

Description

The specified account does not have a subscription to Amazon S3.

Members

SearchFilter

Description

Describes criteria to restrict a list of results.

For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]

Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...

The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.

Members
Attribute
Type: string

The result attribute to which the filter values are applied. Valid values vary by API action.

Operator
Type: string

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Values
Type: Array of strings

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

SingleInstanceHealth

Description

Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.

Members
ApplicationMetrics
Type: ApplicationMetrics structure

Request metrics from your application.

AvailabilityZone
Type: string

The availability zone in which the instance runs.

Causes
Type: Array of strings

Represents the causes, which provide more information about the current health status.

Color
Type: string

Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.

Deployment
Type: Deployment structure

Information about the most recent deployment to an instance.

HealthStatus
Type: string

Returns the health status of the specified instance. For more information, see Health Colors and Statuses.

InstanceId
Type: string

The ID of the Amazon EC2 instance.

InstanceType
Type: string

The instance's type.

LaunchedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the EC2 instance was launched.

System
Type: SystemStatus structure

Operating system metrics from the instance.

SolutionStackDescription

Description

Describes the solution stack.

Members
PermittedFileTypes
Type: Array of strings

The permitted file types allowed for a solution stack.

SolutionStackName
Type: string

The name of the solution stack.

SourceBuildInformation

Description

Location of the source code for an application version.

Members
SourceLocation
Required: Yes
Type: string

The location of the source code, as a formatted string, depending on the value of SourceRepository

  • For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.

  • For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.

SourceRepository
Required: Yes
Type: string

Location where the repository is stored.

  • CodeCommit

  • S3

SourceType
Required: Yes
Type: string

The type of repository.

  • Git

  • Zip

SourceBundleDeletionException

Description

Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.

Members

SourceConfiguration

Description

A specification for an environment configuration.

Members
ApplicationName
Type: string

The name of the application associated with the configuration.

TemplateName
Type: string

The name of the configuration template.

StatusCodes

Description

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. For more information, see Status Code Definitions.

Members
Status2xx
Type: int

The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.

Status3xx
Type: int

The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.

Status4xx
Type: int

The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.

Status5xx
Type: int

The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.

SystemStatus

Description

CPU utilization and load average metrics for an Amazon EC2 instance.

Members
CPUUtilization
Type: CPUUtilization structure

CPU utilization metrics for the instance.

LoadAverage
Type: Array of doubles

Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.

Tag

Description

Describes a tag applied to a resource in an environment.

Members
Key
Type: string

The key of the tag.

Value
Type: string

The value of the tag.

TooManyApplicationVersionsException

Description

The specified account has reached its limit of application versions.

Members

TooManyApplicationsException

Description

The specified account has reached its limit of applications.

Members

TooManyBucketsException

Description

The specified account has reached its limit of Amazon S3 buckets.

Members

TooManyConfigurationTemplatesException

Description

The specified account has reached its limit of configuration templates.

Members

TooManyEnvironmentsException

Description

The specified account has reached its limit of environments.

Members

TooManyPlatformsException

Description

You have exceeded the maximum number of allowed platforms associated with the account.

Members

TooManyTagsException

Description

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.

Members

Trigger

Description

Describes a trigger.

Members
Name
Type: string

The name of the trigger.

ValidationMessage

Description

An error or warning for a desired configuration option value.

Members
Message
Type: string

A message describing the error or warning.

Namespace
Type: string

The namespace to which the option belongs.

OptionName
Type: string

The name of the option.

Severity
Type: string

An indication of the severity of this message:

  • error: This message indicates that this is not a valid setting for an option.

  • warning: This message is providing information you should take into account.