Icon

AWS Elastic Beanstalk (version v1.*.*)

abort_environment_update

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

Parameters

$body

Type: object

{
"EnvironmentId" : "This specifies the ID of the environment with the in-progress update that you want to cancel.",
"EnvironmentName" : "This specifies the name of the environment with the in-progress update that you want to cancel."
}

apply_environment_managed_action

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.

Parameters

$body

Request to execute a scheduled managed action immediately.

Type: object

{
"EnvironmentId" : "The environment ID of the target environment.",
"ActionId" : "The action ID of the scheduled managed action to execute.",
"EnvironmentName" : "The name of the target environment."
}

check_dns_availability

Checks if the specified CNAME is available.

Parameters

$body

Results message indicating whether a CNAME is available.

Type: object

{
"CNAMEPrefix" : "The prefix used when this CNAME is reserved."
}

compose_environments

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.

Parameters

$body

Request to create or update a group of environments.

Type: object

{
"GroupName" : "The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.",
"VersionLabels" : [ "string" ],
"ApplicationName" : "The name of the application to which the specified source bundles belong."
}

create_application

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

Parameters

$body

Request to create an application.

Type: object

{
"ApplicationName" : "The name of the application. \nConstraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.",
"Description" : "Describes the application.",
"ResourceLifecycleConfig" : {
"ServiceRole" : "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. \nThe ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.",
"VersionLifecycleConfig" : {
"MaxCountRule" : {
"DeleteSourceFromS3" : "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.",
"Enabled" : "Specify true to apply the rule, or false to disable it.",
"MaxCount" : "Specify the maximum number of application versions to retain."
},
"MaxAgeRule" : {
"DeleteSourceFromS3" : "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.",
"MaxAgeInDays" : "Specify the number of days to retain an application versions.",
"Enabled" : "Specify true to apply the rule, or false to disable it."
}
}
},
"Tags" : [ {
"Tag" : {
"Value" : "The value of the tag.",
"Key" : "The key of the tag."
}
} ]
}

create_application_version

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.
Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

Parameters

$body

Type: object

{
"SourceBuildInformation" : {
"SourceLocation" : "The location of the source code, as a formatted string, depending on the value of SourceRepository \n For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a. \n For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file. ",
"SourceType" : "The type of repository. \n Git \n Zip ",
"SourceRepository" : "Location where the repository is stored. \n CodeCommit \n S3 "
},
"BuildConfiguration" : {
"CodeBuildServiceRole" : "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.",
"ArtifactName" : "The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip. ",
"Image" : "The ID of the Docker image to use for this build project.",
"ComputeType" : "Information about the compute resources the build project will use. \n BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds \n BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds \n BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds ",
"TimeoutInMinutes" : "How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes."
},
"ApplicationName" : " The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error. ",
"Description" : "Describes this version.",
"VersionLabel" : "A label identifying this version. \nConstraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
"SourceBundle" : {
"S3Bucket" : "The Amazon S3 bucket where the data is located.",
"S3Key" : "The Amazon S3 key where the data is located."
},
"Process" : "Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment. \nYou must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional. \nThe Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.",
"AutoCreateApplication" : "Set to true to create an application with the specified name if it doesn't already exist.",
"Tags" : [ {
"Tag" : {
"Value" : "The value of the tag.",
"Key" : "The key of the tag."
}
} ]
}

create_configuration_template

Creates a configuration template. Templates are associated with a specific application and are used 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

Parameters

$body

Request to create a configuration template.

Type: object

