AWS API Changes

2018/02/21 - AWSServerlessApplicationRepository - 1 new 4 updated api methods

Changes Added support for delete-application API and the ability for developers to set a homepage for their application. The homepage is a URL with more information about the application, for example the location of your GitHub repository for the application.

DeleteApplication (new)

Link ¶

Deletes the specified application.

See also: AWS API Documentation

Request Syntax

client.delete_application(
    ApplicationId='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The ID of the application to get.

returns

None

CreateApplication (updated)

Link ¶
Changes (both)

{'HomePageUrl': 'string'}

Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

See also: AWS API Documentation

Request Syntax

client.create_application(
    Author='string',
    Description='string',
    HomePageUrl='string',
    Labels=[
        'string',
    ],
    LicenseBody='string',
    LicenseUrl='string',
    Name='string',
    ReadmeBody='string',
    ReadmeUrl='string',
    SemanticVersion='string',
    SourceCodeUrl='string',
    SpdxLicenseId='string',
    TemplateBody='string',
    TemplateUrl='string'
)

type Author

string

param Author

The name of the author publishing the app.

Min Length=1. Max Length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

type Description

string

param Description

The description of the application.

Min Length=1. Max Length=256

type HomePageUrl

string

param HomePageUrl

A URL with more information about the application, for example the location of your GitHub repository for the application.

type Labels

list

param Labels

Labels to improve discovery of apps in search results.

Min Length=1. Max Length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";

(string) --

type LicenseBody

string

param LicenseBody

A raw text file that contains the license of the app that matches the spdxLicenseID of your application.

Max size 5 MB

type LicenseUrl

string

param LicenseUrl

A link to a license file of the app that matches the spdxLicenseID of your application.

Max size 5 MB

type Name

string

param Name

The name of the application you want to publish.

Min Length=1. Max Length=140

Pattern: "[a-zA-Z0-9\-]+";

type ReadmeBody

string

param ReadmeBody

A raw text Readme file that contains a more detailed description of the application and how it works in markdown language.

Max size 5 MB

type ReadmeUrl

string

param ReadmeUrl

A link to the Readme file that contains a more detailed description of the application and how it works in markdown language.

Max size 5 MB

type SemanticVersion

string

param SemanticVersion

The semantic version of the application:

`https://semver.org/

type SourceCodeUrl

string

param SourceCodeUrl

A link to a public repository for the source code of your application.

type SpdxLicenseId

string

param SpdxLicenseId

A valid identifier from `https://spdx.org/licenses/ .

type TemplateBody

string

param TemplateBody

The raw packaged AWS SAM template of your application.

type TemplateUrl

string

param TemplateUrl

A link to the packaged AWS SAM template of your application.

rtype

dict

returns

Response Syntax

{
    'ApplicationId': 'string',
    'Author': 'string',
    'CreationTime': 'string',
    'Description': 'string',
    'HomePageUrl': 'string',
    'Labels': [
        'string',
    ],
    'LicenseUrl': 'string',
    'Name': 'string',
    'ReadmeUrl': 'string',
    'SpdxLicenseId': 'string',
    'Version': {
        'ApplicationId': 'string',
        'CreationTime': 'string',
        'ParameterDefinitions': [
            {
                'AllowedPattern': 'string',
                'AllowedValues': [
                    'string',
                ],
                'ConstraintDescription': 'string',
                'DefaultValue': 'string',
                'Description': 'string',
                'MaxLength': 123,
                'MaxValue': 123,
                'MinLength': 123,
                'MinValue': 123,
                'Name': 'string',
                'NoEcho': True|False,
                'ReferencedByResources': [
                    'string',
                ],
                'Type': 'string'
            },
        ],
        'SemanticVersion': 'string',
        'SourceCodeUrl': 'string',
        'TemplateUrl': 'string'
    }
}

Response Structure

(dict) --

Success
- ApplicationId (string) --
  
  The application Amazon Resource Name (ARN).
- Author (string) --
  
  The name of the author publishing the app.
  
  Min Length=1. Max Length=127.
  
  Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
- CreationTime (string) --
  
  The date/time this resource was created.
- Description (string) --
  
  The description of the application.
  
  Min Length=1. Max Length=256
- HomePageUrl (string) --
  
  A URL with more information about the application, for example the location of your GitHub repository for the application.
- Labels (list) --
  
  Labels to improve discovery of apps in search results.
  
  Min Length=1. Max Length=127. Maximum number of labels: 10
  
  Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";
  - (string) --
- LicenseUrl (string) --
  
  A link to a license file of the app that matches the spdxLicenseID of your application.
  
  Max size 5 MB
- Name (string) --
  
  The name of the application.
  
  Min Length=1. Max Length=140
  
  Pattern: "[a-zA-Z0-9\-]+";
- ReadmeUrl (string) --
  
  A link to the readme file that contains a more detailed description of the application and how it works in Markdown language.
  
  Max size 5 MB
- SpdxLicenseId (string) --
  
  A valid identifier from https://spdx.org/licenses/.
- Version (dict) --
  
  Version information about the application.
  - ApplicationId (string) --
    
    The application Amazon Resource Name (ARN).
  - CreationTime (string) --
    
    The date/time this resource was created.
  - ParameterDefinitions (list) --
    
    Array of parameter types supported by the application.
    - (dict) --
      
      Parameters supported by the application.
      - AllowedPattern (string) --
        
        A regular expression that represents the patterns to allow for String types.
      - AllowedValues (list) --
        
        Array containing the list of values allowed for the parameter.
        
        (string) --
      - ConstraintDescription (string) --
        
        A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:
        
        Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
        
        By adding a constraint description, such as "must contain only uppercase and lowercase letters, and numbers," you can display the following customized error message:
        
        Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.
      - DefaultValue (string) --
        
        A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.
      - Description (string) --
        
        A string of up to 4,000 characters that describes the parameter.
      - MaxLength (integer) --
        
        An integer value that determines the largest number of characters you want to allow for String types.
      - MaxValue (integer) --
        
        A numeric value that determines the largest numeric value you want to allow for Number types.
      - MinLength (integer) --
        
        An integer value that determines the smallest number of characters you want to allow for String types.
      - MinValue (integer) --
        
        A numeric value that determines the smallest numeric value you want to allow for Number types.
      - Name (string) --
        
        The name of the parameter.
      - NoEcho (boolean) --
        
        Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*).
      - ReferencedByResources (list) --
        
        A list of AWS SAM resources that use this parameter.
        
        (string) --
      - Type (string) --
        
        The type of the parameter.
        
        Valid values: String | Number | List<Number> | CommaDelimitedList
        
        String: A literal string.
        
        For example, users could specify "MyUserName".
        
        Number: An integer or float. AWS CloudFormation validates the parameter value as a number; however, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.
        
        For example, users could specify "8888".
        
        List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers; however, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.
        
        For example, users could specify "80,20", and a Ref results in ["80","20"].
        
        CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.
        
        For example, users could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
  - SemanticVersion (string) --
    
    The semantic version of the application:
    
    `https://semver.org/
  - SourceCodeUrl (string) --
    
    A link to a public repository for the source code of your application.
  - TemplateUrl (string) --
    
    A link to the packaged AWS SAM template of your application.

GetApplication (updated)

Link ¶
Changes (response)

{'HomePageUrl': 'string'}

Gets the specified application.

See also: AWS API Documentation

Request Syntax

client.get_application(
    ApplicationId='string',
    SemanticVersion='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The ID of the application to get.

type SemanticVersion

string

param SemanticVersion

The semantic version of the application to get.

rtype

dict

returns

Response Syntax

{
    'ApplicationId': 'string',
    'Author': 'string',
    'CreationTime': 'string',
    'Description': 'string',
    'HomePageUrl': 'string',
    'Labels': [
        'string',
    ],
    'LicenseUrl': 'string',
    'Name': 'string',
    'ReadmeUrl': 'string',
    'SpdxLicenseId': 'string',
    'Version': {
        'ApplicationId': 'string',
        'CreationTime': 'string',
        'ParameterDefinitions': [
            {
                'AllowedPattern': 'string',
                'AllowedValues': [
                    'string',
                ],
                'ConstraintDescription': 'string',
                'DefaultValue': 'string',
                'Description': 'string',
                'MaxLength': 123,
                'MaxValue': 123,
                'MinLength': 123,
                'MinValue': 123,
                'Name': 'string',
                'NoEcho': True|False,
                'ReferencedByResources': [
                    'string',
                ],
                'Type': 'string'
            },
        ],
        'SemanticVersion': 'string',
        'SourceCodeUrl': 'string',
        'TemplateUrl': 'string'
    }
}

Response Structure

(dict) --

Success
- ApplicationId (string) --
  
  The application Amazon Resource Name (ARN).
- Author (string) --
  
  The name of the author publishing the app.
  
  Min Length=1. Max Length=127.
  
  Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
- CreationTime (string) --
  
  The date/time this resource was created.
- Description (string) --
  
  The description of the application.
  
  Min Length=1. Max Length=256
- HomePageUrl (string) --
  
  A URL with more information about the application, for example the location of your GitHub repository for the application.
- Labels (list) --
  
  Labels to improve discovery of apps in search results.
  
  Min Length=1. Max Length=127. Maximum number of labels: 10
  
  Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";
  - (string) --
- LicenseUrl (string) --
  
  A link to a license file of the app that matches the spdxLicenseID of your application.
  
  Max size 5 MB
- Name (string) --
  
  The name of the application.
  
  Min Length=1. Max Length=140
  
  Pattern: "[a-zA-Z0-9\-]+";
- ReadmeUrl (string) --
  
  A link to the readme file that contains a more detailed description of the application and how it works in Markdown language.
  
  Max size 5 MB
- SpdxLicenseId (string) --
  
  A valid identifier from https://spdx.org/licenses/.
- Version (dict) --
  
  Version information about the application.
  - ApplicationId (string) --
    
    The application Amazon Resource Name (ARN).
  - CreationTime (string) --
    
    The date/time this resource was created.
  - ParameterDefinitions (list) --
    
    Array of parameter types supported by the application.
    - (dict) --
      
      Parameters supported by the application.
      - AllowedPattern (string) --
        
        A regular expression that represents the patterns to allow for String types.
      - AllowedValues (list) --
        
        Array containing the list of values allowed for the parameter.
        
        (string) --
      - ConstraintDescription (string) --
        
        A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:
        
        Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
        
        By adding a constraint description, such as "must contain only uppercase and lowercase letters, and numbers," you can display the following customized error message:
        
        Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.
      - DefaultValue (string) --
        
        A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.
      - Description (string) --
        
        A string of up to 4,000 characters that describes the parameter.
      - MaxLength (integer) --
        
        An integer value that determines the largest number of characters you want to allow for String types.
      - MaxValue (integer) --
        
        A numeric value that determines the largest numeric value you want to allow for Number types.
      - MinLength (integer) --
        
        An integer value that determines the smallest number of characters you want to allow for String types.
      - MinValue (integer) --
        
        A numeric value that determines the smallest numeric value you want to allow for Number types.
      - Name (string) --
        
        The name of the parameter.
      - NoEcho (boolean) --
        
        Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*).
      - ReferencedByResources (list) --
        
        A list of AWS SAM resources that use this parameter.
        
        (string) --
      - Type (string) --
        
        The type of the parameter.
        
        Valid values: String | Number | List<Number> | CommaDelimitedList
        
        String: A literal string.
        
        For example, users could specify "MyUserName".
        
        Number: An integer or float. AWS CloudFormation validates the parameter value as a number; however, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.
        
        For example, users could specify "8888".
        
        List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers; however, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.
        
        For example, users could specify "80,20", and a Ref results in ["80","20"].
        
        CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.
        
        For example, users could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
  - SemanticVersion (string) --
    
    The semantic version of the application:
    
    `https://semver.org/
  - SourceCodeUrl (string) --
    
    A link to a public repository for the source code of your application.
  - TemplateUrl (string) --
    
    A link to the packaged AWS SAM template of your application.

ListApplications (updated)

Link ¶
Changes (response)

{'Applications': {'HomePageUrl': 'string'}}

Lists applications owned by the requester.

See also: AWS API Documentation

Request Syntax

client.list_applications(
    MaxItems=123,
    NextToken='string'
)

type MaxItems

integer

param MaxItems

The total number of items to return.

type NextToken

string

param NextToken

A token to specify where to start paginating.

rtype

dict

returns

Response Syntax

{
    'Applications': [
        {
            'ApplicationId': 'string',
            'Author': 'string',
            'CreationTime': 'string',
            'Description': 'string',
            'HomePageUrl': 'string',
            'Labels': [
                'string',
            ],
            'Name': 'string',
            'SpdxLicenseId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Success
- Applications (list) --
  
  Array of application summaries.
  - (dict) --
    
    Summary of details about the application.
    - ApplicationId (string) --
      
      The application ARN.
    - Author (string) --
      
      The name of the author publishing the app.
      
      Min Length=1. Max Length=127.
      
      Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
    - CreationTime (string) --
      
      The date/time this resource was created.
    - Description (string) --
      
      The description of the application.
      
      Min Length=1. Max Length=256
    - HomePageUrl (string) --
      
      A URL with more information about the application, for example the location of your GitHub repository for the application.
    - Labels (list) --
      
      Labels to improve discovery of apps in search results.
      
      Min Length=1. Max Length=127. Maximum number of labels: 10
      
      Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";
      - (string) --
    - Name (string) --
      
      The name of the application.
      
      Min Length=1. Max Length=140
      
      Pattern: "[a-zA-Z0-9\-]+";
    - SpdxLicenseId (string) --
      
      A valid identifier from `https://spdx.org/licenses/ .
- NextToken (string) --
  
  The token to request the next page of results.

UpdateApplication (updated)

Link ¶
Changes (both)

{'HomePageUrl': 'string'}

Updates the specified application.

See also: AWS API Documentation

Request Syntax

client.update_application(
    ApplicationId='string',
    Author='string',
    Description='string',
    HomePageUrl='string',
    Labels=[
        'string',
    ],
    ReadmeBody='string',
    ReadmeUrl='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The ID of the application to get.

type Author

string

param Author

The name of the author publishing the app.

Min Length=1. Max Length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

type Description

string

param Description

The description of the application.

Min Length=1. Max Length=256

type HomePageUrl

string

param HomePageUrl

A URL with more information about the application, for example the location of your GitHub repository for the application.

type Labels

list

param Labels

Labels to improve discovery of apps in search results.

Min Length=1. Max Length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";

(string) --

type ReadmeBody

string

param ReadmeBody

A raw text Readme file that contains a more detailed description of the application and how it works in markdown language.

Max size 5 MB

type ReadmeUrl

string

param ReadmeUrl

A link to the Readme file that contains a more detailed description of the application and how it works in markdown language.

Max size 5 MB

rtype

dict

returns

Response Syntax

{
    'ApplicationId': 'string',
    'Author': 'string',
    'CreationTime': 'string',
    'Description': 'string',
    'HomePageUrl': 'string',
    'Labels': [
        'string',
    ],
    'LicenseUrl': 'string',
    'Name': 'string',
    'ReadmeUrl': 'string',
    'SpdxLicenseId': 'string',
    'Version': {
        'ApplicationId': 'string',
        'CreationTime': 'string',
        'ParameterDefinitions': [
            {
                'AllowedPattern': 'string',
                'AllowedValues': [
                    'string',
                ],
                'ConstraintDescription': 'string',
                'DefaultValue': 'string',
                'Description': 'string',
                'MaxLength': 123,
                'MaxValue': 123,
                'MinLength': 123,
                'MinValue': 123,
                'Name': 'string',
                'NoEcho': True|False,
                'ReferencedByResources': [
                    'string',
                ],
                'Type': 'string'
            },
        ],
        'SemanticVersion': 'string',
        'SourceCodeUrl': 'string',
        'TemplateUrl': 'string'
    }
}

Response Structure

(dict) --

Success
- ApplicationId (string) --
  
  The application Amazon Resource Name (ARN).
- Author (string) --
  
  The name of the author publishing the app.
  
  Min Length=1. Max Length=127.
  
  Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
- CreationTime (string) --
  
  The date/time this resource was created.
- Description (string) --
  
  The description of the application.
  
  Min Length=1. Max Length=256
- HomePageUrl (string) --
  
  A URL with more information about the application, for example the location of your GitHub repository for the application.
- Labels (list) --
  
  Labels to improve discovery of apps in search results.
  
  Min Length=1. Max Length=127. Maximum number of labels: 10
  
  Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";
  - (string) --
- LicenseUrl (string) --
  
  A link to a license file of the app that matches the spdxLicenseID of your application.
  
  Max size 5 MB
- Name (string) --
  
  The name of the application.
  
  Min Length=1. Max Length=140
  
  Pattern: "[a-zA-Z0-9\-]+";
- ReadmeUrl (string) --
  
  A link to the readme file that contains a more detailed description of the application and how it works in Markdown language.
  
  Max size 5 MB
- SpdxLicenseId (string) --
  
  A valid identifier from https://spdx.org/licenses/.
- Version (dict) --
  
  Version information about the application.
  - ApplicationId (string) --
    
    The application Amazon Resource Name (ARN).
  - CreationTime (string) --
    
    The date/time this resource was created.
  - ParameterDefinitions (list) --
    
    Array of parameter types supported by the application.
    - (dict) --
      
      Parameters supported by the application.
      - AllowedPattern (string) --
        
        A regular expression that represents the patterns to allow for String types.
      - AllowedValues (list) --
        
        Array containing the list of values allowed for the parameter.
        
        (string) --
      - ConstraintDescription (string) --
        
        A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:
        
        Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
        
        By adding a constraint description, such as "must contain only uppercase and lowercase letters, and numbers," you can display the following customized error message:
        
        Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.
      - DefaultValue (string) --
        
        A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.
      - Description (string) --
        
        A string of up to 4,000 characters that describes the parameter.
      - MaxLength (integer) --
        
        An integer value that determines the largest number of characters you want to allow for String types.
      - MaxValue (integer) --
        
        A numeric value that determines the largest numeric value you want to allow for Number types.
      - MinLength (integer) --
        
        An integer value that determines the smallest number of characters you want to allow for String types.
      - MinValue (integer) --
        
        A numeric value that determines the smallest numeric value you want to allow for Number types.
      - Name (string) --
        
        The name of the parameter.
      - NoEcho (boolean) --
        
        Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*).
      - ReferencedByResources (list) --
        
        A list of AWS SAM resources that use this parameter.
        
        (string) --
      - Type (string) --
        
        The type of the parameter.
        
        Valid values: String | Number | List<Number> | CommaDelimitedList
        
        String: A literal string.
        
        For example, users could specify "MyUserName".
        
        Number: An integer or float. AWS CloudFormation validates the parameter value as a number; however, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.
        
        For example, users could specify "8888".
        
        List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers; however, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.
        
        For example, users could specify "80,20", and a Ref results in ["80","20"].
        
        CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.
        
        For example, users could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
  - SemanticVersion (string) --
    
    The semantic version of the application:
    
    `https://semver.org/
  - SourceCodeUrl (string) --
    
    A link to a public repository for the source code of your application.
  - TemplateUrl (string) --
    
    A link to the packaged AWS SAM template of your application.