AWS Serverless Application Repository
Developer Guide

Applications applicationId Templates

URI

/applications/applicationId/templates

HTTP Methods

POST

Operation ID: CreateCloudFormationTemplate

Creates an AWS CloudFormation template.

Path Parameters

Name Type Required Description
applicationId String True

The Amazon Resource Name (ARN) of the application.

Responses

Status Code Response Model Description
201 TemplateDetails

Success

400 BadRequestException

One of the parameters in the request is invalid.

403 ForbiddenException

The client is not authenticated.

404 NotFoundException

The resource (for example, an access policy statement) specified in the request doesn't exist.

429 TooManyRequestsException

The client is sending more than the allowed number of requests per unit of time.

500 InternalServerErrorException

The AWS Serverless Application Repository service encountered an internal error.

Schemas

Request Bodies

Example POST

{ "semanticVersion": "string" }

Response Bodies

Example TemplateDetails

{ "templateId": "string", "templateUrl": "string", "applicationId": "string", "semanticVersion": "string", "status": enum, "creationTime": "string", "expirationTime": "string" }

Example BadRequestException

{ "message": "string", "errorCode": "string" }

Example ForbiddenException

{ "message": "string", "errorCode": "string" }

Example NotFoundException

{ "message": "string", "errorCode": "string" }

Example TooManyRequestsException

{ "message": "string", "errorCode": "string" }

Example InternalServerErrorException

{ "message": "string", "errorCode": "string" }

Properties

BadRequestException

One of the parameters in the request is invalid.

Property Type Required Description
message

string

False

One of the parameters in the request is invalid.

errorCode

string

False

400

CreateCloudFormationTemplateInput

Create a template request.

Property Type Required Description
semanticVersion

string

False

The semantic version of the application:

https://semver.org/

ForbiddenException

The client is not authenticated.

Property Type Required Description
message

string

False

The client is not authenticated.

errorCode

string

False

403

InternalServerErrorException

The AWS Serverless Application Repository service encountered an internal error.

Property Type Required Description
message

string

False

The AWS Serverless Application Repository service encountered an internal error.

errorCode

string

False

500

NotFoundException

The resource (for example, an access policy statement) specified in the request doesn't exist.

Property Type Required Description
message

string

False

The resource (for example, an access policy statement) specified in the request doesn't exist.

errorCode

string

False

404

TemplateDetails

Details of the template.

Property Type Required Description
templateId

string

True

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

True

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

applicationId

string

True

The application Amazon Resource Name (ARN).

semanticVersion

string

True

The semantic version of the application:

https://semver.org/

status

string

Values: PREPARING | ACTIVE | EXPIRED

True

Status of the template creation workflow.

Possible values: PREPARING | ACTIVE | EXPIRED

creationTime

string

True

The date and time this resource was created.

expirationTime

string

True

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

TooManyRequestsException

The client is sending more than the allowed number of requests per unit of time.

Property Type Required Description
message

string

False

The client is sending more than the allowed number of requests per unit of time.

errorCode

string

False

429

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

CreateCloudFormationTemplate