GetReplicationConfiguration
Lists all ReplicationConfigurations, filtered by Source Server ID.
Request Syntax
POST /GetReplicationConfiguration HTTP/1.1 Content-type: application/json
{
"sourceServerID": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
sourceServerID (p. 50)
Request to get Replication Configuaration by Source Server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
"associateDefaultSecurityGroup": boolean, "bandwidthThrottling": number,
"createPublicIP": boolean, "dataPlaneRouting": "string",
"defaultLargeStagingDiskType": "string", "ebsEncryption": "string",
"ebsEncryptionKeyArn": "string", "name": "string",
"replicatedDisks": [ {
"replicationServerInstanceType": "string",
Response Elements "replicationServersSecurityGroupsIDs": [ "string" ], "sourceServerID": "string",
"stagingAreaSubnetId": "string", "stagingAreaTags": {
"string" : "string"
},
"useDedicatedReplicationServer": boolean }
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.
associateDefaultSecurityGroup (p. 50)
Replication Configuration associate default Application Migration Service Security Group.
Type: Boolean
bandwidthThrottling (p. 50)
Replication Configuration set bandwidth throttling.
Type: Long
Valid Range: Minimum value of 0.
createPublicIP (p. 50)
Replication Configuration create Public IP.
Type: Boolean dataPlaneRouting (p. 50)
Replication Configuration data plane routing.
Type: String
Valid Values: PRIVATE_IP | PUBLIC_IP defaultLargeStagingDiskType (p. 50)
Replication Configuration use default large Staging Disks.
Type: String
Valid Values: GP2 | ST1 ebsEncryption (p. 50)
Replication Configuration EBS encryption.
Type: String
Valid Values: DEFAULT | CUSTOM ebsEncryptionKeyArn (p. 50)
Replication Configuration EBS encryption key ARN.
Type: String
Response Elements
Length Constraints: Minimum length of 20. Maximum length of 2048.
name (p. 50)
Replication Configuration name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
replicatedDisks (p. 50)
Replication Configuration replicated disks.
Type: Array of ReplicationConfigurationReplicatedDisk (p. 145) objects Array Members: Minimum number of 0 items. Maximum number of 60 items.
replicationServerInstanceType (p. 50)
Replication Configuration Replication Server instance type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
replicationServersSecurityGroupsIDs (p. 50)
Replication Configuration Replication Server Security Group IDs.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 32 items.
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^sg-[0-9a-fA-F]{8,}$
sourceServerID (p. 50)
Replication Configuration Source Server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
stagingAreaSubnetId (p. 50)
Replication Configuration Staging Area subnet ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^subnet-[0-9a-fA-F]{8,}$
stagingAreaTags (p. 50)
Replication Configuration Staging Area tags.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Errors useDedicatedReplicationServer (p. 50)
Replication Configuration use Dedicated Replication Server.
Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ResourceNotFoundException Resource not found exception.
HTTP Status Code: 404 UninitializedAccountException
Unitialized account exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
InitializeService
InitializeService
Initialize Application Migration Service.
Request Syntax
POST /InitializeService HTTP/1.1
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
AccessDeniedException
Operating denied due to a file permission or access check error.
HTTP Status Code: 403 ValidationException
Validate exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListTagsForResource
ListTagsForResource
List all tags for your Application Migration Service resources.
Request Syntax
GET /tags/resourceArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
resourceArn (p. 56)
List tags for resource request by ARN.
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "tags": {
"string" : "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.
tags (p. 56)
List tags for resource response.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
See Also AccessDeniedException
Operating denied due to a file permission or access check error.
HTTP Status Code: 403 InternalServerException
The server encountered an unexpected condition that prevented it from fulfilling the request.
HTTP Status Code: 500 ResourceNotFoundException
Resource not found exception.
HTTP Status Code: 404 ThrottlingException
Reached throttling quota exception.
HTTP Status Code: 429 ValidationException
Validate exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
MarkAsArchived
MarkAsArchived
Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle.state which equals DISCONNECTED or CUTOVER.
Request Syntax
POST /MarkAsArchived HTTP/1.1 Content-type: application/json {
"sourceServerID": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
sourceServerID (p. 58)
Mark as archived by Source Server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
"arn": "string",
"dataReplicationInfo": { "dataReplicationError": { "error": "string", "rawError": "string"
},
"dataReplicationInitiation": { "nextAttemptDateTime": "string", "startDateTime": "string",
Response Syntax },
"dataReplicationState": "string", "etaDateTime": "string",
"lagDuration": "string",
"lastSnapshotDateTime": "string", "replicatedDisks": [
"isArchived": boolean, "launchedInstance": { "ec2InstanceID": "string", "firstBoot": "string", "jobID": "string"
},
"lifeCycle": {
"addedToServiceDateTime": "string", "elapsedReplicationDuration": "string", "firstByteDateTime": "string",
"lastCutover": {
"lastSeenByServiceDateTime": "string", "lastTest": {
"replicationType": "string", "sourceProperties": { "cpus": [
Response Elements
"lastUpdatedDateTime": "string", "networkInterfaces": [
"recommendedInstanceType": "string"
},
"sourceServerID": "string", "tags": {
"string" : "string"
},
"vcenterClientID": "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.
arn (p. 58)
Source server ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
dataReplicationInfo (p. 58)
Source server data replication info.
Type: DataReplicationInfo (p. 113) object isArchived (p. 58)
Source server archived status.
Type: Boolean launchedInstance (p. 58)
Source server launched instance.
Type: LaunchedInstance (p. 130) object lifeCycle (p. 58)
Source server lifecycle state.
Type: LifeCycle (p. 132) object
Errors replicationType (p. 58)
Source server replication type.
Type: String
Valid Values: AGENT_BASED | SNAPSHOT_SHIPPING sourceProperties (p. 58)
Source server properties.
Type: SourceProperties (p. 149) object sourceServerID (p. 58)
Source server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
tags (p. 58)
Source server Tags.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
vcenterClientID (p. 58)
Source server vCenter client id.
Type: String
Length Constraints: Fixed length of 21.
Pattern: ^vcc-[0-9a-zA-Z]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 409 ResourceNotFoundException
Resource not found exception.
HTTP Status Code: 404 UninitializedAccountException
Unitialized account exception.
HTTP Status Code: 400
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
RetryDataReplication
RetryDataReplication
Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.
Request Syntax
POST /RetryDataReplication HTTP/1.1 Content-type: application/json {
"sourceServerID": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
sourceServerID (p. 63)
Retry data replication for Source Server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
"arn": "string",
"dataReplicationInfo": { "dataReplicationError": { "error": "string", "rawError": "string"
},
"dataReplicationInitiation": { "nextAttemptDateTime": "string", "startDateTime": "string",
Response Syntax },
"dataReplicationState": "string", "etaDateTime": "string",
"lagDuration": "string",
"lastSnapshotDateTime": "string", "replicatedDisks": [
"isArchived": boolean, "launchedInstance": { "ec2InstanceID": "string", "firstBoot": "string", "jobID": "string"
},
"lifeCycle": {
"addedToServiceDateTime": "string", "elapsedReplicationDuration": "string", "firstByteDateTime": "string",
"lastCutover": {
"lastSeenByServiceDateTime": "string", "lastTest": {
"replicationType": "string", "sourceProperties": { "cpus": [
Response Elements
"lastUpdatedDateTime": "string", "networkInterfaces": [
"recommendedInstanceType": "string"
},
"sourceServerID": "string", "tags": {
"string" : "string"
},
"vcenterClientID": "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.
arn (p. 63)
Source server ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
dataReplicationInfo (p. 63)
Source server data replication info.
Type: DataReplicationInfo (p. 113) object isArchived (p. 63)
Source server archived status.
Type: Boolean launchedInstance (p. 63)
Source server launched instance.
Type: LaunchedInstance (p. 130) object lifeCycle (p. 63)
Source server lifecycle state.
Type: LifeCycle (p. 132) object
Errors replicationType (p. 63)
Source server replication type.
Type: String
Valid Values: AGENT_BASED | SNAPSHOT_SHIPPING sourceProperties (p. 63)
Source server properties.
Type: SourceProperties (p. 149) object sourceServerID (p. 63)
Source server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
tags (p. 63)
Source server Tags.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
vcenterClientID (p. 63)
Source server vCenter client id.
Type: String
Length Constraints: Fixed length of 21.
Pattern: ^vcc-[0-9a-zA-Z]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ResourceNotFoundException Resource not found exception.
HTTP Status Code: 404 UninitializedAccountException
Unitialized account exception.
HTTP Status Code: 400 ValidationException
Validate exception.
HTTP Status Code: 400
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartCutover
StartCutover
Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.
Request Syntax
POST /StartCutover HTTP/1.1 Content-type: application/json { "sourceServerIDs": [ "string" ], "tags": {
"string" : "string"
} }
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
sourceServerIDs (p. 68)
Start Cutover by Source Server IDs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
Required: Yes tags (p. 68)
Start Cutover by Tags.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
Response Elements
{ "job": {
"arn": "string",
"creationDateTime": "string", "endDateTime": "string", "initiatedBy": "string", "jobID": "string",
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
job (p. 68)
Start Cutover Job response.
Type: Job (p. 125) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 409 UninitializedAccountException
Unitialized account exception.
HTTP Status Code: 400 ValidationException
Validate exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartReplication
StartReplication
Starts replication for SNAPSHOT_SHIPPING agents.
Request Syntax
POST /StartReplication HTTP/1.1 Content-type: application/json {
"sourceServerID": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
sourceServerID (p. 71)
ID of source server on which to start replication.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
"dataReplicationInfo": { "dataReplicationError": { "error": "string", "rawError": "string"
},
"dataReplicationInitiation": { "nextAttemptDateTime": "string", "startDateTime": "string",
Response Syntax "dataReplicationState": "string",
"etaDateTime": "string", "lagDuration": "string",
"lastSnapshotDateTime": "string", "replicatedDisks": [
"isArchived": boolean, "launchedInstance": { "ec2InstanceID": "string", "firstBoot": "string", "jobID": "string"
},
"lifeCycle": {
"addedToServiceDateTime": "string", "elapsedReplicationDuration": "string", "firstByteDateTime": "string",
"lastCutover": {
"lastSeenByServiceDateTime": "string", "lastTest": {
"replicationType": "string", "sourceProperties": { "cpus": [
Response Elements
"lastUpdatedDateTime": "string", "networkInterfaces": [
"recommendedInstanceType": "string"
},
"sourceServerID": "string", "tags": {
"string" : "string"
},
"vcenterClientID": "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.
arn (p. 71)
Source server ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
dataReplicationInfo (p. 71)
Source server data replication info.
Type: DataReplicationInfo (p. 113) object isArchived (p. 71)
Source server archived status.
Type: Boolean launchedInstance (p. 71)
Source server launched instance.
Type: LaunchedInstance (p. 130) object lifeCycle (p. 71)
Source server lifecycle state.
Type: LifeCycle (p. 132) object
Errors replicationType (p. 71)
Source server replication type.
Type: String
Valid Values: AGENT_BASED | SNAPSHOT_SHIPPING sourceProperties (p. 71)
Source server properties.
Type: SourceProperties (p. 149) object sourceServerID (p. 71)
Source server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
tags (p. 71)
Source server Tags.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
vcenterClientID (p. 71)
Source server vCenter client id.
Type: String
Length Constraints: Fixed length of 21.
Pattern: ^vcc-[0-9a-zA-Z]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 409 ResourceNotFoundException
Resource not found exception.
HTTP Status Code: 404 ServiceQuotaExceededException
The request could not be completed because its exceeded the service quota.
HTTP Status Code: 402
See Also UninitializedAccountException
Unitialized account exception.
HTTP Status Code: 400 ValidationException
Validate exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartTest
StartTest
Lauches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.
Request Syntax
POST /StartTest HTTP/1.1 Content-type: application/json {
"sourceServerIDs": [ "string" ], "tags": {
"string" : "string"
}}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
sourceServerIDs (p. 76)
Start Test for Source Server IDs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
Required: Yes tags (p. 76)
Start Test by Tags.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
Response Elements
{ "job": {
"arn": "string",
"creationDateTime": "string", "endDateTime": "string", "initiatedBy": "string", "jobID": "string",
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
job (p. 76)
Start Test Job response.
Type: Job (p. 125) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 409 UninitializedAccountException
Unitialized account exception.
HTTP Status Code: 400 ValidationException
Validate exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
TagResource
TagResource
Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.
Request Syntax
POST /tags/resourceArn HTTP/1.1 Content-type: application/json {
"tags": {
"string" : "string"
} }
URI Request Parameters
The request uses the following URI parameters.
resourceArn (p. 79) Tag resource by ARN.
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
Request Body
The request accepts the following data in JSON format.
tags (p. 79)
Tag resource by Tags.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
AccessDeniedException
Operating denied due to a file permission or access check error.
HTTP Status Code: 403 InternalServerException
The server encountered an unexpected condition that prevented it from fulfilling the request.
HTTP Status Code: 500 ResourceNotFoundException
Resource not found exception.
HTTP Status Code: 404 ThrottlingException
Reached throttling quota exception.
HTTP Status Code: 429 ValidationException
Validate exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
TerminateTargetInstances
TerminateTargetInstances
Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.
Request Syntax
POST /TerminateTargetInstances HTTP/1.1 Content-type: application/json
{
"sourceServerIDs": [ "string" ], "tags": {
"string" : "string"
}}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
sourceServerIDs (p. 81)
Terminate Target instance by Source Server IDs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
Required: Yes tags (p. 81)
Terminate Target instance by Tags.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
Response Elements
{ "job": {
"arn": "string",
"creationDateTime": "string", "endDateTime": "string", "initiatedBy": "string", "jobID": "string",
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
job (p. 81)
Terminate Target instance Job response.
Type: Job (p. 125) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 409 UninitializedAccountException
Unitialized account exception.
HTTP Status Code: 400 ValidationException
Validate exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: