Applications applicationId Templates - AWS Serverless Application Repository

Applications applicationId Templates

URI

/applications/applicationId/templates

HTTP methods

POST

Operation ID: CreateCloudFormationTemplate

Creates an AWS CloudFormation template.

Path parameters
NameTypeRequiredDescription
applicationIdStringTrue

The Amazon Resource Name (ARN) of the application.

Responses
Status codeResponse modelDescription
201TemplateDetails

Success

400BadRequestException

One of the parameters in the request is invalid.

403ForbiddenException

The client is not authenticated.

404NotFoundException

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

429TooManyRequestsException

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

500InternalServerErrorException

The AWS Serverless Application Repository service encountered an internal error.

Schemas

Request bodies

{ "semanticVersion": "string" }

Response bodies

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

Properties

BadRequestException

One of the parameters in the request is invalid.

PropertyTypeRequiredDescription
errorCode

string

False

400

message

string

False

One of the parameters in the request is invalid.

CreateCloudFormationTemplateInput

Create a template request.

PropertyTypeRequiredDescription
semanticVersion

string

False

The semantic version of the application:

https://semver.org/

ForbiddenException

The client is not authenticated.

PropertyTypeRequiredDescription
errorCode

string

False

403

message

string

False

The client is not authenticated.

InternalServerErrorException

The AWS Serverless Application Repository service encountered an internal error.

PropertyTypeRequiredDescription
errorCode

string

False

500

message

string

False

The AWS Serverless Application Repository service encountered an internal error.

NotFoundException

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

PropertyTypeRequiredDescription
errorCode

string

False

404

message

string

False

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

TemplateDetails

Details of the template.

PropertyTypeRequiredDescription
applicationId

string

True

The application Amazon Resource Name (ARN).

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.

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

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.

TooManyRequestsException

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

PropertyTypeRequiredDescription
errorCode

string

False

429

message

string

False

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

See also

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

CreateCloudFormationTemplate