AWS Server Migration Service
API Reference (API Version 2016-10-24)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Request Syntax

{ "appId": "string", "changesetFormat": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


ID of the application associated with the change set.

Type: String

Required: No


Format for the change set.

Type: String

Valid Values: JSON | YAML

Required: No

Response Syntax

{ "s3Location": { "bucket": "string", "key": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Location of the Amazon S3 object.

Type: S3Location object


For information about the errors that are common to all actions, see Common Errors.


An internal error occurred.

HTTP Status Code: 500


A specified parameter is not valid.

HTTP Status Code: 400


A required parameter is missing.

HTTP Status Code: 400


This operation is not allowed.

HTTP Status Code: 400


You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

HTTP Status Code: 400

See Also

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