IdentificationHints
Identification hints.
Contents
awsInstanceID
AWS Instance ID identification hint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^i-[0-9a-fA-F]{8,}$
Required: No fqdn
FQDN address identification hint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No hostname
Hostname identification hint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No vmPath
vCenter VM path identification hint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No vmWareUuid
vmWare UUID identification hint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Job
Job
Job.
Contents
arn
the ARN of the specific Job.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No creationDateTime
Job creation time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No endDateTime
Job end time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No initiatedBy
Job initiated by field.
Type: String
Valid Values: START_TEST | START_CUTOVER | DIAGNOSTIC | TERMINATE Required: No
jobID Job ID.
Type: String
Length Constraints: Fixed length of 24.
Pattern: ^mgnjob-[0-9a-zA-Z]{17}$
Required: Yes
See Also participatingServers
Servers participating in a specific Job.
Type: Array of ParticipatingServer (p. 144) objects Required: No
status
Job status.
Type: String
Valid Values: PENDING | STARTED | COMPLETED Required: No
tags
Tags associated with spcific Job.
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 type
Job type.
Type: String
Valid Values: LAUNCH | TERMINATE Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
JobLog
JobLog
Job log.
Contents
event
Job log event.
Type: String
Valid Values: JOB_START | SERVER_SKIPPED | CLEANUP_START | CLEANUP_END
| CLEANUP_FAIL | SNAPSHOT_START | SNAPSHOT_END | SNAPSHOT_FAIL
| USING_PREVIOUS_SNAPSHOT | CONVERSION_START | CONVERSION_END | CONVERSION_FAIL | LAUNCH_START | LAUNCH_FAILED | JOB_CANCEL | JOB_END Required: No
eventData
Job event data
Type: JobLogEventData (p. 128) object Required: No
logDateTime
Job log event date and time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
JobLogEventData
JobLogEventData
Job log data
Contents
conversionServerID
Job Event conversion Server ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^i-[0-9a-fA-F]{8,}$
Required: No rawError
Job error.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 65536.
Required: No sourceServerID
Job Event Source Server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
Required: No targetInstanceID
Job Event Target instance ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^i-[0-9a-fA-F]{8,}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for Ruby V3
LaunchedInstance
LaunchedInstance
Configure launced instance.
Contents
ec2InstanceID
Configure launced instance EC2 ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^i-[0-9a-fA-F]{8,}$
Required: No firstBoot
Configure launced instance first boot.
Type: String
Valid Values: WAITING | SUCCEEDED | UNKNOWN | STOPPED Required: No
jobID
Configure launced instance Job ID.
Type: String
Length Constraints: Fixed length of 24.
Pattern: ^mgnjob-[0-9a-zA-Z]{17}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Licensing
Licensing
Configure Licensing.
Contents
osByol
Configure BYOL OS licensing.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycle
LifeCycle
Lifecycle.
Contents
addedToServiceDateTime
Lifecycle added to service data and time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No
elapsedReplicationDuration
Lifecycle elapsed time and duration.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No firstByteDateTime
Lifecycle replication initiation date and time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No lastCutover
Lifecycle last Cutover.
Type: LifeCycleLastCutover (p. 134) object Required: No
lastSeenByServiceDateTime
Lifecycle last seen date and time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
See Also Required: No
lastTest
Lifecycle last Test.
Type: LifeCycleLastTest (p. 138) object Required: No
state
Lifecycle state.
Type: String
Valid Values: STOPPED | NOT_READY | READY_FOR_TEST | TESTING |
READY_FOR_CUTOVER | CUTTING_OVER | CUTOVER | DISCONNECTED | DISCOVERED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycleLastCutover
LifeCycleLastCutover
Lifecycle last Cutover .
Contents
finalized
Lifecycle Cutover finalized date and time.
Type: LifeCycleLastCutoverFinalized (p. 135) object Required: No
initiated
Lifecycle last Cutover initiated.
Type: LifeCycleLastCutoverInitiated (p. 136) object Required: No
reverted
Lifecycle last Cutover reverted.
Type: LifeCycleLastCutoverReverted (p. 137) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycleLastCutoverFinalized
LifeCycleLastCutoverFinalized
Lifecycle Cutover finalized
Contents
apiCallDateTime
Lifecycle Cutover finalized date and time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycleLastCutoverInitiated
LifeCycleLastCutoverInitiated
Lifecycle last Cutover initiated.
Contents
apiCallDateTime
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No jobID
Lifecycle last Cutover initiated by Job ID.
Type: String
Length Constraints: Fixed length of 24.
Pattern: ^mgnjob-[0-9a-zA-Z]{17}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycleLastCutoverReverted
LifeCycleLastCutoverReverted
Lifecycle last Cutover reverted.
Contents
apiCallDateTime
Lifecycle last Cutover reverted API call date time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycleLastTest
LifeCycleLastTest
Lifecycle last Test.
Contents
finalized
Lifecycle last Test finlized.
Type: LifeCycleLastTestFinalized (p. 139) object Required: No
initiated
Lifecycle last Test initiated.
Type: LifeCycleLastTestInitiated (p. 140) object Required: No
reverted
Lifecycle last Test reverted.
Type: LifeCycleLastTestReverted (p. 141) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycleLastTestFinalized
LifeCycleLastTestFinalized
Lifecycle last Test finlized.
Contents
apiCallDateTime
Lifecycle Test failed API call date and time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycleLastTestInitiated
LifeCycleLastTestInitiated
Lifecycle last Test initiated.
Contents
apiCallDateTime
Lifecycle last Test initiated API call date and time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No jobID
Lifecycle last Test initiated Job ID.
Type: String
Length Constraints: Fixed length of 24.
Pattern: ^mgnjob-[0-9a-zA-Z]{17}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LifeCycleLastTestReverted
LifeCycleLastTestReverted
Lifecycle last Test reverted.
Contents
apiCallDateTime
Lifecycle last Test reverted API call date and time.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 32.
Pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|
2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
NetworkInterface
NetworkInterface
Network interface.
Contents
ips
Network interface IPs.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No isPrimary
Network interface primary IP.
Type: Boolean Required: No macAddress
Network interface Mac address.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OS
OS
Operating System.
Contents
fullString
OS full string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ParticipatingServer
ParticipatingServer
Server participating in Job.
Contents
launchStatus
Participating server launch status.
Type: String
Valid Values: PENDING | IN_PROGRESS | LAUNCHED | FAILED | TERMINATED Required: No
sourceServerID
Participating server Source Server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern: ^s-[0-9a-zA-Z]{17}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3