AWS API Changes

2020/04/06 - AWS Elastic Beanstalk - 1 new 4 updated api methods

Changes This release adds a new action, ListPlatformBranches, and updates two actions, ListPlatformVersions and DescribePlatformVersion, to support the concept of Elastic Beanstalk platform branches.

ListPlatformBranches (new)

Link ¶

Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.

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

See also: AWS API Documentation

Request Syntax

client.list_platform_branches(
    Filters=[
        {
            'Attribute': 'string',
            'Operator': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    NextToken='string'
)

type Filters

list

param Filters

Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.

The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.

Attribute = BranchName :
- Operator : = | != | begins_with | ends_with | contains | in | not_in
Attribute = LifecycleState :
- Operator : = | != | in | not_in
- Values : beta | supported | deprecated | retired
Attribute = PlatformName :
- Operator : = | != | begins_with | ends_with | contains | in | not_in
Attribute = TierType :
- Operator : = | !=
- Values : WebServer/Standard | Worker/SQS/HTTP

Array size: limited to 10 SearchFilter objects.

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

(dict) --

Describes criteria to restrict a list of results.

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

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

The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.
- Attribute (string) --
  
  The result attribute to which the filter values are applied. Valid values vary by API action.
- Operator (string) --
  
  The operator to apply to the Attribute with each of the Values . Valid values vary by Attribute .
- Values (list) --
  
  The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute .
  - (string) --

type MaxRecords

integer

param MaxRecords

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

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

{
    'PlatformBranchSummaryList': [
        {
            'PlatformName': 'string',
            'BranchName': 'string',
            'LifecycleState': 'string',
            'BranchOrder': 123,
            'SupportedTierList': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PlatformBranchSummaryList (list) --
  
  Summary information about the platform branches.
  - (dict) --
    
    Summary information about a platform branch.
    - PlatformName (string) --
      
      The name of the platform to which this platform branch belongs.
    - BranchName (string) --
      
      The name of the platform branch.
    - LifecycleState (string) --
      
      The support life cycle state of the platform branch.
      
      Possible values: beta | supported | deprecated | retired
    - BranchOrder (integer) --
      
      An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches.
      
      A larger BranchOrder value designates a newer platform branch within the platform.
    - SupportedTierList (list) --
      
      The environment tiers that platform versions in this branch support.
      
      Possible values: WebServer/Standard | Worker/SQS/HTTP
      - (string) --
- NextToken (string) --
  
  In a paginated request, if this value isn't null , it's the token that you can pass in a subsequent request to get the next response page.

CreatePlatformVersion (updated)

Link ¶
Changes (response)

{'PlatformSummary': {'PlatformBranchLifecycleState': 'string',
                     'PlatformBranchName': 'string',
                     'PlatformLifecycleState': 'string',
                     'PlatformVersion': 'string'}}

Create a new version of your custom platform.

See also: AWS API Documentation

Request Syntax

client.create_platform_version(
    PlatformName='string',
    PlatformVersion='string',
    PlatformDefinitionBundle={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    EnvironmentName='string',
    OptionSettings=[
        {
            'ResourceName': 'string',
            'Namespace': 'string',
            'OptionName': 'string',
            'Value': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type PlatformName

string

param PlatformName

[REQUIRED]

The name of your custom platform.

type PlatformVersion

string

param PlatformVersion

[REQUIRED]

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

type PlatformDefinitionBundle

dict

param PlatformDefinitionBundle

[REQUIRED]

The location of the platform definition archive in Amazon S3.

S3Bucket (string) --

The Amazon S3 bucket where the data is located.
S3Key (string) --

The Amazon S3 key where the data is located.

type EnvironmentName

string

param EnvironmentName

The name of the builder environment.

type OptionSettings

list

param OptionSettings

The configuration option settings to apply to the builder environment.

(dict) --

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

type Tags

list

param Tags

Specifies the tags applied to the new platform version.

Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.

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

rtype

dict

returns

Response Syntax

{
    'PlatformSummary': {
        'PlatformArn': 'string',
        'PlatformOwner': 'string',
        'PlatformStatus': 'Creating'|'Failed'|'Ready'|'Deleting'|'Deleted',
        'PlatformCategory': 'string',
        'OperatingSystemName': 'string',
        'OperatingSystemVersion': 'string',
        'SupportedTierList': [
            'string',
        ],
        'SupportedAddonList': [
            'string',
        ],
        'PlatformLifecycleState': 'string',
        'PlatformVersion': 'string',
        'PlatformBranchName': 'string',
        'PlatformBranchLifecycleState': 'string'
    },
    'Builder': {
        'ARN': 'string'
    }
}

Response Structure

(dict) --
- PlatformSummary (dict) --
  
  Detailed information about the new version of the custom platform.
  - PlatformArn (string) --
    
    The ARN of the platform version.
  - PlatformOwner (string) --
    
    The AWS account ID of the person who created the platform version.
  - PlatformStatus (string) --
    
    The status of the platform version. You can create an environment from the platform version once it is ready.
  - PlatformCategory (string) --
    
    The category of platform version.
  - OperatingSystemName (string) --
    
    The operating system used by the platform version.
  - OperatingSystemVersion (string) --
    
    The version of the operating system used by the platform version.
  - SupportedTierList (list) --
    
    The tiers in which the platform version runs.
    - (string) --
  - SupportedAddonList (list) --
    
    The additions associated with the platform version.
    - (string) --
  - PlatformLifecycleState (string) --
    
    The state of the platform version in its lifecycle.
    
    Possible values: recommended | empty
    
    If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
  - PlatformVersion (string) --
    
    The version string of the platform version.
  - PlatformBranchName (string) --
    
    The platform branch to which the platform version belongs.
  - PlatformBranchLifecycleState (string) --
    
    The state of the platform version's branch in its lifecycle.
    
    Possible values: beta | supported | deprecated | retired
- Builder (dict) --
  
  The builder used to create the custom platform.
  - ARN (string) --
    
    The ARN of the builder.

DeletePlatformVersion (updated)

Link ¶
Changes (response)

{'PlatformSummary': {'PlatformBranchLifecycleState': 'string',
                     'PlatformBranchName': 'string',
                     'PlatformLifecycleState': 'string',
                     'PlatformVersion': 'string'}}

Deletes the specified version of a custom platform.

See also: AWS API Documentation

Request Syntax

client.delete_platform_version(
    PlatformArn='string'
)

type PlatformArn

string

param PlatformArn

The ARN of the version of the custom platform.

rtype

dict

returns

Response Syntax

{
    'PlatformSummary': {
        'PlatformArn': 'string',
        'PlatformOwner': 'string',
        'PlatformStatus': 'Creating'|'Failed'|'Ready'|'Deleting'|'Deleted',
        'PlatformCategory': 'string',
        'OperatingSystemName': 'string',
        'OperatingSystemVersion': 'string',
        'SupportedTierList': [
            'string',
        ],
        'SupportedAddonList': [
            'string',
        ],
        'PlatformLifecycleState': 'string',
        'PlatformVersion': 'string',
        'PlatformBranchName': 'string',
        'PlatformBranchLifecycleState': 'string'
    }
}

Response Structure

(dict) --
- PlatformSummary (dict) --
  
  Detailed information about the version of the custom platform.
  - PlatformArn (string) --
    
    The ARN of the platform version.
  - PlatformOwner (string) --
    
    The AWS account ID of the person who created the platform version.
  - PlatformStatus (string) --
    
    The status of the platform version. You can create an environment from the platform version once it is ready.
  - PlatformCategory (string) --
    
    The category of platform version.
  - OperatingSystemName (string) --
    
    The operating system used by the platform version.
  - OperatingSystemVersion (string) --
    
    The version of the operating system used by the platform version.
  - SupportedTierList (list) --
    
    The tiers in which the platform version runs.
    - (string) --
  - SupportedAddonList (list) --
    
    The additions associated with the platform version.
    - (string) --
  - PlatformLifecycleState (string) --
    
    The state of the platform version in its lifecycle.
    
    Possible values: recommended | empty
    
    If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
  - PlatformVersion (string) --
    
    The version string of the platform version.
  - PlatformBranchName (string) --
    
    The platform branch to which the platform version belongs.
  - PlatformBranchLifecycleState (string) --
    
    The state of the platform version's branch in its lifecycle.
    
    Possible values: beta | supported | deprecated | retired

DescribePlatformVersion (updated)

Link ¶
Changes (response)

{'PlatformDescription': {'PlatformBranchLifecycleState': 'string',
                         'PlatformBranchName': 'string',
                         'PlatformLifecycleState': 'string'}}

Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.

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

See also: AWS API Documentation

Request Syntax

client.describe_platform_version(
    PlatformArn='string'
)

type PlatformArn

string

param PlatformArn

The ARN of the platform version.

rtype

dict

returns

Response Syntax

{
    'PlatformDescription': {
        'PlatformArn': 'string',
        'PlatformOwner': 'string',
        'PlatformName': 'string',
        'PlatformVersion': 'string',
        'SolutionStackName': 'string',
        'PlatformStatus': 'Creating'|'Failed'|'Ready'|'Deleting'|'Deleted',
        'DateCreated': datetime(2015, 1, 1),
        'DateUpdated': datetime(2015, 1, 1),
        'PlatformCategory': 'string',
        'Description': 'string',
        'Maintainer': 'string',
        'OperatingSystemName': 'string',
        'OperatingSystemVersion': 'string',
        'ProgrammingLanguages': [
            {
                'Name': 'string',
                'Version': 'string'
            },
        ],
        'Frameworks': [
            {
                'Name': 'string',
                'Version': 'string'
            },
        ],
        'CustomAmiList': [
            {
                'VirtualizationType': 'string',
                'ImageId': 'string'
            },
        ],
        'SupportedTierList': [
            'string',
        ],
        'SupportedAddonList': [
            'string',
        ],
        'PlatformLifecycleState': 'string',
        'PlatformBranchName': 'string',
        'PlatformBranchLifecycleState': 'string'
    }
}

Response Structure

(dict) --
- PlatformDescription (dict) --
  
  Detailed information about the platform version.
  - PlatformArn (string) --
    
    The ARN of the platform version.
  - PlatformOwner (string) --
    
    The AWS account ID of the person who created the platform version.
  - PlatformName (string) --
    
    The name of the platform version.
  - PlatformVersion (string) --
    
    The version of the platform version.
  - SolutionStackName (string) --
    
    The name of the solution stack used by the platform version.
  - PlatformStatus (string) --
    
    The status of the platform version.
  - DateCreated (datetime) --
    
    The date when the platform version was created.
  - DateUpdated (datetime) --
    
    The date when the platform version was last updated.
  - PlatformCategory (string) --
    
    The category of the platform version.
  - Description (string) --
    
    The description of the platform version.
  - Maintainer (string) --
    
    Information about the maintainer of the platform version.
  - OperatingSystemName (string) --
    
    The operating system used by the platform version.
  - OperatingSystemVersion (string) --
    
    The version of the operating system used by the platform version.
  - ProgrammingLanguages (list) --
    
    The programming languages supported by the platform version.
    - (dict) --
      
      A programming language supported by the platform.
      - Name (string) --
        
        The name of the programming language.
      - Version (string) --
        
        The version of the programming language.
  - Frameworks (list) --
    
    The frameworks supported by the platform version.
    - (dict) --
      
      A framework supported by the platform.
      - Name (string) --
        
        The name of the framework.
      - Version (string) --
        
        The version of the framework.
  - CustomAmiList (list) --
    
    The custom AMIs supported by the platform version.
    - (dict) --
      
      A custom AMI available to platforms.
      - VirtualizationType (string) --
        
        The type of virtualization used to create the custom AMI.
      - ImageId (string) --
        
        THe ID of the image used to create the custom AMI.
  - SupportedTierList (list) --
    
    The tiers supported by the platform version.
    - (string) --
  - SupportedAddonList (list) --
    
    The additions supported by the platform version.
    - (string) --
  - PlatformLifecycleState (string) --
    
    The state of the platform version in its lifecycle.
    
    Possible values: Recommended | null
    
    If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.
  - PlatformBranchName (string) --
    
    The platform branch to which the platform version belongs.
  - PlatformBranchLifecycleState (string) --
    
    The state of the platform version's branch in its lifecycle.
    
    Possible values: Beta | Supported | Deprecated | Retired

ListPlatformVersions (updated)

Link ¶
Changes (response)

{'PlatformSummaryList': {'PlatformBranchLifecycleState': 'string',
                         'PlatformBranchName': 'string',
                         'PlatformLifecycleState': 'string',
                         'PlatformVersion': 'string'}}

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

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

See also: AWS API Documentation

Request Syntax

client.list_platform_versions(
    Filters=[
        {
            'Type': 'string',
            'Operator': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    NextToken='string'
)

type Filters

list

param Filters

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

(dict) --

Describes criteria to restrict the results when listing platform versions.

The filter is evaluated as follows: Type Operator Values[1]
- Type (string) --
  
  The platform version attribute to which the filter values are applied.
  
  Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName
- Operator (string) --
  
  The operator to apply to the Type with each of the Values .
  
  Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with
- Values (list) --
  
  The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.
  
  The following list shows valid filter values for some filter attributes.
  - PlatformStatus : Creating | Failed | Ready | Deleting | Deleted
  - PlatformLifecycleState : recommended
  - SupportedTier : WebServer/Standard | Worker/SQS/HTTP
  - SupportedAddon : Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD
  - (string) --

type MaxRecords

integer

param MaxRecords

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

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

{
    'PlatformSummaryList': [
        {
            'PlatformArn': 'string',
            'PlatformOwner': 'string',
            'PlatformStatus': 'Creating'|'Failed'|'Ready'|'Deleting'|'Deleted',
            'PlatformCategory': 'string',
            'OperatingSystemName': 'string',
            'OperatingSystemVersion': 'string',
            'SupportedTierList': [
                'string',
            ],
            'SupportedAddonList': [
                'string',
            ],
            'PlatformLifecycleState': 'string',
            'PlatformVersion': 'string',
            'PlatformBranchName': 'string',
            'PlatformBranchLifecycleState': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PlatformSummaryList (list) --
  
  Summary information about the platform versions.
  - (dict) --
    
    Summary information about a platform version.
    - PlatformArn (string) --
      
      The ARN of the platform version.
    - PlatformOwner (string) --
      
      The AWS account ID of the person who created the platform version.
    - PlatformStatus (string) --
      
      The status of the platform version. You can create an environment from the platform version once it is ready.
    - PlatformCategory (string) --
      
      The category of platform version.
    - OperatingSystemName (string) --
      
      The operating system used by the platform version.
    - OperatingSystemVersion (string) --
      
      The version of the operating system used by the platform version.
    - SupportedTierList (list) --
      
      The tiers in which the platform version runs.
      - (string) --
    - SupportedAddonList (list) --
      
      The additions associated with the platform version.
      - (string) --
    - PlatformLifecycleState (string) --
      
      The state of the platform version in its lifecycle.
      
      Possible values: recommended | empty
      
      If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
    - PlatformVersion (string) --
      
      The version string of the platform version.
    - PlatformBranchName (string) --
      
      The platform branch to which the platform version belongs.
    - PlatformBranchLifecycleState (string) --
      
      The state of the platform version's branch in its lifecycle.
      
      Possible values: beta | supported | deprecated | retired
- NextToken (string) --
  
  In a paginated request, if this value isn't null , it's the token that you can pass in a subsequent request to get the next response page.