ServerlessApplicationRepository

Client

class ServerlessApplicationRepository.Client

A low-level client representing AWSServerlessApplicationRepository:

import boto3

client = boto3.client('serverlessrepo')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_application(**kwargs)

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

response = 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'
)
Parameters
  • Author (string) --

    [REQUIRED]

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

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

  • Description (string) --

    [REQUIRED]

    The description of the application.

    Minimum length=1. Maximum 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.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

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

    • (string) --
  • LicenseBody (string) --

    A local text file that contains the license of the app that matches the spdxLicenseID value of your application. The file is of the format file://path>/filename>.

    Maximum size 5 MB

    Note: Only one of licenseBody and licenseUrl can be specified, otherwise an error will result.

  • LicenseUrl (string) --

    A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    Note: Only one of licenseBody and licenseUrl can be specified, otherwise an error will result.

  • Name (string) --

    [REQUIRED]

    The name of the application that you want to publish.

    Minimum length=1. Maximum length=140

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

  • ReadmeBody (string) --

    A local text readme file in Markdown language that contains a more detailed description of the application and how it works. The file is of the format file://path>/filename>.

    Maximum size 5 MB

    Note: Only one of readmeBody and readmeUrl can be specified, otherwise an error will result.

  • ReadmeUrl (string) --

    A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    Note: Only one of readmeBody and readmeUrl can be specified, otherwise an error will result.

  • SemanticVersion (string) --

    The semantic version of the application:

  • SourceCodeUrl (string) -- A link to a public repository for the source code of your application.
  • SpdxLicenseId (string) -- A valid identifier from https://spdx.org/licenses/ .
  • TemplateBody (string) --

    The local raw packaged AWS SAM template file of your application. The file is of the format file://path>/filename>.

    Note: Only one of templateBody and templateUrl can be specified, otherwise an error will result.

  • TemplateUrl (string) --

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

    Note: Only one of templateBody and templateUrl can be specified, otherwise an error will result.

Return type

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.

      Minimum length=1. Maximum length=127.

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

    • CreationTime (string) --

      The date and time this resource was created.

    • Description (string) --

      The description of the application.

      Minimum length=1. Maximum 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.

      Minimum length=1. Maximum 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 value of your application.

      Maximum size 5 MB

    • Name (string) --

      The name of the application.

      Minimum length=1. Maximum length=140

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

    • ReadmeUrl (string) --

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

      Maximum 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 and time this resource was created.

      • ParameterDefinitions (list) --

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

            An 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 that you want to allow for String types.

          • MaxValue (integer) --

            A numeric value that determines the largest numeric value that you want to allow for Number types.

          • MinLength (integer) --

            An integer value that determines the smallest number of characters that you want to allow for String types.

          • MinValue (integer) --

            A numeric value that determines the smallest numeric value that 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 | ListNumber> | CommaDelimitedList

            String: A literal string.

            For example, users can 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 might specify "8888".

            ListNumber>: 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 might specify "80,20", and then 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 might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

      • SemanticVersion (string) --

        The semantic version of the application:

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

create_application_version(**kwargs)

Creates an application version.

See also: AWS API Documentation

Request Syntax

response = client.create_application_version(
    ApplicationId='string',
    SemanticVersion='string',
    SourceCodeUrl='string',
    TemplateBody='string',
    TemplateUrl='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the application.

  • SemanticVersion (string) --

    [REQUIRED]

    The semantic version of the new version.

  • SourceCodeUrl (string) -- A link to a public repository for the source code of your application.
  • TemplateBody (string) -- The raw packaged AWS SAM template of your application.
  • TemplateUrl (string) -- A link to the packaged AWS SAM template of your application.
Return type

dict

Returns

Response Syntax

{
    '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).

    • CreationTime (string) --

      The date and time this resource was created.

    • ParameterDefinitions (list) --

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

          An 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 that you want to allow for String types.

        • MaxValue (integer) --

          A numeric value that determines the largest numeric value that you want to allow for Number types.

        • MinLength (integer) --

          An integer value that determines the smallest number of characters that you want to allow for String types.

        • MinValue (integer) --

          A numeric value that determines the smallest numeric value that 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 | ListNumber> | CommaDelimitedList

          String: A literal string.

          For example, users can 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 might specify "8888".

          ListNumber>: 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 might specify "80,20", and then 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 might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

    • SemanticVersion (string) --

      The semantic version of the application:

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

create_cloud_formation_change_set(**kwargs)

Creates an AWS CloudFormation change set for the given application.

See also: AWS API Documentation

Request Syntax

response = client.create_cloud_formation_change_set(
    ApplicationId='string',
    ParameterOverrides=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    SemanticVersion='string',
    StackName='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the application.

  • ParameterOverrides (list) --

    A list of parameter values for the parameters of the application.

    • (dict) --

      Parameter value of the application.

      • Name (string) -- [REQUIRED]

        The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

      • Value (string) -- [REQUIRED]

        The input value associated with the parameter.

  • SemanticVersion (string) --

    The semantic version of the application:

  • StackName (string) --

    [REQUIRED]

    The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

    Constraints: Minimum length of 1.

    Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:b(aws|aws-us-gov|aws-cn)b:[-a-zA-Z0-9:/._+]*)

Return type

dict

Returns

Response Syntax

{
    'ApplicationId': 'string',
    'ChangeSetId': 'string',
    'SemanticVersion': 'string',
    'StackId': 'string'
}

Response Structure

  • (dict) --

    Success

    • ApplicationId (string) --

      The application Amazon Resource Name (ARN).

    • ChangeSetId (string) --

      The Amazon Resource Name (ARN) of the change set.

      Length constraints: Minimum length of 1.

      Pattern: ARN:[-a-zA-Z0-9:/]*

    • SemanticVersion (string) --

      The semantic version of the application:

    • StackId (string) --

      The unique ID of the stack.

delete_application(**kwargs)

Deletes the specified application.

See also: AWS API Documentation

Request Syntax

response = client.delete_application(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the application.

Returns
None
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_application(**kwargs)

Gets the specified application.

See also: AWS API Documentation

Request Syntax

response = client.get_application(
    ApplicationId='string',
    SemanticVersion='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the application.

  • SemanticVersion (string) -- The semantic version of the application to get.
Return type

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.

      Minimum length=1. Maximum length=127.

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

    • CreationTime (string) --

      The date and time this resource was created.

    • Description (string) --

      The description of the application.

      Minimum length=1. Maximum 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.

      Minimum length=1. Maximum 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 value of your application.

      Maximum size 5 MB

    • Name (string) --

      The name of the application.

      Minimum length=1. Maximum length=140

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

    • ReadmeUrl (string) --

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

      Maximum 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 and time this resource was created.

      • ParameterDefinitions (list) --

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

            An 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 that you want to allow for String types.

          • MaxValue (integer) --

            A numeric value that determines the largest numeric value that you want to allow for Number types.

          • MinLength (integer) --

            An integer value that determines the smallest number of characters that you want to allow for String types.

          • MinValue (integer) --

            A numeric value that determines the smallest numeric value that 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 | ListNumber> | CommaDelimitedList

            String: A literal string.

            For example, users can 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 might specify "8888".

            ListNumber>: 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 might specify "80,20", and then 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 might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

      • SemanticVersion (string) --

        The semantic version of the application:

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

get_application_policy(**kwargs)

Retrieves the policy for the application.

See also: AWS API Documentation

Request Syntax

response = client.get_application_policy(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the application.

Return type
dict
Returns
Response Syntax
{
    'Statements': [
        {
            'Actions': [
                'string',
            ],
            'Principals': [
                'string',
            ],
            'StatementId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Success

    • Statements (list) --

      An array of policy statements applied to the application.

      • (dict) --

        Policy statement applied to the application.

        • Actions (list) --

          See Application Permissions for the list of supported actions.

          • (string) --
        • Principals (list) --

          An AWS account ID, or * to make the application public.

          • (string) --
        • StatementId (string) --

          A unique ID for the statement.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_application_versions(**kwargs)

Lists versions for the specified application.

See also: AWS API Documentation

Request Syntax

response = client.list_application_versions(
    ApplicationId='string',
    MaxItems=123,
    NextToken='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the application.

  • MaxItems (integer) -- The total number of items to return.
  • NextToken (string) -- A token to specify where to start paginating.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Versions': [
        {
            'ApplicationId': 'string',
            'CreationTime': 'string',
            'SemanticVersion': 'string',
            'SourceCodeUrl': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Success

    • NextToken (string) --

      The token to request the next page of results.

    • Versions (list) --

      An array of version summaries for the application.

      • (dict) --

        An application version summary.

        • ApplicationId (string) --

          The application Amazon Resource Name (ARN).

        • CreationTime (string) --

          The date and time this resource was created.

        • SemanticVersion (string) --

          The semantic version of the application:

        • SourceCodeUrl (string) --

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

list_applications(**kwargs)

Lists applications owned by the requester.

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    MaxItems=123,
    NextToken='string'
)
Parameters
  • MaxItems (integer) -- The total number of items to return.
  • NextToken (string) -- A token to specify where to start paginating.
Return type

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

      An array of application summaries.

      • (dict) --

        Summary of details about the application.

        • ApplicationId (string) --

          The application Amazon Resource Name (ARN).

        • Author (string) --

          The name of the author publishing the app.

          Minimum length=1. Maximum length=127.

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

        • CreationTime (string) --

          The date and time this resource was created.

        • Description (string) --

          The description of the application.

          Minimum length=1. Maximum 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.

          Minimum length=1. Maximum length=127. Maximum number of labels: 10

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

          • (string) --
        • Name (string) --

          The name of the application.

          Minimum length=1. Maximum 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.

put_application_policy(**kwargs)

Sets the permission policy for an application. See Application Permissions for the list of supported actions that can be used with this operation.

See also: AWS API Documentation

Request Syntax

response = client.put_application_policy(
    ApplicationId='string',
    Statements=[
        {
            'Actions': [
                'string',
            ],
            'Principals': [
                'string',
            ],
            'StatementId': 'string'
        },
    ]
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the application.

  • Statements (list) --

    [REQUIRED]

    An array of policy statements applied to the application.

    • (dict) --

      Policy statement applied to the application.

      • Actions (list) -- [REQUIRED]

        See Application Permissions for the list of supported actions.

        • (string) --
      • Principals (list) -- [REQUIRED]

        An AWS account ID, or * to make the application public.

        • (string) --
      • StatementId (string) --

        A unique ID for the statement.

Return type

dict

Returns

Response Syntax

{
    'Statements': [
        {
            'Actions': [
                'string',
            ],
            'Principals': [
                'string',
            ],
            'StatementId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Success

    • Statements (list) --

      An array of policy statements applied to the application.

      • (dict) --

        Policy statement applied to the application.

        • Actions (list) --

          See Application Permissions for the list of supported actions.

          • (string) --
        • Principals (list) --

          An AWS account ID, or * to make the application public.

          • (string) --
        • StatementId (string) --

          A unique ID for the statement.

update_application(**kwargs)

Updates the specified application.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The Amazon Resource Name (ARN) of the application.

  • Author (string) --

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

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

  • Description (string) --

    The description of the application.

    Minimum length=1. Maximum 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.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

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

    • (string) --
  • ReadmeBody (string) --

    A text readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

  • ReadmeUrl (string) --

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

    Maximum size 5 MB

Return type

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.

      Minimum length=1. Maximum length=127.

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

    • CreationTime (string) --

      The date and time this resource was created.

    • Description (string) --

      The description of the application.

      Minimum length=1. Maximum 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.

      Minimum length=1. Maximum 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 value of your application.

      Maximum size 5 MB

    • Name (string) --

      The name of the application.

      Minimum length=1. Maximum length=140

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

    • ReadmeUrl (string) --

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

      Maximum 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 and time this resource was created.

      • ParameterDefinitions (list) --

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

            An 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 that you want to allow for String types.

          • MaxValue (integer) --

            A numeric value that determines the largest numeric value that you want to allow for Number types.

          • MinLength (integer) --

            An integer value that determines the smallest number of characters that you want to allow for String types.

          • MinValue (integer) --

            A numeric value that determines the smallest numeric value that 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 | ListNumber> | CommaDelimitedList

            String: A literal string.

            For example, users can 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 might specify "8888".

            ListNumber>: 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 might specify "80,20", and then 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 might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

      • SemanticVersion (string) --

        The semantic version of the application:

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

Paginators

The available paginators are: