AWS API Changes

2021/11/26 - Application Migration Service - 4 new 8 updated api methods

Changes Application Migration Service now supports an additional replication method that does not require agent installation on each source server. This option is available for source servers running on VMware vCenter versions 6.7 and 7.0.

DescribeVcenterClients (new)

Link ¶

Lists all vCenter clients.

See also: AWS API Documentation

Request Syntax

client.describe_vcenter_clients(
    maxResults=123,
    nextToken='string'
)

type maxResults

integer

param maxResults

Maximum results to be returned in DescribeVcenterClients.

type nextToken

string

param nextToken

Next pagination token to be provided for DescribeVcenterClients.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'datacenterName': 'string',
            'hostname': 'string',
            'lastSeenDatetime': 'string',
            'sourceServerTags': {
                'string': 'string'
            },
            'tags': {
                'string': 'string'
            },
            'vcenterClientID': 'string',
            'vcenterUUID': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  List of items returned by DescribeVcenterClients.
  - (dict) --
    
    vCenter client.
    - arn (string) --
      
      Arn of vCenter client.
    - datacenterName (string) --
      
      Datacenter name of vCenter client.
    - hostname (string) --
      
      Hostname of vCenter client .
    - lastSeenDatetime (string) --
      
      Last seen time of vCenter client.
    - sourceServerTags (dict) --
      
      Tags for Source Server of vCenter client.
      - (string) --
        
        (string) --
    - tags (dict) --
      
      Tags for vCenter client.
      - (string) --
        
        (string) --
    - vcenterClientID (string) --
      
      ID of vCenter client.
    - vcenterUUID (string) --
      
      Vcenter UUID of vCenter client.
- nextToken (string) --
  
  Next pagination token returned from DescribeVcenterClients.

UpdateSourceServerReplicationType (new)

Link ¶

Updates source server Replication Type by ID.

See also: AWS API Documentation

Request Syntax

client.update_source_server_replication_type(
    replicationType='AGENT_BASED'|'SNAPSHOT_SHIPPING',
    sourceServerID='string'
)

type replicationType

string

param replicationType

[REQUIRED]

Replication type to which to update source server.

type sourceServerID

string

param sourceServerID

[REQUIRED]

ID of source server on which to update replication type.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.

DeleteVcenterClient (new)

Link ¶

Deletes a single vCenter client by ID.

See also: AWS API Documentation

Request Syntax

client.delete_vcenter_client(
    vcenterClientID='string'
)

type vcenterClientID

string

param vcenterClientID

[REQUIRED]

ID of resource to be deleted.

returns

None

StartReplication (new)

Link ¶

Starts replication on source server by ID.

See also: AWS API Documentation

Request Syntax

client.start_replication(
    sourceServerID='string'
)

type sourceServerID

string

param sourceServerID

[REQUIRED]

ID of source server on which to start replication.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.

ChangeServerLifeCycleState (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'LAST_SNAPSHOT_JOB_FAILED',
                                                            'UNSUPPORTED_VM_CONFIGURATION'}},
                         'dataReplicationState': {'PENDING_SNAPSHOT_SHIPPING',
                                                  'SHIPPING_SNAPSHOT'},
                         'lastSnapshotDateTime': 'string'},
 'lifeCycle': {'state': {'DISCOVERED'}},
 'replicationType': 'AGENT_BASED | SNAPSHOT_SHIPPING',
 'sourceProperties': {'identificationHints': {'vmPath': 'string'}},
 'vcenterClientID': 'string'}

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

See also: AWS API Documentation

Request Syntax

client.change_server_life_cycle_state(
    lifeCycle={
        'state': 'READY_FOR_TEST'|'READY_FOR_CUTOVER'|'CUTOVER'
    },
    sourceServerID='string'
)

type lifeCycle

dict

param lifeCycle

[REQUIRED]

The request to change the source server migration lifecycle state.

state (string) -- [REQUIRED]

The request to change the source server migration lifecycle state.

type sourceServerID

string

param sourceServerID

[REQUIRED]

The request to change the source server migration lifecycle state by source server ID.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.

DescribeSourceServers (updated)

Link ¶
Changes (request, response)
Request

{'filters': {'lifeCycleStates': ['STOPPED | NOT_READY | READY_FOR_TEST | '
                                 'TESTING | READY_FOR_CUTOVER | CUTTING_OVER | '
                                 'CUTOVER | DISCONNECTED | DISCOVERED'],
             'replicationTypes': ['AGENT_BASED | SNAPSHOT_SHIPPING']}}

Response

{'items': {'dataReplicationInfo': {'dataReplicationError': {'error': {'LAST_SNAPSHOT_JOB_FAILED',
                                                                      'UNSUPPORTED_VM_CONFIGURATION'}},
                                   'dataReplicationState': {'PENDING_SNAPSHOT_SHIPPING',
                                                            'SHIPPING_SNAPSHOT'},
                                   'lastSnapshotDateTime': 'string'},
           'lifeCycle': {'state': {'DISCOVERED'}},
           'replicationType': 'AGENT_BASED | SNAPSHOT_SHIPPING',
           'sourceProperties': {'identificationHints': {'vmPath': 'string'}},
           'vcenterClientID': 'string'}}

Retrieves all SourceServers or multiple SourceServers by ID.

See also: AWS API Documentation

Request Syntax

client.describe_source_servers(
    filters={
        'isArchived': True|False,
        'lifeCycleStates': [
            'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED',
        ],
        'replicationTypes': [
            'AGENT_BASED'|'SNAPSHOT_SHIPPING',
        ],
        'sourceServerIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)

type filters

dict

param filters

[REQUIRED]

Request to filter Source Servers list.

isArchived (boolean) --

Request to filter Source Servers list by archived.
lifeCycleStates (list) --

Request to filter Source Servers list by life cycle states.
- (string) --
replicationTypes (list) --

Request to filter Source Servers list by replication type.
- (string) --
sourceServerIDs (list) --

Request to filter Source Servers list by Source Server ID.
- (string) --

type maxResults

integer

param maxResults

Request to filter Source Servers list by maximum results.

type nextToken

string

param nextToken

Request to filter Source Servers list by next token.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'dataReplicationInfo': {
                'dataReplicationError': {
                    'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
                    'rawError': 'string'
                },
                'dataReplicationInitiation': {
                    'nextAttemptDateTime': 'string',
                    'startDateTime': 'string',
                    'steps': [
                        {
                            'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                            'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                        },
                    ]
                },
                'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
                'etaDateTime': 'string',
                'lagDuration': 'string',
                'lastSnapshotDateTime': 'string',
                'replicatedDisks': [
                    {
                        'backloggedStorageBytes': 123,
                        'deviceName': 'string',
                        'replicatedStorageBytes': 123,
                        'rescannedStorageBytes': 123,
                        'totalStorageBytes': 123
                    },
                ]
            },
            'isArchived': True|False,
            'launchedInstance': {
                'ec2InstanceID': 'string',
                'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
                'jobID': 'string'
            },
            'lifeCycle': {
                'addedToServiceDateTime': 'string',
                'elapsedReplicationDuration': 'string',
                'firstByteDateTime': 'string',
                'lastCutover': {
                    'finalized': {
                        'apiCallDateTime': 'string'
                    },
                    'initiated': {
                        'apiCallDateTime': 'string',
                        'jobID': 'string'
                    },
                    'reverted': {
                        'apiCallDateTime': 'string'
                    }
                },
                'lastSeenByServiceDateTime': 'string',
                'lastTest': {
                    'finalized': {
                        'apiCallDateTime': 'string'
                    },
                    'initiated': {
                        'apiCallDateTime': 'string',
                        'jobID': 'string'
                    },
                    'reverted': {
                        'apiCallDateTime': 'string'
                    }
                },
                'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
            },
            'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
            'sourceProperties': {
                'cpus': [
                    {
                        'cores': 123,
                        'modelName': 'string'
                    },
                ],
                'disks': [
                    {
                        'bytes': 123,
                        'deviceName': 'string'
                    },
                ],
                'identificationHints': {
                    'awsInstanceID': 'string',
                    'fqdn': 'string',
                    'hostname': 'string',
                    'vmPath': 'string',
                    'vmWareUuid': 'string'
                },
                'lastUpdatedDateTime': 'string',
                'networkInterfaces': [
                    {
                        'ips': [
                            'string',
                        ],
                        'isPrimary': True|False,
                        'macAddress': 'string'
                    },
                ],
                'os': {
                    'fullString': 'string'
                },
                'ramBytes': 123,
                'recommendedInstanceType': 'string'
            },
            'sourceServerID': 'string',
            'tags': {
                'string': 'string'
            },
            'vcenterClientID': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  Request to filter Source Servers list by item.
  - (dict) --
    - arn (string) --
      
      Source server ARN.
    - dataReplicationInfo (dict) --
      
      Source server data replication info.
      - dataReplicationError (dict) --
        
        Error in obtaining data replication info.
        
        error (string) --
        
        Error in data replication.
        
        rawError (string) --
        
        Error in data replication.
      - dataReplicationInitiation (dict) --
        
        Request to query whether data replication has been initiated.
        
        nextAttemptDateTime (string) --
        
        Request to query next data initiation date and time.
        
        startDateTime (string) --
        
        Request to query data initiation start date and time.
        
        steps (list) --
        
        Request to query data initiation steps.
        
        (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
      - dataReplicationState (string) --
        
        Request to query the data replication state.
      - etaDateTime (string) --
        
        Request to query the time when data replication will be complete.
      - lagDuration (string) --
        
        Request to query data replication lag durating.
      - lastSnapshotDateTime (string) --
        
        Request to query data replication last snapshot time.
      - replicatedDisks (list) --
        
        Request to query disks replicated.
        
        (dict) --
        
        Request to query disks replicated.
        
        backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
        
        deviceName (string) --
        
        Request to query device name.
        
        replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
        
        rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
        
        totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
    - isArchived (boolean) --
      
      Source server archived status.
    - launchedInstance (dict) --
      
      Source server launched instance.
      - ec2InstanceID (string) --
        
        Configure launced instance EC2 ID.
      - firstBoot (string) --
        
        Configure launced instance first boot.
      - jobID (string) --
        
        Configure launced instance Job ID.
    - lifeCycle (dict) --
      
      Source server lifecycle state.
      - addedToServiceDateTime (string) --
        
        Lifecycle added to service data and time.
      - elapsedReplicationDuration (string) --
        
        Lifecycle elapsed time and duration.
      - firstByteDateTime (string) --
        
        Lifecycle replication initiation date and time.
      - lastCutover (dict) --
        
        Lifecycle last Cutover.
        
        finalized (dict) --
        
        Lifecycle Cutover finalized date and time.
        
        apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
        
        initiated (dict) --
        
        Lifecycle last Cutover initiated.
        
        apiCallDateTime (string) --
        
        jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
        
        reverted (dict) --
        
        Lifecycle last Cutover reverted.
        
        apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
      - lastSeenByServiceDateTime (string) --
        
        Lifecycle last seen date and time.
      - lastTest (dict) --
        
        Lifecycle last Test.
        
        finalized (dict) --
        
        Lifecycle last Test finlized.
        
        apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
        
        initiated (dict) --
        
        Lifecycle last Test initiated.
        
        apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
        
        jobID (string) --
        
        Lifecycle last Test initiated Job ID.
        
        reverted (dict) --
        
        Lifecycle last Test reverted.
        
        apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
      - state (string) --
        
        Lifecycle state.
    - replicationType (string) --
      
      Source server replication type.
    - sourceProperties (dict) --
      
      Source server properties.
      - cpus (list) --
        
        Source Server CPUs.
        
        (dict) --
        
        Source server CPU information.
        
        cores (integer) --
        
        The number of CPU cores on the source server.
        
        modelName (string) --
        
        The source server's CPU model name.
      - disks (list) --
        
        Source Server disks.
        
        (dict) --
        
        The disk identifier.
        
        bytes (integer) --
        
        The amount of storage on the disk in bytes.
        
        deviceName (string) --
        
        The disk or device name.
      - identificationHints (dict) --
        
        Source server identification hints.
        
        awsInstanceID (string) --
        
        AWS Instance ID identification hint.
        
        fqdn (string) --
        
        FQDN address identification hint.
        
        hostname (string) --
        
        Hostname identification hint.
        
        vmPath (string) --
        
        vCenter VM path identification hint.
        
        vmWareUuid (string) --
        
        vmWare UUID identification hint.
      - lastUpdatedDateTime (string) --
        
        Source server last update date and time.
      - networkInterfaces (list) --
        
        Source server network interfaces.
        
        (dict) --
        
        Network interface.
        
        ips (list) --
        
        Network interface IPs.
        
        (string) --
        
        isPrimary (boolean) --
        
        Network interface primary IP.
        
        macAddress (string) --
        
        Network interface Mac address.
      - os (dict) --
        
        Source server OS.
        
        fullString (string) --
        
        OS full string.
      - ramBytes (integer) --
        
        Source server RAM in bytes.
      - recommendedInstanceType (string) --
        
        Source server recommended instance type.
    - sourceServerID (string) --
      
      Source server ID.
    - tags (dict) --
      
      Source server Tags.
      - (string) --
        
        (string) --
    - vcenterClientID (string) --
      
      Source server vCenter client id.
- nextToken (string) --
  
  Request to filter Source Servers next token.

DisconnectFromService (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'LAST_SNAPSHOT_JOB_FAILED',
                                                            'UNSUPPORTED_VM_CONFIGURATION'}},
                         'dataReplicationState': {'PENDING_SNAPSHOT_SHIPPING',
                                                  'SHIPPING_SNAPSHOT'},
                         'lastSnapshotDateTime': 'string'},
 'lifeCycle': {'state': {'DISCOVERED'}},
 'replicationType': 'AGENT_BASED | SNAPSHOT_SHIPPING',
 'sourceProperties': {'identificationHints': {'vmPath': 'string'}},
 'vcenterClientID': 'string'}

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communciating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.

See also: AWS API Documentation

Request Syntax

client.disconnect_from_service(
    sourceServerID='string'
)

type sourceServerID

string

param sourceServerID

[REQUIRED]

Request to disconnect Source Server from service by Server ID.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.

FinalizeCutover (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'LAST_SNAPSHOT_JOB_FAILED',
                                                            'UNSUPPORTED_VM_CONFIGURATION'}},
                         'dataReplicationState': {'PENDING_SNAPSHOT_SHIPPING',
                                                  'SHIPPING_SNAPSHOT'},
                         'lastSnapshotDateTime': 'string'},
 'lifeCycle': {'state': {'DISCOVERED'}},
 'replicationType': 'AGENT_BASED | SNAPSHOT_SHIPPING',
 'sourceProperties': {'identificationHints': {'vmPath': 'string'}},
 'vcenterClientID': 'string'}

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.

See also: AWS API Documentation

Request Syntax

client.finalize_cutover(
    sourceServerID='string'
)

type sourceServerID

string

param sourceServerID

[REQUIRED]

Request to finalize Cutover by Soure Server ID.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.

MarkAsArchived (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'LAST_SNAPSHOT_JOB_FAILED',
                                                            'UNSUPPORTED_VM_CONFIGURATION'}},
                         'dataReplicationState': {'PENDING_SNAPSHOT_SHIPPING',
                                                  'SHIPPING_SNAPSHOT'},
                         'lastSnapshotDateTime': 'string'},
 'lifeCycle': {'state': {'DISCOVERED'}},
 'replicationType': 'AGENT_BASED | SNAPSHOT_SHIPPING',
 'sourceProperties': {'identificationHints': {'vmPath': 'string'}},
 'vcenterClientID': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.mark_as_archived(
    sourceServerID='string'
)

type sourceServerID

string

param sourceServerID

[REQUIRED]

Mark as archived by Source Server ID.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.

RetryDataReplication (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'LAST_SNAPSHOT_JOB_FAILED',
                                                            'UNSUPPORTED_VM_CONFIGURATION'}},
                         'dataReplicationState': {'PENDING_SNAPSHOT_SHIPPING',
                                                  'SHIPPING_SNAPSHOT'},
                         'lastSnapshotDateTime': 'string'},
 'lifeCycle': {'state': {'DISCOVERED'}},
 'replicationType': 'AGENT_BASED | SNAPSHOT_SHIPPING',
 'sourceProperties': {'identificationHints': {'vmPath': 'string'}},
 'vcenterClientID': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.retry_data_replication(
    sourceServerID='string'
)

type sourceServerID

string

param sourceServerID

[REQUIRED]

Retry data replication for Source Server ID.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.

StartReplication (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'LAST_SNAPSHOT_JOB_FAILED',
                                                            'UNSUPPORTED_VM_CONFIGURATION'}},
                         'dataReplicationState': {'PENDING_SNAPSHOT_SHIPPING',
                                                  'SHIPPING_SNAPSHOT'},
                         'lastSnapshotDateTime': 'string'},
 'lifeCycle': {'state': {'DISCOVERED'}},
 'replicationType': 'AGENT_BASED | SNAPSHOT_SHIPPING',
 'sourceProperties': {'identificationHints': {'vmPath': 'string'}},
 'vcenterClientID': 'string'}

