AWS API Changes

2017/08/08 - AWS Elastic Beanstalk - 5 updated api methods

Changes Add support for paginating the result of DescribeEnvironments Include the ARN of described environments in DescribeEnvironments output

ComposeEnvironments (updated)

Link ¶
Changes (response)

{'Environments': {'EnvironmentArn': 'string'}, 'NextToken': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.compose_environments(
    ApplicationName='string',
    GroupName='string',
    VersionLabels=[
        'string',
    ]
)

type ApplicationName

string

param ApplicationName

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

type GroupName

string

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

type VersionLabels

list

param VersionLabels

A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.

(string) --

rtype

dict

returns

Response Syntax

{
    'Environments': [
        {
            'EnvironmentName': 'string',
            'EnvironmentId': 'string',
            'ApplicationName': 'string',
            'VersionLabel': 'string',
            'SolutionStackName': 'string',
            'PlatformArn': 'string',
            'TemplateName': 'string',
            'Description': 'string',
            'EndpointURL': 'string',
            'CNAME': 'string',
            'DateCreated': datetime(2015, 1, 1),
            'DateUpdated': datetime(2015, 1, 1),
            'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
            'AbortableOperationInProgress': True|False,
            'Health': 'Green'|'Yellow'|'Red'|'Grey',
            'HealthStatus': 'NoData'|'Unknown'|'Pending'|'Ok'|'Info'|'Warning'|'Degraded'|'Severe',
            'Resources': {
                'LoadBalancer': {
                    'LoadBalancerName': 'string',
                    'Domain': 'string',
                    'Listeners': [
                        {
                            'Protocol': 'string',
                            'Port': 123
                        },
                    ]
                }
            },
            'Tier': {
                'Name': 'string',
                'Type': 'string',
                'Version': 'string'
            },
            'EnvironmentLinks': [
                {
                    'LinkName': 'string',
                    'EnvironmentName': 'string'
                },
            ],
            'EnvironmentArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Result message containing a list of environment descriptions.
- Environments (list) --
  
  Returns an EnvironmentDescription list.
  - (dict) --
    
    Describes the properties of an environment.
    - EnvironmentName (string) --
      
      The name of this environment.
    - EnvironmentId (string) --
      
      The ID of this environment.
    - ApplicationName (string) --
      
      The name of the application associated with this environment.
    - VersionLabel (string) --
      
      The application version deployed in this environment.
    - SolutionStackName (string) --
      
      The name of the SolutionStack deployed with this environment.
    - PlatformArn (string) --
      
      The ARN of the platform.
    - TemplateName (string) --
      
      The name of the configuration template used to originally launch this environment.
    - Description (string) --
      
      Describes this environment.
    - EndpointURL (string) --
      
      For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
    - CNAME (string) --
      
      The URL to the CNAME for this environment.
    - DateCreated (datetime) --
      
      The creation date for this environment.
    - DateUpdated (datetime) --
      
      The last modified date for this environment.
    - Status (string) --
      
      The current operational status of the environment:
      - Launching : Environment is in the process of initial deployment.
      - Updating : Environment is in the process of updating its configuration settings or application version.
      - Ready : Environment is available to have an action performed on it, such as update or terminate.
      - Terminating : Environment is in the shut-down process.
      - Terminated : Environment is not running.
    - AbortableOperationInProgress (boolean) --
      
      Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
      
      true: There is an update in progress.
      
      false: There are no updates currently in progress.
    - Health (string) --
      
      Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
      - Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      - Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      - Green : Indicates the environment is healthy and fully functional.
      - Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
      Default: Grey
    - HealthStatus (string) --
      
      Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .
    - Resources (dict) --
      
      The description of the AWS resources used by this environment.
      - LoadBalancer (dict) --
        
        Describes the LoadBalancer.
        
        LoadBalancerName (string) --
        
        The name of the LoadBalancer.
        
        Domain (string) --
        
        The domain name of the LoadBalancer.
        
        Listeners (list) --
        
        A list of Listeners used by the LoadBalancer.
        
        (dict) --
        
        Describes the properties of a Listener for the LoadBalancer.
        
        Protocol (string) --
        
        The protocol that is used by the Listener.
        
        Port (integer) --
        
        The port that is used by the Listener.
    - Tier (dict) --
      
      Describes the current tier of this environment.
      - Name (string) --
        
        The name of this environment tier.
      - Type (string) --
        
        The type of this environment tier.
      - Version (string) --
        
        The version of this environment tier.
    - EnvironmentLinks (list) --
      
      A list of links to other environments in the same group.
      - (dict) --
        
        A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
        
        LinkName (string) --
        
        The name of the link.
        
        EnvironmentName (string) --
        
        The name of the linked environment (the dependency).
    - EnvironmentArn (string) --
      
      The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
- NextToken (string) --
  
  In a paginated request, the token that you can pass in a subsequent request to get the next response page.

CreateEnvironment (updated)

Link ¶
Changes (response)

{'EnvironmentArn': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.create_environment(
    ApplicationName='string',
    EnvironmentName='string',
    GroupName='string',
    Description='string',
    CNAMEPrefix='string',
    Tier={
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    VersionLabel='string',
    TemplateName='string',
    SolutionStackName='string',
    PlatformArn='string',
    OptionSettings=[
        {
            'ResourceName': 'string',
            'Namespace': 'string',
            'OptionName': 'string',
            'Value': 'string'
        },
    ],
    OptionsToRemove=[
        {
            'ResourceName': 'string',
            'Namespace': 'string',
            'OptionName': 'string'
        },
    ]
)

type ApplicationName

string

param ApplicationName

[REQUIRED]

The name of the application that contains the version to be deployed.

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

type EnvironmentName

string

param EnvironmentName

A unique name for the deployment environment. Used in the application URL.

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

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

type GroupName

string

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

type Description

string

param Description

Describes this environment.

type CNAMEPrefix

string

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

type Tier

dict

param Tier

This specifies the tier to use for creating this environment.

Name (string) --

The name of this environment tier.
Type (string) --

The type of this environment tier.
Version (string) --

The version of this environment tier.

type Tags

list

param Tags

This specifies the tags applied to resources in the environment.

(dict) --

Describes a tag applied to a resource in an environment.
- Key (string) --
  
  The key of the tag.
- Value (string) --
  
  The value of the tag.

type VersionLabel

string

param VersionLabel

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

type TemplateName

string

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

type SolutionStackName

string

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

type PlatformArn

string

param PlatformArn

The ARN of the platform.

type OptionSettings

list

param OptionSettings

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

(dict) --

A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide .
- ResourceName (string) --
  
  A unique resource name for a time-based scaling configuration option.
- Namespace (string) --
  
  A unique namespace identifying the option's associated AWS resource.
- OptionName (string) --
  
  The name of the configuration option.
- Value (string) --
  
  The current value for the configuration option.

type OptionsToRemove

list

param OptionsToRemove

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

(dict) --

A specification identifying an individual configuration option.
- ResourceName (string) --
  
  A unique resource name for a time-based scaling configuration option.
- Namespace (string) --
  
  A unique namespace identifying the option's associated AWS resource.
- OptionName (string) --
  
  The name of the configuration option.

rtype

dict

returns

Response Syntax

{
    'EnvironmentName': 'string',
    'EnvironmentId': 'string',
    'ApplicationName': 'string',
    'VersionLabel': 'string',
    'SolutionStackName': 'string',
    'PlatformArn': 'string',
    'TemplateName': 'string',
    'Description': 'string',
    'EndpointURL': 'string',
    'CNAME': 'string',
    'DateCreated': datetime(2015, 1, 1),
    'DateUpdated': datetime(2015, 1, 1),
    'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
    'AbortableOperationInProgress': True|False,
    'Health': 'Green'|'Yellow'|'Red'|'Grey',
    'HealthStatus': 'NoData'|'Unknown'|'Pending'|'Ok'|'Info'|'Warning'|'Degraded'|'Severe',
    'Resources': {
        'LoadBalancer': {
            'LoadBalancerName': 'string',
            'Domain': 'string',
            'Listeners': [
                {
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        }
    },
    'Tier': {
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    'EnvironmentLinks': [
        {
            'LinkName': 'string',
            'EnvironmentName': 'string'
        },
    ],
    'EnvironmentArn': 'string'
}

Response Structure

(dict) --

Describes the properties of an environment.
- EnvironmentName (string) --
  
  The name of this environment.
- EnvironmentId (string) --
  
  The ID of this environment.
- ApplicationName (string) --
  
  The name of the application associated with this environment.
- VersionLabel (string) --
  
  The application version deployed in this environment.
- SolutionStackName (string) --
  
  The name of the SolutionStack deployed with this environment.
- PlatformArn (string) --
  
  The ARN of the platform.
- TemplateName (string) --
  
  The name of the configuration template used to originally launch this environment.
- Description (string) --
  
  Describes this environment.
- EndpointURL (string) --
  
  For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
- CNAME (string) --
  
  The URL to the CNAME for this environment.
- DateCreated (datetime) --
  
  The creation date for this environment.
- DateUpdated (datetime) --
  
  The last modified date for this environment.
- Status (string) --
  
  The current operational status of the environment:
  - Launching : Environment is in the process of initial deployment.
  - Updating : Environment is in the process of updating its configuration settings or application version.
  - Ready : Environment is available to have an action performed on it, such as update or terminate.
  - Terminating : Environment is in the shut-down process.
  - Terminated : Environment is not running.
- AbortableOperationInProgress (boolean) --
  
  Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
  
  true: There is an update in progress.
  
  false: There are no updates currently in progress.
- Health (string) --
  
  Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
  - Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
  - Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
  - Green : Indicates the environment is healthy and fully functional.
  - Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
  Default: Grey
- HealthStatus (string) --
  
  Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .
- Resources (dict) --
  
  The description of the AWS resources used by this environment.
  - LoadBalancer (dict) --
    
    Describes the LoadBalancer.
    - LoadBalancerName (string) --
      
      The name of the LoadBalancer.
    - Domain (string) --
      
      The domain name of the LoadBalancer.
    - Listeners (list) --
      
      A list of Listeners used by the LoadBalancer.
      - (dict) --
        
        Describes the properties of a Listener for the LoadBalancer.
        
        Protocol (string) --
        
        The protocol that is used by the Listener.
        
        Port (integer) --
        
        The port that is used by the Listener.
- Tier (dict) --
  
  Describes the current tier of this environment.
  - Name (string) --
    
    The name of this environment tier.
  - Type (string) --
    
    The type of this environment tier.
  - Version (string) --
    
    The version of this environment tier.
- EnvironmentLinks (list) --
  
  A list of links to other environments in the same group.
  - (dict) --
    
    A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
    - LinkName (string) --
      
      The name of the link.
    - EnvironmentName (string) --
      
      The name of the linked environment (the dependency).
- EnvironmentArn (string) --
  
  The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.

DescribeEnvironments (updated)

Link ¶
Changes (request, response)
Request

{'MaxRecords': 'integer', 'NextToken': 'string'}

Response

{'Environments': {'EnvironmentArn': 'string'}, 'NextToken': 'string'}

Returns descriptions for existing environments.

See also: AWS API Documentation

Request Syntax

client.describe_environments(
    ApplicationName='string',
    VersionLabel='string',
    EnvironmentIds=[
        'string',
    ],
    EnvironmentNames=[
        'string',
    ],
    IncludeDeleted=True|False,
    IncludedDeletedBackTo=datetime(2015, 1, 1),
    MaxRecords=123,
    NextToken='string'
)

type ApplicationName

string

param ApplicationName

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

type VersionLabel

string

param VersionLabel

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

type EnvironmentIds

list

param EnvironmentIds

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

(string) --

type EnvironmentNames

list

param EnvironmentNames

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

(string) --

type IncludeDeleted

boolean

param IncludeDeleted

Indicates whether to include deleted environments:

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

false : Do not include deleted environments.

type IncludedDeletedBackTo

datetime

param IncludedDeletedBackTo

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

type MaxRecords

integer

param MaxRecords

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

type NextToken

string

param NextToken

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

rtype

dict

returns

Response Syntax

{
    'Environments': [
        {
            'EnvironmentName': 'string',
            'EnvironmentId': 'string',
            'ApplicationName': 'string',
            'VersionLabel': 'string',
            'SolutionStackName': 'string',
            'PlatformArn': 'string',
            'TemplateName': 'string',
            'Description': 'string',
            'EndpointURL': 'string',
            'CNAME': 'string',
            'DateCreated': datetime(2015, 1, 1),
            'DateUpdated': datetime(2015, 1, 1),
            'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
            'AbortableOperationInProgress': True|False,
            'Health': 'Green'|'Yellow'|'Red'|'Grey',
            'HealthStatus': 'NoData'|'Unknown'|'Pending'|'Ok'|'Info'|'Warning'|'Degraded'|'Severe',
            'Resources': {
                'LoadBalancer': {
                    'LoadBalancerName': 'string',
                    'Domain': 'string',
                    'Listeners': [
                        {
                            'Protocol': 'string',
                            'Port': 123
                        },
                    ]
                }
            },
            'Tier': {
                'Name': 'string',
                'Type': 'string',
                'Version': 'string'
            },
            'EnvironmentLinks': [
                {
                    'LinkName': 'string',
                    'EnvironmentName': 'string'
                },
            ],
            'EnvironmentArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Result message containing a list of environment descriptions.
- Environments (list) --
  
  Returns an EnvironmentDescription list.
  - (dict) --
    
    Describes the properties of an environment.
    - EnvironmentName (string) --
      
      The name of this environment.
    - EnvironmentId (string) --
      
      The ID of this environment.
    - ApplicationName (string) --
      
      The name of the application associated with this environment.
    - VersionLabel (string) --
      
      The application version deployed in this environment.
    - SolutionStackName (string) --
      
      The name of the SolutionStack deployed with this environment.
    - PlatformArn (string) --
      
      The ARN of the platform.
    - TemplateName (string) --
      
      The name of the configuration template used to originally launch this environment.
    - Description (string) --
      
      Describes this environment.
    - EndpointURL (string) --
      
      For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
    - CNAME (string) --
      
      The URL to the CNAME for this environment.
    - DateCreated (datetime) --
      
      The creation date for this environment.
    - DateUpdated (datetime) --
      
      The last modified date for this environment.
    - Status (string) --
      
      The current operational status of the environment:
      - Launching : Environment is in the process of initial deployment.
      - Updating : Environment is in the process of updating its configuration settings or application version.
      - Ready : Environment is available to have an action performed on it, such as update or terminate.
      - Terminating : Environment is in the shut-down process.
      - Terminated : Environment is not running.
    - AbortableOperationInProgress (boolean) --
      
      Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
      
      true: There is an update in progress.
      
      false: There are no updates currently in progress.
    - Health (string) --
      
      Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
      - Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
      - Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
      - Green : Indicates the environment is healthy and fully functional.
      - Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
      Default: Grey
    - HealthStatus (string) --
      
      Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .
    - Resources (dict) --
      
      The description of the AWS resources used by this environment.
      - LoadBalancer (dict) --
        
        Describes the LoadBalancer.
        
        LoadBalancerName (string) --
        
        The name of the LoadBalancer.
        
        Domain (string) --
        
        The domain name of the LoadBalancer.
        
        Listeners (list) --
        
        A list of Listeners used by the LoadBalancer.
        
        (dict) --
        
        Describes the properties of a Listener for the LoadBalancer.
        
        Protocol (string) --
        
        The protocol that is used by the Listener.
        
        Port (integer) --
        
        The port that is used by the Listener.
    - Tier (dict) --
      
      Describes the current tier of this environment.
      - Name (string) --
        
        The name of this environment tier.
      - Type (string) --
        
        The type of this environment tier.
      - Version (string) --
        
        The version of this environment tier.
    - EnvironmentLinks (list) --
      
      A list of links to other environments in the same group.
      - (dict) --
        
        A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
        
        LinkName (string) --
        
        The name of the link.
        
        EnvironmentName (string) --
        
        The name of the linked environment (the dependency).
    - EnvironmentArn (string) --
      
      The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
- NextToken (string) --
  
  In a paginated request, the token that you can pass in a subsequent request to get the next response page.

TerminateEnvironment (updated)

Link ¶
Changes (response)

{'EnvironmentArn': 'string'}

Terminates the specified environment.

See also: AWS API Documentation

Request Syntax

client.terminate_environment(
    EnvironmentId='string',
    EnvironmentName='string',
    TerminateResources=True|False,
    ForceTerminate=True|False
)

type EnvironmentId

string

param EnvironmentId

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

type EnvironmentName

string

param EnvironmentName

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

type TerminateResources

boolean

param TerminateResources

Indicates whether the associated AWS resources should shut down when the environment is terminated:

true : The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
false : AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

type ForceTerminate

boolean

param ForceTerminate

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

rtype

dict

returns

Response Syntax

{
    'EnvironmentName': 'string',
    'EnvironmentId': 'string',
    'ApplicationName': 'string',
    'VersionLabel': 'string',
    'SolutionStackName': 'string',
    'PlatformArn': 'string',
    'TemplateName': 'string',
    'Description': 'string',
    'EndpointURL': 'string',
    'CNAME': 'string',
    'DateCreated': datetime(2015, 1, 1),
    'DateUpdated': datetime(2015, 1, 1),
    'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
    'AbortableOperationInProgress': True|False,
    'Health': 'Green'|'Yellow'|'Red'|'Grey',
    'HealthStatus': 'NoData'|'Unknown'|'Pending'|'Ok'|'Info'|'Warning'|'Degraded'|'Severe',
    'Resources': {
        'LoadBalancer': {
            'LoadBalancerName': 'string',
            'Domain': 'string',
            'Listeners': [
                {
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        }
    },
    'Tier': {
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    'EnvironmentLinks': [
        {
            'LinkName': 'string',
            'EnvironmentName': 'string'
        },
    ],
    'EnvironmentArn': 'string'
}

Response Structure

(dict) --

Describes the properties of an environment.
- EnvironmentName (string) --
  
  The name of this environment.
- EnvironmentId (string) --
  
  The ID of this environment.
- ApplicationName (string) --
  
  The name of the application associated with this environment.
- VersionLabel (string) --
  
  The application version deployed in this environment.
- SolutionStackName (string) --
  
  The name of the SolutionStack deployed with this environment.
- PlatformArn (string) --
  
  The ARN of the platform.
- TemplateName (string) --
  
  The name of the configuration template used to originally launch this environment.
- Description (string) --
  
  Describes this environment.
- EndpointURL (string) --
  
  For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
- CNAME (string) --
  
  The URL to the CNAME for this environment.
- DateCreated (datetime) --
  
  The creation date for this environment.
- DateUpdated (datetime) --
  
  The last modified date for this environment.
- Status (string) --
  
  The current operational status of the environment:
  - Launching : Environment is in the process of initial deployment.
  - Updating : Environment is in the process of updating its configuration settings or application version.
  - Ready : Environment is available to have an action performed on it, such as update or terminate.
  - Terminating : Environment is in the shut-down process.
  - Terminated : Environment is not running.
- AbortableOperationInProgress (boolean) --
  
  Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
  
  true: There is an update in progress.
  
  false: There are no updates currently in progress.
- Health (string) --
  
  Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
  - Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
  - Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
  - Green : Indicates the environment is healthy and fully functional.
  - Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
  Default: Grey
- HealthStatus (string) --
  
  Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .
- Resources (dict) --
  
  The description of the AWS resources used by this environment.
  - LoadBalancer (dict) --
    
    Describes the LoadBalancer.
    - LoadBalancerName (string) --
      
      The name of the LoadBalancer.
    - Domain (string) --
      
      The domain name of the LoadBalancer.
    - Listeners (list) --
      
      A list of Listeners used by the LoadBalancer.
      - (dict) --
        
        Describes the properties of a Listener for the LoadBalancer.
        
        Protocol (string) --
        
        The protocol that is used by the Listener.
        
        Port (integer) --
        
        The port that is used by the Listener.
- Tier (dict) --
  
  Describes the current tier of this environment.
  - Name (string) --
    
    The name of this environment tier.
  - Type (string) --
    
    The type of this environment tier.
  - Version (string) --
    
    The version of this environment tier.
- EnvironmentLinks (list) --
  
  A list of links to other environments in the same group.
  - (dict) --
    
    A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
    - LinkName (string) --
      
      The name of the link.
    - EnvironmentName (string) --
      
      The name of the linked environment (the dependency).
- EnvironmentArn (string) --
  
  The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.

UpdateEnvironment (updated)

Link ¶
Changes (response)

{'EnvironmentArn': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.update_environment(
    ApplicationName='string',
    EnvironmentId='string',
    EnvironmentName='string',
    GroupName='string',
    Description='string',
    Tier={
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    VersionLabel='string',
    TemplateName='string',
    SolutionStackName='string',
    PlatformArn='string',
    OptionSettings=[
        {
            'ResourceName': 'string',
            'Namespace': 'string',
            'OptionName': 'string',
            'Value': 'string'
        },
    ],
    OptionsToRemove=[
        {
            'ResourceName': 'string',
            'Namespace': 'string',
            'OptionName': 'string'
        },
    ]
)

type ApplicationName

string

param ApplicationName

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

type EnvironmentId

string

param EnvironmentId

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

type EnvironmentName

string

param EnvironmentName

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

type GroupName

string

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

type Description

string

param Description

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

type Tier

dict

param Tier

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

Name (string) --

The name of this environment tier.
Type (string) --

The type of this environment tier.
Version (string) --

The version of this environment tier.

type VersionLabel

string

param VersionLabel

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

type TemplateName

string

param TemplateName

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

type SolutionStackName

string

param SolutionStackName

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

type PlatformArn

string

param PlatformArn

The ARN of the platform, if used.

type OptionSettings

list

param OptionSettings

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

(dict) --

A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide .
- ResourceName (string) --
  
  A unique resource name for a time-based scaling configuration option.
- Namespace (string) --
  
  A unique namespace identifying the option's associated AWS resource.
- OptionName (string) --
  
  The name of the configuration option.
- Value (string) --
  
  The current value for the configuration option.

type OptionsToRemove

list

param OptionsToRemove

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

(dict) --

A specification identifying an individual configuration option.
- ResourceName (string) --
  
  A unique resource name for a time-based scaling configuration option.
- Namespace (string) --
  
  A unique namespace identifying the option's associated AWS resource.
- OptionName (string) --
  
  The name of the configuration option.

rtype

dict

returns

Response Syntax

{
    'EnvironmentName': 'string',
    'EnvironmentId': 'string',
    'ApplicationName': 'string',
    'VersionLabel': 'string',
    'SolutionStackName': 'string',
    'PlatformArn': 'string',
    'TemplateName': 'string',
    'Description': 'string',
    'EndpointURL': 'string',
    'CNAME': 'string',
    'DateCreated': datetime(2015, 1, 1),
    'DateUpdated': datetime(2015, 1, 1),
    'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
    'AbortableOperationInProgress': True|False,
    'Health': 'Green'|'Yellow'|'Red'|'Grey',
    'HealthStatus': 'NoData'|'Unknown'|'Pending'|'Ok'|'Info'|'Warning'|'Degraded'|'Severe',
    'Resources': {
        'LoadBalancer': {
            'LoadBalancerName': 'string',
            'Domain': 'string',
            'Listeners': [
                {
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        }
    },
    'Tier': {
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    'EnvironmentLinks': [
        {
            'LinkName': 'string',
            'EnvironmentName': 'string'
        },
    ],
    'EnvironmentArn': 'string'
}

Response Structure

(dict) --

Describes the properties of an environment.
- EnvironmentName (string) --
  
  The name of this environment.
- EnvironmentId (string) --
  
  The ID of this environment.
- ApplicationName (string) --
  
  The name of the application associated with this environment.
- VersionLabel (string) --
  
  The application version deployed in this environment.
- SolutionStackName (string) --
  
  The name of the SolutionStack deployed with this environment.
- PlatformArn (string) --
  
  The ARN of the platform.
- TemplateName (string) --
  
  The name of the configuration template used to originally launch this environment.
- Description (string) --
  
  Describes this environment.
- EndpointURL (string) --
  
  For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
- CNAME (string) --
  
  The URL to the CNAME for this environment.
- DateCreated (datetime) --
  
  The creation date for this environment.
- DateUpdated (datetime) --
  
  The last modified date for this environment.
- Status (string) --
  
  The current operational status of the environment:
  - Launching : Environment is in the process of initial deployment.
  - Updating : Environment is in the process of updating its configuration settings or application version.
  - Ready : Environment is available to have an action performed on it, such as update or terminate.
  - Terminating : Environment is in the shut-down process.
  - Terminated : Environment is not running.
- AbortableOperationInProgress (boolean) --
  
  Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
  
  true: There is an update in progress.
  
  false: There are no updates currently in progress.
- Health (string) --
  
  Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
  - Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
  - Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
  - Green : Indicates the environment is healthy and fully functional.
  - Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
  Default: Grey
- HealthStatus (string) --
  
  Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .
- Resources (dict) --
  
  The description of the AWS resources used by this environment.
  - LoadBalancer (dict) --
    
    Describes the LoadBalancer.
    - LoadBalancerName (string) --
      
      The name of the LoadBalancer.
    - Domain (string) --
      
      The domain name of the LoadBalancer.
    - Listeners (list) --
      
      A list of Listeners used by the LoadBalancer.
      - (dict) --
        
        Describes the properties of a Listener for the LoadBalancer.
        
        Protocol (string) --
        
        The protocol that is used by the Listener.
        
        Port (integer) --
        
        The port that is used by the Listener.
- Tier (dict) --
  
  Describes the current tier of this environment.
  - Name (string) --
    
    The name of this environment tier.
  - Type (string) --
    
    The type of this environment tier.
  - Version (string) --
    
    The version of this environment tier.
- EnvironmentLinks (list) --
  
  A list of links to other environments in the same group.
  - (dict) --
    
    A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
    - LinkName (string) --
      
      The name of the link.
    - EnvironmentName (string) --
      
      The name of the linked environment (the dependency).
- EnvironmentArn (string) --
  
  The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.