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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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.

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

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

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

• DescribeConfigurationOptions

• DescribeConfigurationSettings

• ListAvailableSolutionStacks

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

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

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

• DeleteEnvironmentConfiguration

Parameter Syntax

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

Parameter Details

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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.

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

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

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

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

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

• RetrieveEnvironmentInfo

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

• RequestEnvironmentInfo

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

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

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.

Parameter Syntax

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

Parameter Details

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

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

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

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.

Parameter Syntax

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

Parameter Details

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

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.

Related Topics

• DescribeConfigurationOptions

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

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

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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' => [
    ],
]