Starts replication on source server by ID.

See also: AWS API Documentation

Request Syntax

client.start_replication(
    sourceServerID='string'
)

type sourceServerID

string

param sourceServerID

[REQUIRED]

ID of source server on which to start replication.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.

UpdateSourceServerReplicationType (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'LAST_SNAPSHOT_JOB_FAILED',
                                                            'UNSUPPORTED_VM_CONFIGURATION'}},
                         'dataReplicationState': {'PENDING_SNAPSHOT_SHIPPING',
                                                  'SHIPPING_SNAPSHOT'},
                         'lastSnapshotDateTime': 'string'},
 'lifeCycle': {'state': {'DISCOVERED'}},
 'replicationType': 'AGENT_BASED | SNAPSHOT_SHIPPING',
 'sourceProperties': {'identificationHints': {'vmPath': 'string'}},
 'vcenterClientID': 'string'}

Updates source server Replication Type by ID.

See also: AWS API Documentation

Request Syntax

client.update_source_server_replication_type(
    replicationType='AGENT_BASED'|'SNAPSHOT_SHIPPING',
    sourceServerID='string'
)

type replicationType

string

param replicationType

[REQUIRED]

Replication type to which to update source server.

type sourceServerID

string

param sourceServerID

[REQUIRED]

ID of source server on which to update replication type.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'vcenterClientID': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  Source server ARN.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication intiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - lagDuration (string) --
    
    Request to query data replication lag durating.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - deviceName (string) --
        
        Request to query device name.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
- isArchived (boolean) --
  
  Source server archived status.
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Configure launced instance EC2 ID.
  - firstBoot (string) --
    
    Configure launced instance first boot.
  - jobID (string) --
    
    Configure launced instance Job ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
    - initiated (dict) --
      
      Lifecycle last Cutover initiated.
      - apiCallDateTime (string) --
      - jobID (string) --
        
        Lifecycle last Cutover initiated by Job ID.
    - reverted (dict) --
      
      Lifecycle last Cutover reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Cutover reverted API call date time.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - finalized (dict) --
      
      Lifecycle last Test finlized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
    - initiated (dict) --
      
      Lifecycle last Test initiated.
      - apiCallDateTime (string) --
        
        Lifecycle last Test initiated API call date and time.
      - jobID (string) --
        
        Lifecycle last Test initiated Job ID.
    - reverted (dict) --
      
      Lifecycle last Test reverted.
      - apiCallDateTime (string) --
        
        Lifecycle last Test reverted API call date and time.
  - state (string) --
    
    Lifecycle state.
- replicationType (string) --
  
  Source server replication type.
- sourceProperties (dict) --
  
  Source server properties.
  - cpus (list) --
    
    Source Server CPUs.
    - (dict) --
      
      Source server CPU information.
      - cores (integer) --
        
        The number of CPU cores on the source server.
      - modelName (string) --
        
        The source server's CPU model name.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - deviceName (string) --
        
        The disk or device name.
  - identificationHints (dict) --
    
    Source server identification hints.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
      - macAddress (string) --
        
        Network interface Mac address.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
- sourceServerID (string) --
  
  Source server ID.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- vcenterClientID (string) --
  
  Source server vCenter client id.