ServerlessApplicationRepository / Client / get_cloud_formation_template

get_cloud_formation_template#

ServerlessApplicationRepository.Client.get_cloud_formation_template(**kwargs)#

Gets the specified AWS CloudFormation template.

See also: AWS API Documentation

Request Syntax

response = client.get_cloud_formation_template(
    ApplicationId='string',
    TemplateId='string'
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the application.

  • TemplateId (string) –

    [REQUIRED]

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationId': 'string',
    'CreationTime': 'string',
    'ExpirationTime': 'string',
    'SemanticVersion': 'string',
    'Status': 'PREPARING'|'ACTIVE'|'EXPIRED',
    'TemplateId': '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.

    • ExpirationTime (string) –

      The date and time this template expires. Templates expire 1 hour after creation.

    • SemanticVersion (string) –

      The semantic version of the application:

      https://semver.org/

    • Status (string) –

      Status of the template creation workflow.

      Possible values: PREPARING | ACTIVE | EXPIRED

    • TemplateId (string) –

      The UUID returned by CreateCloudFormationTemplate.

      Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

    • TemplateUrl (string) –

      A link to the template that can be used to deploy the application using AWS CloudFormation.

Exceptions