GetLaunchConfiguration
Lists all LaunchConfigurations available, filtered by Source Server IDs.
Request Syntax
POST /GetLaunchConfiguration HTTP/1.1
Content-type: application/json
{
"accountID": "string",
"sourceServerID": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- accountID
-
Request to get Launch Configuration information by Account ID.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]{12,}Required: No
- sourceServerID
-
Request to get Launch Configuration information by Source Server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
^s-[0-9a-zA-Z]{17}$Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"bootMode": "string",
"copyPrivateIp": boolean,
"copyTags": boolean,
"ec2LaunchTemplateID": "string",
"enableMapAutoTagging": boolean,
"launchDisposition": "string",
"licensing": {
"osByol": boolean
},
"mapAutoTaggingMpeID": "string",
"name": "string",
"postLaunchActions": {
"cloudWatchLogGroupName": "string",
"deployment": "string",
"s3LogBucket": "string",
"s3OutputKeyPrefix": "string",
"ssmDocuments": [
{
"actionName": "string",
"externalParameters": {
"string" : { ... }
},
"mustSucceedForCutover": boolean,
"parameters": {
"string" : [
{
"parameterName": "string",
"parameterType": "string"
}
]
},
"ssmDocumentName": "string",
"timeoutSeconds": number
}
]
},
"sourceServerID": "string",
"targetInstanceTypeRightSizingMethod": "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.
- bootMode
-
Launch configuration boot mode.
Type: String
Valid Values:
LEGACY_BIOS | UEFI | USE_SOURCE - copyPrivateIp
-
Copy Private IP during Launch Configuration.
Type: Boolean
- copyTags
-
Copy Tags during Launch Configuration.
Type: Boolean
- ec2LaunchTemplateID
-
Launch configuration EC2 Launch template ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
- enableMapAutoTagging
-
Enable map auto tagging.
Type: Boolean
- launchDisposition
-
Launch disposition for launch configuration.
Type: String
Valid Values:
STOPPED | STARTED - licensing
-
Launch configuration OS licensing.
Type: Licensing object
- mapAutoTaggingMpeID
-
Map auto tagging MPE ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
- name
-
Launch configuration name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
- postLaunchActions
-
Post Launch Actions to executed on the Test or Cutover instance.
Type: PostLaunchActions object
- sourceServerID
-
Launch configuration Source Server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
^s-[0-9a-zA-Z]{17}$ - targetInstanceTypeRightSizingMethod
-
Launch configuration Target instance type right sizing method.
Type: String
Valid Values:
NONE | BASIC
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
Resource not found exception.
HTTP Status Code: 404
- UninitializedAccountException
-
Uninitialized 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:
