AWS API Changes

2016/10/13 - AWS Elastic Beanstalk - 3 updated api methods

Changes Adds CodeCommit integraion. DescribeApplicationVersions updated to support pagination.

CreateApplicationVersion (updated)

Link ¶
Changes (request, response)
Request

{'SourceBuildInformation': {'SourceLocation': 'string',
                            'SourceRepository': 'CodeCommit',
                            'SourceType': 'Git'}}

Response

{'ApplicationVersion': {'SourceBuildInformation': {'SourceLocation': 'string',
                                                   'SourceRepository': 'CodeCommit',
                                                   'SourceType': 'Git'}}}

Creates an application version for the specified application.

Note

Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

Request Syntax

client.create_application_version(
    ApplicationName='string',
    VersionLabel='string',
    Description='string',
    SourceBuildInformation={
        'SourceType': 'Git',
        'SourceRepository': 'CodeCommit',
        'SourceLocation': 'string'
    },
    SourceBundle={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    AutoCreateApplication=True|False,
    Process=True|False
)

type ApplicationName

string

param ApplicationName

[REQUIRED]

The name of the application. If no application is found with this name, and AutoCreateApplication is false , returns an InvalidParameterValue error.

type VersionLabel

string

param VersionLabel

[REQUIRED]

A label identifying this version.

Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.

type Description

string

param Description

Describes this version.

type SourceBuildInformation

dict

param SourceBuildInformation

SourceType (string) -- [REQUIRED]
SourceRepository (string) -- [REQUIRED]
SourceLocation (string) -- [REQUIRED]

type SourceBundle

dict

param SourceBundle

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an InvalidParameterValue error. The maximum size allowed is 512 MB.

Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an InvalidParameterCombination error.

S3Bucket (string) --

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

The Amazon S3 key where the data is located.

type AutoCreateApplication

boolean

param AutoCreateApplication

Determines how the system behaves if the specified application for this version does not already exist:

true : Automatically creates the specified application for this release if it does not already exist.
false : Throws an InvalidParameterValue if the specified application for this release does not already exist.

Default: false

Valid Values: true | false

type Process

boolean

param Process

Preprocesses and validates the environment manifest and configuration files in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.

rtype

dict

returns

Response Syntax

{
    'ApplicationVersion': {
        'ApplicationName': 'string',
        'Description': 'string',
        'VersionLabel': 'string',
        'SourceBuildInformation': {
            'SourceType': 'Git',
            'SourceRepository': 'CodeCommit',
            'SourceLocation': 'string'
        },
        'SourceBundle': {
            'S3Bucket': 'string',
            'S3Key': 'string'
        },
        'DateCreated': datetime(2015, 1, 1),
        'DateUpdated': datetime(2015, 1, 1),
        'Status': 'Processed'|'Unprocessed'|'Failed'|'Processing'
    }
}

Response Structure

(dict) --

Result message wrapping a single description of an application version.
- ApplicationVersion (dict) --
  
  The ApplicationVersionDescription of the application version.
  - ApplicationName (string) --
    
    The name of the application associated with this release.
  - Description (string) --
    
    The description of this application version.
  - VersionLabel (string) --
    
    A label uniquely identifying the version for the associated application.
  - SourceBuildInformation (dict) --
    - SourceType (string) --
    - SourceRepository (string) --
    - SourceLocation (string) --
  - SourceBundle (dict) --
    
    The location where the source bundle is located for this version.
    - S3Bucket (string) --
      
      The Amazon S3 bucket where the data is located.
    - S3Key (string) --
      
      The Amazon S3 key where the data is located.
  - DateCreated (datetime) --
    
    The creation date of the application version.
  - DateUpdated (datetime) --
    
    The last modified date of the application version.
  - Status (string) --
    
    The processing status of the application version.

DescribeApplicationVersions (updated)

Link ¶
Changes (request, response)
Request

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

Response

{'ApplicationVersions': {'SourceBuildInformation': {'SourceLocation': 'string',
                                                    'SourceRepository': 'CodeCommit',
                                                    'SourceType': 'Git'}},
 'NextToken': 'string'}

Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.

Request Syntax

client.describe_application_versions(
    ApplicationName='string',
    VersionLabels=[
        'string',
    ],
    MaxRecords=123,
    NextToken='string'
)

type ApplicationName

string

param ApplicationName

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

type VersionLabels

list

param VersionLabels

If specified, restricts the returned descriptions to only include ones that have the specified version labels.

(string) --

type MaxRecords

integer

param MaxRecords

Specify a maximum number of application versions to paginate in the request.

type NextToken

string

param NextToken

Specify a next token to retrieve the next page in a paginated request.

rtype

dict

returns

Response Syntax

{
    'ApplicationVersions': [
        {
            'ApplicationName': 'string',
            'Description': 'string',
            'VersionLabel': 'string',
            'SourceBuildInformation': {
                'SourceType': 'Git',
                'SourceRepository': 'CodeCommit',
                'SourceLocation': 'string'
            },
            'SourceBundle': {
                'S3Bucket': 'string',
                'S3Key': 'string'
            },
            'DateCreated': datetime(2015, 1, 1),
            'DateUpdated': datetime(2015, 1, 1),
            'Status': 'Processed'|'Unprocessed'|'Failed'|'Processing'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Result message wrapping a list of application version descriptions.
- ApplicationVersions (list) --
  
  List of ApplicationVersionDescription objects sorted by order of creation.
  - (dict) --
    
    Describes the properties of an application version.
    - ApplicationName (string) --
      
      The name of the application associated with this release.
    - Description (string) --
      
      The description of this application version.
    - VersionLabel (string) --
      
      A label uniquely identifying the version for the associated application.
    - SourceBuildInformation (dict) --
      - SourceType (string) --
      - SourceRepository (string) --
      - SourceLocation (string) --
    - SourceBundle (dict) --
      
      The location where the source bundle is located for this version.
      - S3Bucket (string) --
        
        The Amazon S3 bucket where the data is located.
      - S3Key (string) --
        
        The Amazon S3 key where the data is located.
    - DateCreated (datetime) --
      
      The creation date of the application version.
    - DateUpdated (datetime) --
      
      The last modified date of the application version.
    - Status (string) --
      
      The processing status of the application version.
- NextToken (string) --
  
  For a paginated request, the token that you can pass in a subsequent request to get the next page.

UpdateApplicationVersion (updated)

Link ¶
Changes (response)

{'ApplicationVersion': {'SourceBuildInformation': {'SourceLocation': 'string',
                                                   'SourceRepository': 'CodeCommit',
                                                   'SourceType': 'Git'}}}

Updates the specified application version to have the specified properties.

Note

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

Request Syntax

client.update_application_version(
    ApplicationName='string',
    VersionLabel='string',
    Description='string'
)

type ApplicationName

string

param ApplicationName

[REQUIRED]

The name of the application associated with this version.

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

type VersionLabel

string

param VersionLabel

[REQUIRED]

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

type Description

string

param Description

A new description for this release.

rtype

dict

returns

Response Syntax

{
    'ApplicationVersion': {
        'ApplicationName': 'string',
        'Description': 'string',
        'VersionLabel': 'string',
        'SourceBuildInformation': {
            'SourceType': 'Git',
            'SourceRepository': 'CodeCommit',
            'SourceLocation': 'string'
        },
        'SourceBundle': {
            'S3Bucket': 'string',
            'S3Key': 'string'
        },
        'DateCreated': datetime(2015, 1, 1),
        'DateUpdated': datetime(2015, 1, 1),
        'Status': 'Processed'|'Unprocessed'|'Failed'|'Processing'
    }
}

Response Structure

(dict) --

Result message wrapping a single description of an application version.
- ApplicationVersion (dict) --
  
  The ApplicationVersionDescription of the application version.
  - ApplicationName (string) --
    
    The name of the application associated with this release.
  - Description (string) --
    
    The description of this application version.
  - VersionLabel (string) --
    
    A label uniquely identifying the version for the associated application.
  - SourceBuildInformation (dict) --
    - SourceType (string) --
    - SourceRepository (string) --
    - SourceLocation (string) --
  - SourceBundle (dict) --
    
    The location where the source bundle is located for this version.
    - S3Bucket (string) --
      
      The Amazon S3 bucket where the data is located.
    - S3Key (string) --
      
      The Amazon S3 key where the data is located.
  - DateCreated (datetime) --
    
    The creation date of the application version.
  - DateUpdated (datetime) --
    
    The last modified date of the application version.
  - Status (string) --
    
    The processing status of the application version.