AWS Elastic Beanstalk

2015/04/07 - AWS Elastic Beanstalk - 1 new 6 updated api methods

AbortEnvironmentUpdate (new) Link ¶

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

Request Syntax

client.abort_environment_update(
    EnvironmentId='string',
    EnvironmentName='string'
)
type EnvironmentId

string

param EnvironmentId

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

type EnvironmentName

string

param EnvironmentName

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

returns

None

CreateEnvironment (updated) Link ¶
Changes (response)
{'AbortableOperationInProgress': 'boolean'}

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

Request Syntax

client.create_environment(
    ApplicationName='string',
    EnvironmentName='string',
    Description='string',
    CNAMEPrefix='string',
    Tier={
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    VersionLabel='string',
    TemplateName='string',
    SolutionStackName='string',
    OptionSettings=[
        {
            'Namespace': 'string',
            'OptionName': 'string',
            'Value': 'string'
        },
    ],
    OptionsToRemove=[
        {
            '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

[REQUIRED]

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

Constraint: Must be from 4 to 23 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 in your account. If the specified name already exists, 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 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.

Condition: You must specify either this parameter or a SolutionStackName , but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

type SolutionStackName

string

param SolutionStackName

This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

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 a MissingRequiredParameter error.

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 .

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

    • 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',
    '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',
    'Resources': {
        'LoadBalancer': {
            'LoadBalancerName': 'string',
            'Domain': 'string',
            'Listeners': [
                {
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        }
    },
    'Tier': {
        'Name': 'string',
        'Type': 'string',
        'Version': '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.

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

      Lists in-progress environment updates and application version deployments that you can cancel.

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

      Yellow : Indicates that something is wrong, the application might not be available, but the instances appear running.

      Green : Indicates the environment is healthy and fully functional.

      • 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

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

DescribeEnvironments (updated) Link ¶
Changes (response)
{'Environments': {'AbortableOperationInProgress': 'boolean'}}

Returns descriptions for existing environments.

Request Syntax

client.describe_environments(
    ApplicationName='string',
    VersionLabel='string',
    EnvironmentIds=[
        'string',
    ],
    EnvironmentNames=[
        'string',
    ],
    IncludeDeleted=True|False,
    IncludedDeletedBackTo=datetime(2015, 1, 1)
)
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.

rtype

dict

returns

Response Syntax

{
    'Environments': [
        {
            'EnvironmentName': 'string',
            'EnvironmentId': 'string',
            'ApplicationName': 'string',
            'VersionLabel': 'string',
            'SolutionStackName': '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',
            'Resources': {
                'LoadBalancer': {
                    'LoadBalancerName': 'string',
                    'Domain': 'string',
                    'Listeners': [
                        {
                            'Protocol': 'string',
                            'Port': 123
                        },
                    ]
                }
            },
            'Tier': {
                'Name': 'string',
                'Type': 'string',
                'Version': '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.

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

          Lists in-progress environment updates and application version deployments that you can cancel.

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

          Yellow : Indicates that something is wrong, the application might not be available, but the instances appear running.

          Green : Indicates the environment is healthy and fully functional.

          • 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

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

RequestEnvironmentInfo (updated) Link ¶
Changes (request)
{'InfoType': {'bundle'}}

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

Request Syntax

client.request_environment_info(
    EnvironmentId='string',
    EnvironmentName='string',
    InfoType='tail'|'bundle'
)
type EnvironmentId

string

param EnvironmentId

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

type EnvironmentName

string

param EnvironmentName

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

type InfoType

string

param InfoType

[REQUIRED]

The type of information to request.

returns

None

RetrieveEnvironmentInfo (updated) Link ¶
Changes (request, response)
Request
{'InfoType': {'bundle'}}
Response
{'EnvironmentInfo': {'InfoType': {'bundle'}}}

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

  • RequestEnvironmentInfo

Request Syntax

client.retrieve_environment_info(
    EnvironmentId='string',
    EnvironmentName='string',
    InfoType='tail'|'bundle'
)
type EnvironmentId

string

param EnvironmentId

The ID of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

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

type EnvironmentName

string

param EnvironmentName

The name of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

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

type InfoType

string

param InfoType

[REQUIRED]

The type of information to retrieve.

rtype

dict

returns

Response Syntax

{
    'EnvironmentInfo': [
        {
            'InfoType': 'tail'|'bundle',
            'Ec2InstanceId': 'string',
            'SampleTimestamp': datetime(2015, 1, 1),
            'Message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Result message containing a description of the requested environment info.

    • EnvironmentInfo (list) --

      The EnvironmentInfoDescription of the environment.

      • (dict) --

        The information retrieved from the Amazon EC2 instances.

        • InfoType (string) --

          The type of information retrieved.

        • Ec2InstanceId (string) --

          The Amazon EC2 Instance ID for this information.

        • SampleTimestamp (datetime) --

          The time stamp when this information was retrieved.

        • Message (string) --

          The retrieved information.

TerminateEnvironment (updated) Link ¶
Changes (response)
{'AbortableOperationInProgress': 'boolean'}

Terminates the specified environment.

Request Syntax

client.terminate_environment(
    EnvironmentId='string',
    EnvironmentName='string',
    TerminateResources=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 : (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

false : The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

  • 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

rtype

dict

returns

Response Syntax

{
    'EnvironmentName': 'string',
    'EnvironmentId': 'string',
    'ApplicationName': 'string',
    'VersionLabel': 'string',
    'SolutionStackName': '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',
    'Resources': {
        'LoadBalancer': {
            'LoadBalancerName': 'string',
            'Domain': 'string',
            'Listeners': [
                {
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        }
    },
    'Tier': {
        'Name': 'string',
        'Type': 'string',
        'Version': '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.

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

      Lists in-progress environment updates and application version deployments that you can cancel.

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

      Yellow : Indicates that something is wrong, the application might not be available, but the instances appear running.

      Green : Indicates the environment is healthy and fully functional.

      • 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

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

UpdateEnvironment (updated) Link ¶
Changes (request, response)
Request
{'SolutionStackName': 'string'}
Response
{'AbortableOperationInProgress': 'boolean'}

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.

Request Syntax

client.update_environment(
    EnvironmentId='string',
    EnvironmentName='string',
    Description='string',
    Tier={
        'Name': 'string',
        'Type': 'string',
        'Version': 'string'
    },
    VersionLabel='string',
    TemplateName='string',
    SolutionStackName='string',
    OptionSettings=[
        {
            'Namespace': 'string',
            'OptionName': 'string',
            'Value': 'string'
        },
    ],
    OptionsToRemove=[
        {
            'Namespace': 'string',
            'OptionName': 'string'
        },
    ]
)
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 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: You can only update the tier version for an environment. If you change the name of the 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 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 .

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

    • 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',
    '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',
    'Resources': {
        'LoadBalancer': {
            'LoadBalancerName': 'string',
            'Domain': 'string',
            'Listeners': [
                {
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        }
    },
    'Tier': {
        'Name': 'string',
        'Type': 'string',
        'Version': '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.

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

      Lists in-progress environment updates and application version deployments that you can cancel.

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

      Yellow : Indicates that something is wrong, the application might not be available, but the instances appear running.

      Green : Indicates the environment is healthy and fully functional.

      • 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

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