Menu
AWS Serverless Application Repository
Developer Guide

Applications applicationId Changesets

URI

/applications/ applicationId /changesets

HTTP Methods

POST

Operation ID: CreateCloudFormationChangeSet

Creates an AWS CloudFormation change set for the given application.

Path Parameters

Name Type Required Description
applicationId String True

The ID of the application to get.

Responses

Status Code Response Model Description
201 ChangeSetDetails

Success

400 BadRequestException

One of the parameters in the request is invalid.

500 InternalServerErrorException

The AWS Serverless Application Repository service encountered an internal error.

403 ForbiddenException

The client is not authenticated.

429 TooManyRequestsException

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

Schemas

Request Bodies

Example POST

{ "stackName": "string", "semanticVersion": "string", "parameterOverrides": [ { "name": "string", "value": "string" } ] }

Response Bodies

Example ChangeSetDetails

{ "applicationId": "string", "semanticVersion": "string", "changeSetId": "string", "stackId": "string" }

Example BadRequestException

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

Example ForbiddenException

{ "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

ChangeSetDetails

Details of the change set.

Property Type Required Description
applicationId

string

True

The application Amazon Resource Name (ARN).

semanticVersion

string

True

The semantic version of the application:

https://semver.org/

changeSetId

string

True

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

Length constraints: Minimum length of 1.

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

stackId

string

True

The unique ID of the stack.

CreateCloudFormationChangeSetInput

Create an application change set request.

Property Type Required Description
stackName

string

True

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:/._+]*)

semanticVersion

string

False

The semantic version of the application:

https://semver.org/

parameterOverrides

Array of type ParameterValue

False

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

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

ParameterValue

Parameter value of the application.

Property Type Required Description
name

string

True

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

True

The input value associated with the parameter.

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