{
"PlatformArn" : "The ARN of the custom platform.",
"EnvironmentId" : "The ID of the environment used with this configuration template.",
"ApplicationName" : "The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
"Description" : "Describes this configuration.",
"OptionSettings" : [ {
"ConfigurationOptionSetting" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Value" : "The current value for the configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ],
"SourceConfiguration" : {
"ApplicationName" : "The name of the application associated with the configuration.",
"TemplateName" : "The name of the configuration template."
},
"TemplateName" : "The name of the configuration template. \nConstraint: This name must be unique per application. \nDefault: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
"SolutionStackName" : "The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values. \n Use ListAvailableSolutionStacks to obtain a list of available solution stacks. \n A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error. \nIf a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.",
"Tags" : [ {
"Tag" : {
"Value" : "The value of the tag.",
"Key" : "The key of the tag."
}
} ]
}

create_environment

Launches an environment for the specified application using the specified configuration.

Parameters

$body

Type: object

{
"GroupName" : "The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.",
"PlatformArn" : "The ARN of the platform.",
"ApplicationName" : "The name of the application that contains the version to be deployed. \n If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error. ",
"Description" : "Describes this environment.",
"EnvironmentName" : "A unique name for the deployment environment. Used in the application URL. \nConstraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error. \nDefault: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.",
"Tier" : {
"Type" : "The type of this environment tier. \nValid values: \n For Web server tier – Standard \n For Worker tier – SQS/HTTP ",
"Version" : "The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. \nThis member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.",
"Name" : "The name of this environment tier. \nValid values: \n For Web server tier – WebServer \n For Worker tier – Worker "
},
"VersionLabel" : "The name of the application version to deploy. \n If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error. \nDefault: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.",
"OptionsToRemove" : [ {
"OptionSpecification" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ],
"OptionSettings" : [ {
"ConfigurationOptionSetting" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Value" : "The current value for the configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ],
"TemplateName" : " The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
"SolutionStackName" : "This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. \nFor a list of current solution stacks, see Elastic Beanstalk Supported Platforms.",
"CNAMEPrefix" : "If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.",
"Tags" : [ {
"Tag" : {
"Value" : "The value of the tag.",
"Key" : "The key of the tag."
}
} ]
}

create_platform_version

Create a new version of your custom platform.

Parameters

$body

Request to create a new platform version.

Type: object

{
"PlatformName" : "The name of your custom platform.",
"PlatformVersion" : "The number, such as 1.0.2, for the new platform version.",
"EnvironmentName" : "The name of the builder environment.",
"OptionSettings" : [ {
"ConfigurationOptionSetting" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Value" : "The current value for the configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ],
"PlatformDefinitionBundle" : {
"S3Bucket" : "The Amazon S3 bucket where the data is located.",
"S3Key" : "The Amazon S3 key where the data is located."
},
"Tags" : [ {
"Tag" : {
"Value" : "The value of the tag.",
"Key" : "The key of the tag."
}
} ]
}

create_storage_location

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.

This operation has no parameters

delete_application

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
You cannot delete an application that has a running environment.

Parameters

$body

Request to delete an application.

Type: object

{
"ApplicationName" : "The name of the application to delete.",
"TerminateEnvByForce" : "When set to true, running environments will be terminated before deleting the application."
}

delete_application_version

Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment.

Parameters

$body

Request to delete an application version.

Type: object

{
"DeleteSourceBundle" : "Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.",
"ApplicationName" : "The name of the application to which the version belongs.",
"VersionLabel" : "The label of the version to delete."
}

delete_configuration_template

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

Parameters

$body

Request to delete a configuration template.

Type: object

{
"ApplicationName" : "The name of the application to delete the configuration template from.",
"TemplateName" : "The name of the configuration template to delete."
}

delete_environment_configuration

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.

Parameters

$body

Request to delete a draft environment configuration.

Type: object

{
"ApplicationName" : "The name of the application the environment is associated with.",
"EnvironmentName" : "The name of the environment to delete the draft configuration from."
}

delete_platform_version

Deletes the specified version of a custom platform.

Parameters

$body

Type: object

{
"PlatformArn" : "The ARN of the version of the custom platform."
}

describe_account_attributes

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
The result currently has one set of attributes—resource quotas.

This operation has no parameters

describe_application_versions

Retrieve a list of application versions.

Parameters

$body

Request to describe application versions.

Type: object

{
"VersionLabels" : [ "string" ],
"ApplicationName" : "Specify an application name to show only application versions for that application."
}

describe_applications

Returns the descriptions of existing applications.

Parameters

$body

Request to describe one or more applications.

Type: object

{
"ApplicationNames" : [ "string" ]
}

describe_configuration_options

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.

Parameters

$body

Result message containing a list of application version descriptions.

Type: object

{
"Options" : [ {
"OptionSpecification" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ],
"PlatformArn" : "The ARN of the custom platform.",
"ApplicationName" : "The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.",
"EnvironmentName" : "The name of the environment whose configuration options you want to describe.",
"TemplateName" : "The name of the configuration template whose configuration options you want to describe.",
"SolutionStackName" : "The name of the solution stack whose configuration options you want to describe."
}

describe_configuration_settings

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

Parameters

$body

Result message containing all of the configuration settings for a specified solution stack or configuration template.

Type: object

{
"ApplicationName" : "The application for the environment or configuration template.",
"EnvironmentName" : "The name of the environment to describe. \n Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"TemplateName" : "The name of the configuration template to describe. \n Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error. "
}

describe_environment_health

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

Parameters

$body

See the example below to learn how to create a request body.

Type: object

{
"EnvironmentId" : "Specify the environment by ID. \nYou must specify either this or an EnvironmentName, or both.",
"EnvironmentName" : "Specify the environment by name. \nYou must specify either this or an EnvironmentName, or both.",
"AttributeNames" : [ "string. Possible values: Status | Color | Causes | ApplicationMetrics | InstancesHealth | All | HealthStatus | RefreshedAt" ]
}

describe_environment_managed_action_history

Lists an environment's completed and failed managed actions.

Parameters

$body

Request to list completed and failed managed actions.

Type: object

{
"EnvironmentId" : "The environment ID of the target environment.",
"EnvironmentName" : "The name of the target environment."
}

describe_environment_managed_actions

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

Parameters

$body

Request to list an environment's upcoming and in-progress managed actions.

Type: object

{
"Status" : "To show only actions with a particular status, specify a status.",
"EnvironmentId" : "The environment ID of the target environment.",
"EnvironmentName" : "The name of the target environment."
}

describe_environment_resources

Returns AWS resources for this environment.

Parameters

$body

Request to describe the resources in an environment.

Type: object

{
"EnvironmentId" : "The ID of the environment to retrieve AWS resource usage data. \n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"EnvironmentName" : "The name of the environment to retrieve AWS resource usage data. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. "
}

describe_environments

Returns descriptions for existing environments.

Parameters

$body

Request to describe one or more environments.

Type: object

{
"IncludedDeletedBackTo" : " If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed. ",
"EnvironmentNames" : [ "string" ],
"ApplicationName" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.",
"VersionLabel" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.",
"IncludeDeleted" : "Indicates whether to include deleted environments: \n true: Environments that have been deleted after IncludedDeletedBackTo are displayed. \n false: Do not include deleted environments.",
"EnvironmentIds" : [ "string" ]
}

describe_events

Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified NextToken.

Parameters

$body

Request to retrieve a list of events for an environment.

Type: object

{
"EnvironmentId" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.",
"PlatformArn" : "The ARN of the version of the custom platform.",
"ApplicationName" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.",
"RequestId" : "If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.",
"EndTime" : " If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime. ",
"EnvironmentName" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.",
"VersionLabel" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.",
"StartTime" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.",
"TemplateName" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.",
"Severity" : "If specified, limits the events returned from this call to include only those with the specified severity or higher."
}

describe_instances_health

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

Parameters

$body

Parameters for a call to DescribeInstancesHealth.

Type: object

{
"EnvironmentId" : "Specify the AWS Elastic Beanstalk environment by ID.",
"NextToken" : "Specify the pagination token returned by a previous call.",
"EnvironmentName" : "Specify the AWS Elastic Beanstalk environment by name.",
"AttributeNames" : [ "string. Possible values: HealthStatus | Color | Causes | ApplicationMetrics | RefreshedAt | LaunchedAt | System | Deployment | AvailabilityZone | InstanceType | All" ]
}

describe_platform_version

Describes the version of the platform.

Parameters

$body

Type: object

{
"PlatformArn" : "The ARN of the version of the platform."
}

list_available_solution_stacks

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

This operation has no parameters

list_platform_versions

Lists the available platforms.

Parameters

$body

Type: object

{
"Filters" : [ {
"PlatformFilter" : {
"Operator" : "The operator to apply to the Type with each of the Values. \n Valid Values: = (equal to) | != (not equal to) | < (less than) | <= (less than or equal to) | > (greater than) | >= (greater than or equal to) | contains | begins_with | ends_with ",
"Type" : "The custom platform attribute to which the filter values are applied. \nValid Values: PlatformName | PlatformVersion | PlatformStatus | PlatformOwner ",
"Values" : [ "string" ]
}
} ]
}

list_tags_for_resource

Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment.

Parameters

$body

Type: object

{
"ResourceArn" : "The Amazon Resource Name (ARN) of the resouce for which a tag list is requested. \nMust be the ARN of an Elastic Beanstalk environment."
}

rebuild_environment

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.

Parameters

$body

Type: object

{
"EnvironmentId" : "The ID of the environment to rebuild. \n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"EnvironmentName" : "The name of the environment to rebuild. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. "
}

request_environment_info

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

Parameters

$body

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

Type: object

{
"EnvironmentId" : "The ID of the environment of the requested data. \nIf no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error. \nCondition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"EnvironmentName" : "The name of the environment of the requested data. \nIf no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error. \nCondition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"InfoType" : "The type of information to request."
}

restart_app_server

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

Parameters

$body

Type: object

{
"EnvironmentId" : "The ID of the environment to restart the server for. \n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"EnvironmentName" : "The name of the environment to restart the server for. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. "
}

retrieve_environment_info

Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
RequestEnvironmentInfo

Parameters

$body

Request to download logs retrieved with RequestEnvironmentInfo.

Type: object

{
"EnvironmentId" : "The ID of the data's environment. \nIf no such environment is found, returns an InvalidParameterValue error. \nCondition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.",
"EnvironmentName" : "The name of the data's environment. \n If no such environment is found, returns an InvalidParameterValue error. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"InfoType" : "The type of information to retrieve."
}

swap_environment_cnam_es

Swaps the CNAMEs of two environments.

Parameters

$body

Swaps the CNAMEs of two environments.

Type: object

{
"SourceEnvironmentName" : "The name of the source environment. \n Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName. ",
"DestinationEnvironmentId" : "The ID of the destination environment. \n Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId. ",
"DestinationEnvironmentName" : "The name of the destination environment. \n Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName. ",
"SourceEnvironmentId" : "The ID of the source environment. \n Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId. "
}

terminate_environment

Terminates the specified environment.

Parameters

$body

Request to terminate an environment.

Type: object

{
"EnvironmentId" : "The ID of the environment to terminate. \n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"EnvironmentName" : "The name of the environment to terminate. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"TerminateResources" : "Indicates whether the associated AWS resources should shut down when the environment is terminated: \n true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. \n false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. \n For more information, see the AWS Elastic Beanstalk User Guide. \n Default: true \n Valid Values: true | false ",
"ForceTerminate" : "Terminates the target environment even if another environment in the same group is dependent on it."
}

update_application

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

Parameters

$body

Request to update an application.

Type: object

{
"ApplicationName" : "The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error. ",
"Description" : "A new description for the application. \nDefault: If not specified, AWS Elastic Beanstalk does not update the description."
}

update_application_resource_lifecycle

Modifies lifecycle settings for an application.

Parameters

$body

Type: object

{
"ApplicationName" : "The name of the application.",
"ResourceLifecycleConfig" : {
"ServiceRole" : "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. \nThe ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.",
"VersionLifecycleConfig" : {
"MaxCountRule" : {
"DeleteSourceFromS3" : "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.",
"Enabled" : "Specify true to apply the rule, or false to disable it.",
"MaxCount" : "Specify the maximum number of application versions to retain."
},
"MaxAgeRule" : {
"DeleteSourceFromS3" : "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.",
"MaxAgeInDays" : "Specify the number of days to retain an application versions.",
"Enabled" : "Specify true to apply the rule, or false to disable it."
}
}
}
}

update_application_version

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

Parameters

$body

Type: object

{
"ApplicationName" : "The name of the application associated with this version. \n If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.",
"Description" : "A new description for this version.",
"VersionLabel" : "The name of the version to update. \nIf no application version is found with this label, UpdateApplication returns an InvalidParameterValue error. "
}

update_configuration_template

Updates the specified configuration template to have the specified properties or configuration option values.
If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.
Related Topics
DescribeConfigurationOptions

Parameters

$body

The result message containing the options for the specified solution stack.

Type: object

{
"ApplicationName" : "The name of the application associated with the configuration template to update. \n If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error. ",
"Description" : "A new description for the configuration.",
"OptionSettings" : [ {
"ConfigurationOptionSetting" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Value" : "The current value for the configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ],
"TemplateName" : "The name of the configuration template to update. \n If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error. ",
"OptionsToRemove" : [ {
"OptionSpecification" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ]
}

update_environment

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.

Parameters

$body

Request to update an environment.

Type: object

{
"GroupName" : "The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.",
"EnvironmentId" : "The ID of the environment to update. \nIf no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. \nCondition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"PlatformArn" : "The ARN of the platform, if used.",
"ApplicationName" : "The name of the application with which the environment is associated.",
"Description" : "If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.",
"EnvironmentName" : "The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. \nCondition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
"Tier" : {
"Type" : "The type of this environment tier. \nValid values: \n For Web server tier – Standard \n For Worker tier – SQS/HTTP ",
"Version" : "The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. \nThis member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.",
"Name" : "The name of this environment tier. \nValid values: \n For Web server tier – WebServer \n For Worker tier – Worker "
},
"OptionSettings" : [ {
"ConfigurationOptionSetting" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Value" : "The current value for the configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ],
"VersionLabel" : "If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error. ",
"TemplateName" : "If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
"SolutionStackName" : "This specifies the platform version that the environment will run after the environment is updated.",
"OptionsToRemove" : [ {
"OptionSpecification" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ]
}

update_tags_for_resource

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.
Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment.
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.

Parameters

$body

Type: object

{
"ResourceArn" : "The Amazon Resource Name (ARN) of the resouce to be updated. \nMust be the ARN of an Elastic Beanstalk environment.",
"TagsToAdd" : [ {
"Tag" : {
"Value" : "The value of the tag.",
"Key" : "The key of the tag."
}
} ],
"TagsToRemove" : [ "string" ]
}

validate_configuration_settings

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.

Parameters

$body

A list of validation messages for a specified configuration template.

Type: object

{
"ApplicationName" : "The name of the application that the configuration template or environment belongs to.",
"EnvironmentName" : "The name of the environment to validate the settings against. \nCondition: You cannot specify both this and a configuration template name.",
"OptionSettings" : [ {
"ConfigurationOptionSetting" : {
"ResourceName" : "A unique resource name for a time-based scaling configuration option.",
"Value" : "The current value for the configuration option.",
"Namespace" : "A unique namespace identifying the option's associated AWS resource.",
"OptionName" : "The name of the configuration option."
}
} ],
"TemplateName" : "The name of the configuration template to validate the settings against. \nCondition: You cannot specify both this and an environment name."
}