Applications applicationId Templates
URI
/applications/applicationId/templates
HTTP methods
POST
Operation ID: CreateCloudFormationTemplate
Creates an Amazon CloudFormation template.
| Name | Type | Required | Description |
|---|---|---|---|
applicationId | String | True | The Amazon Resource Name (ARN) of the application. |
| 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 Amazon Serverless Application Repository service encountered an internal error. |
OPTIONS
| Name | Type | Required | Description |
|---|---|---|---|
applicationId | String | True | The Amazon Resource Name (ARN) of the application. |
| Status code | Response model | Description |
|---|---|---|
200 | None | 200 response |
Schemas
Request bodies
{ "semanticVersion semanticVersion": "string" }
Response bodies
{ "templateId templateId": "string", "templateUrl templateUrl": "string", "applicationId applicationId": "string", "semanticVersion semanticVersion": "string", "status status": enum, "creationTime creationTime": "string", "expirationTime expirationTime": "string" }
{ "message message": "string", "errorCode errorCode": "string" }
{ "message message": "string", "errorCode errorCode": "string" }
{ "message message": "string", "errorCode errorCode": "string" }
{ "message message": "string", "errorCode errorCode": "string" }
{ "message message": "string", "errorCode errorCode": "string" }
Properties
BadRequestException
One of the parameters in the request is invalid.
| Property | Type | Required | Description |
|---|---|---|---|
errorCode | string | False | 400 |
message | string | False | One of the parameters in the request is invalid. |
message
One of the parameters in the request is invalid.
Type: string
Required: False
errorCode
400
Type: string
Required: False
CreateCloudFormationTemplateInput
Create a template request.
| Property | Type | Required | Description |
|---|---|---|---|
semanticVersion | string | False | The semantic version of the application: |
semanticVersion
The semantic version of the application:
Type: string
Required: False
ForbiddenException
The client is not authenticated.
| Property | Type | Required | Description |
|---|---|---|---|
errorCode | string | False | 403 |
message | string | False | The client is not authenticated. |
message
The client is not authenticated.
Type: string
Required: False
errorCode
403
Type: string
Required: False
InternalServerErrorException
The Amazon Serverless Application Repository service encountered an internal error.
| Property | Type | Required | Description |
|---|---|---|---|
errorCode | string | False | 500 |
message | string | False | The Amazon Serverless Application Repository service encountered an internal error. |
message
The Amazon Serverless Application Repository service encountered an internal error.
Type: string
Required: False
errorCode
500
Type: string
Required: False
NotFoundException
The resource (for example, an access policy statement) specified in the request doesn't exist.
| Property | Type | Required | Description |
|---|---|---|---|
errorCode | string | False | 404 |
message | string | False | The resource (for example, an access policy statement) specified in the request doesn't exist. |
message
The resource (for example, an access policy statement) specified in the request doesn't exist.
Type: string
Required: False
errorCode
404
Type: string
Required: False
TemplateDetails
Details of the template.
| Property | Type | Required | Description |
|---|---|---|---|
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: |
status | string Values: | True | Status of the template creation workflow. Possible values: |
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 Amazon CloudFormation. |
templateId
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}
Type: string
Required: True
templateUrl
A link to the template that can be used to deploy the application using Amazon CloudFormation.
Type: string
Required: True
applicationId
The application Amazon Resource Name (ARN).
Type: string
Required: True
semanticVersion
The semantic version of the application:
Type: string
Required: True
status
Status of the template creation workflow.
Possible values: PREPARING | ACTIVE | EXPIRED
Type: string
Required: True
Values:
PREPARING | ACTIVE | EXPIRED
creationTime
The date and time this resource was created.
Type: string
Required: True
expirationTime
The date and time this template expires. Templates expire 1 hour after creation.
Type: string
Required: True
TooManyRequestsException
The client is sending more than the allowed number of requests per unit of time.
| Property | Type | Required | Description |
|---|---|---|---|
errorCode | string | False | 429 |
message | string | False | The client is sending more than the allowed number of requests per unit of time. |
message
The client is sending more than the allowed number of requests per unit of time.
Type: string
Required: False
errorCode
429
Type: string
Required: False