AWS API Changes

2026/06/15 - Application Migration Service - 17 updated api methods

Changes AWS Transform for VMware now supports Amazon FSx for NetApp ONTAP as a target storage. Customers can migrate source server disks directly to FSx for NetApp ONTAP iSCSI LUNs. Target storage is configurable per source server, and compute, network, and storage migrate together in coordinated waves.

ChangeServerLifeCycleState (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

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(
    sourceServerID='string',
    lifeCycle={
        'state': 'READY_FOR_TEST'|'READY_FOR_CUTOVER'|'CUTOVER'
    },
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

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

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 accountID:

string

param accountID:

The request to change the source server migration account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

CreateReplicationConfigurationTemplate (updated)

Link ¶
Changes (both)

{'storageConfiguration': {'fsxOntapConfiguration': {'credentialsSecretArn': 'string',
                                                    'storageVirtualMachineId': 'string'},
                          'storageType': 'EBS | FSX_ONTAP'}}

Creates a new ReplicationConfigurationTemplate.

See also: AWS API Documentation

Request Syntax

client.create_replication_configuration_template(
    stagingAreaSubnetId='string',
    associateDefaultSecurityGroup=True|False,
    replicationServersSecurityGroupsIDs=[
        'string',
    ],
    replicationServerInstanceType='string',
    useDedicatedReplicationServer=True|False,
    defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
    ebsEncryption='DEFAULT'|'CUSTOM',
    ebsEncryptionKeyArn='string',
    bandwidthThrottling=123,
    dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
    createPublicIP=True|False,
    stagingAreaTags={
        'string': 'string'
    },
    useFipsEndpoint=True|False,
    tags={
        'string': 'string'
    },
    internetProtocol='IPV4'|'IPV6',
    storeSnapshotOnLocalZone=True|False,
    storageConfiguration={
        'storageType': 'EBS'|'FSX_ONTAP',
        'fsxOntapConfiguration': {
            'storageVirtualMachineId': 'string',
            'credentialsSecretArn': 'string'
        }
    }
)

type stagingAreaSubnetId:

string

param stagingAreaSubnetId:

[REQUIRED]

Request to configure the Staging Area subnet ID during Replication Settings template creation.

type associateDefaultSecurityGroup:

boolean

param associateDefaultSecurityGroup:

[REQUIRED]

Request to associate the default Application Migration Service Security group with the Replication Settings template.

type replicationServersSecurityGroupsIDs:

list

param replicationServersSecurityGroupsIDs:

[REQUIRED]

Request to configure the Replication Server Security group ID during Replication Settings template creation.

(string) --

type replicationServerInstanceType:

string

param replicationServerInstanceType:

[REQUIRED]

Request to configure the Replication Server instance type during Replication Settings template creation.

type useDedicatedReplicationServer:

boolean

param useDedicatedReplicationServer:

[REQUIRED]

Request to use Dedicated Replication Servers during Replication Settings template creation.

type defaultLargeStagingDiskType:

string

param defaultLargeStagingDiskType:

[REQUIRED]

Request to configure the default large staging disk EBS volume type during Replication Settings template creation.

type ebsEncryption:

string

param ebsEncryption:

[REQUIRED]

Request to configure EBS encryption during Replication Settings template creation.

type ebsEncryptionKeyArn:

string

param ebsEncryptionKeyArn:

Request to configure an EBS encryption key during Replication Settings template creation.

type bandwidthThrottling:

integer

param bandwidthThrottling:

[REQUIRED]

Request to configure bandwidth throttling during Replication Settings template creation.

type dataPlaneRouting:

string

param dataPlaneRouting:

[REQUIRED]

Request to configure data plane routing during Replication Settings template creation.

type createPublicIP:

boolean

param createPublicIP:

[REQUIRED]

Request to create Public IP during Replication Settings template creation.

type stagingAreaTags:

dict

param stagingAreaTags:

[REQUIRED]

Request to configure Staging Area tags during Replication Settings template creation.

(string) --
- (string) --

type useFipsEndpoint:

boolean

param useFipsEndpoint:

Request to use Fips Endpoint during Replication Settings template creation.

type tags:

dict

param tags:

Request to configure tags during Replication Settings template creation.

(string) --
- (string) --

type internetProtocol:

string

param internetProtocol:

Request to configure the internet protocol to IPv4 or IPv6.

type storeSnapshotOnLocalZone:

boolean

param storeSnapshotOnLocalZone:

Request to store snapshot on local zone during Replication Settings template creation.

type storageConfiguration:

dict

param storageConfiguration:

Request to configure storage during Replication Settings template creation.

storageType (string) -- [REQUIRED]

Storage configuration storage type.
fsxOntapConfiguration (dict) --

Storage configuration FSx ONTAP configuration.
- storageVirtualMachineId (string) -- [REQUIRED]
  
  FSx ONTAP configuration storage virtual machine ID.
- credentialsSecretArn (string) -- [REQUIRED]
  
  FSx ONTAP configuration credentials secret ARN.

rtype:

dict

returns:

Response Syntax

{
    'replicationConfigurationTemplateID': 'string',
    'arn': 'string',
    'stagingAreaSubnetId': 'string',
    'associateDefaultSecurityGroup': True|False,
    'replicationServersSecurityGroupsIDs': [
        'string',
    ],
    'replicationServerInstanceType': 'string',
    'useDedicatedReplicationServer': True|False,
    'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
    'ebsEncryption': 'DEFAULT'|'CUSTOM',
    'ebsEncryptionKeyArn': 'string',
    'bandwidthThrottling': 123,
    'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
    'createPublicIP': True|False,
    'stagingAreaTags': {
        'string': 'string'
    },
    'useFipsEndpoint': True|False,
    'tags': {
        'string': 'string'
    },
    'internetProtocol': 'IPV4'|'IPV6',
    'storeSnapshotOnLocalZone': True|False,
    'storageConfiguration': {
        'storageType': 'EBS'|'FSX_ONTAP',
        'fsxOntapConfiguration': {
            'storageVirtualMachineId': 'string',
            'credentialsSecretArn': 'string'
        }
    }
}

Response Structure

(dict) --
- replicationConfigurationTemplateID (string) --
  
  Replication Configuration template ID.
- arn (string) --
  
  Replication Configuration template ARN.
- stagingAreaSubnetId (string) --
  
  Replication Configuration template Staging Area subnet ID.
- associateDefaultSecurityGroup (boolean) --
  
  Replication Configuration template associate default Application Migration Service Security group.
- replicationServersSecurityGroupsIDs (list) --
  
  Replication Configuration template server Security Groups IDs.
  - (string) --
- replicationServerInstanceType (string) --
  
  Replication Configuration template server instance type.
- useDedicatedReplicationServer (boolean) --
  
  Replication Configuration template use Dedicated Replication Server.
- defaultLargeStagingDiskType (string) --
  
  Replication Configuration template use default large Staging Disk type.
- ebsEncryption (string) --
  
  Replication Configuration template EBS encryption.
- ebsEncryptionKeyArn (string) --
  
  Replication Configuration template EBS encryption key ARN.
- bandwidthThrottling (integer) --
  
  Replication Configuration template bandwidth throttling.
- dataPlaneRouting (string) --
  
  Replication Configuration template data plane routing.
- createPublicIP (boolean) --
  
  Replication Configuration template create Public IP.
- stagingAreaTags (dict) --
  
  Replication Configuration template Staging Area Tags.
  - (string) --
    - (string) --
- useFipsEndpoint (boolean) --
  
  Replication Configuration template use Fips Endpoint.
- tags (dict) --
  
  Replication Configuration template Tags.
  - (string) --
    - (string) --
- internetProtocol (string) --
  
  Replication Configuration template internet protocol.
- storeSnapshotOnLocalZone (boolean) --
  
  Replication Configuration template store snapshot on local zone.
- storageConfiguration (dict) --
  
  Replication Configuration template storage configuration.
  - storageType (string) --
    
    Storage configuration storage type.
  - fsxOntapConfiguration (dict) --
    
    Storage configuration FSx ONTAP configuration.
    - storageVirtualMachineId (string) --
      
      FSx ONTAP configuration storage virtual machine ID.
    - credentialsSecretArn (string) --
      
      FSx ONTAP configuration credentials secret ARN.

DescribeReplicationConfigurationTemplates (updated)

Link ¶
Changes (response)

{'items': {'storageConfiguration': {'fsxOntapConfiguration': {'credentialsSecretArn': 'string',
                                                              'storageVirtualMachineId': 'string'},
                                    'storageType': 'EBS | FSX_ONTAP'}}}

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

See also: AWS API Documentation

Request Syntax

client.describe_replication_configuration_templates(
    replicationConfigurationTemplateIDs=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)

type replicationConfigurationTemplateIDs:

list

param replicationConfigurationTemplateIDs:

Request to describe Replication Configuration template by template IDs.

(string) --

type maxResults:

integer

param maxResults:

Request to describe Replication Configuration template by max results.

type nextToken:

string

param nextToken:

Request to describe Replication Configuration template by next token.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'replicationConfigurationTemplateID': 'string',
            'arn': 'string',
            'stagingAreaSubnetId': 'string',
            'associateDefaultSecurityGroup': True|False,
            'replicationServersSecurityGroupsIDs': [
                'string',
            ],
            'replicationServerInstanceType': 'string',
            'useDedicatedReplicationServer': True|False,
            'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
            'ebsEncryption': 'DEFAULT'|'CUSTOM',
            'ebsEncryptionKeyArn': 'string',
            'bandwidthThrottling': 123,
            'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
            'createPublicIP': True|False,
            'stagingAreaTags': {
                'string': 'string'
            },
            'useFipsEndpoint': True|False,
            'tags': {
                'string': 'string'
            },
            'internetProtocol': 'IPV4'|'IPV6',
            'storeSnapshotOnLocalZone': True|False,
            'storageConfiguration': {
                'storageType': 'EBS'|'FSX_ONTAP',
                'fsxOntapConfiguration': {
                    'storageVirtualMachineId': 'string',
                    'credentialsSecretArn': 'string'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  Request to describe Replication Configuration template by items.
  - (dict) --
    - replicationConfigurationTemplateID (string) --
      
      Replication Configuration template ID.
    - arn (string) --
      
      Replication Configuration template ARN.
    - stagingAreaSubnetId (string) --
      
      Replication Configuration template Staging Area subnet ID.
    - associateDefaultSecurityGroup (boolean) --
      
      Replication Configuration template associate default Application Migration Service Security group.
    - replicationServersSecurityGroupsIDs (list) --
      
      Replication Configuration template server Security Groups IDs.
      - (string) --
    - replicationServerInstanceType (string) --
      
      Replication Configuration template server instance type.
    - useDedicatedReplicationServer (boolean) --
      
      Replication Configuration template use Dedicated Replication Server.
    - defaultLargeStagingDiskType (string) --
      
      Replication Configuration template use default large Staging Disk type.
    - ebsEncryption (string) --
      
      Replication Configuration template EBS encryption.
    - ebsEncryptionKeyArn (string) --
      
      Replication Configuration template EBS encryption key ARN.
    - bandwidthThrottling (integer) --
      
      Replication Configuration template bandwidth throttling.
    - dataPlaneRouting (string) --
      
      Replication Configuration template data plane routing.
    - createPublicIP (boolean) --
      
      Replication Configuration template create Public IP.
    - stagingAreaTags (dict) --
      
      Replication Configuration template Staging Area Tags.
      - (string) --
        
        (string) --
    - useFipsEndpoint (boolean) --
      
      Replication Configuration template use Fips Endpoint.
    - tags (dict) --
      
      Replication Configuration template Tags.
      - (string) --
        
        (string) --
    - internetProtocol (string) --
      
      Replication Configuration template internet protocol.
    - storeSnapshotOnLocalZone (boolean) --
      
      Replication Configuration template store snapshot on local zone.
    - storageConfiguration (dict) --
      
      Replication Configuration template storage configuration.
      - storageType (string) --
        
        Storage configuration storage type.
      - fsxOntapConfiguration (dict) --
        
        Storage configuration FSx ONTAP configuration.
        
        storageVirtualMachineId (string) --
        
        FSx ONTAP configuration storage virtual machine ID.
        
        credentialsSecretArn (string) --
        
        FSx ONTAP configuration credentials secret ARN.
- nextToken (string) --
  
  Request to describe Replication Configuration template by next token.

DescribeSourceServers (updated)

Link ¶
Changes (response)

{'items': {'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                                      'FAILED_TO_SETUP_FSX_PROXY'}},
                                   'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
           'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                                     'error': 'string',
                                                     'name': 'string',
                                                     'status': 'PASSED | '
                                                               'FAILED | '
                                                               'PENDING',
                                                     'type': 'EC2 | FSx'}],
                                'lastKnownFsxChecksStatus': 'PASSED | FAILED | '
                                                            'PENDING'}}}

Retrieves all SourceServers or multiple SourceServers by ID.

See also: AWS API Documentation

Request Syntax

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

type filters:

dict

param filters:

Request to filter Source Servers list.

sourceServerIDs (list) --

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

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

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

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

Request to filter Source Servers list by application IDs.
- (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.

type accountID:

string

param accountID:

Request to filter Source Servers list by Accoun ID.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'sourceServerID': 'string',
            'arn': 'string',
            'isArchived': True|False,
            'tags': {
                'string': 'string'
            },
            'launchedInstance': {
                'ec2InstanceID': 'string',
                'jobID': 'string',
                'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
                'lastKnownChecks': [
                    {
                        'type': 'EC2'|'FSx',
                        'name': 'string',
                        'status': 'PASSED'|'FAILED'|'PENDING',
                        'error': 'string',
                        'checkedAt': datetime(2015, 1, 1)
                    },
                ],
                'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
            },
            'dataReplicationInfo': {
                'lagDuration': 'string',
                'etaDateTime': 'string',
                'replicatedDisks': [
                    {
                        'deviceName': 'string',
                        'totalStorageBytes': 123,
                        'replicatedStorageBytes': 123,
                        'rescannedStorageBytes': 123,
                        'backloggedStorageBytes': 123
                    },
                ],
                'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
                'dataReplicationInitiation': {
                    'startDateTime': 'string',
                    'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                            'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                        },
                    ]
                },
                '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
                    'rawError': 'string'
                },
                'lastSnapshotDateTime': 'string',
                'replicatorId': 'string'
            },
            'lifeCycle': {
                'addedToServiceDateTime': 'string',
                'firstByteDateTime': 'string',
                'elapsedReplicationDuration': 'string',
                'lastSeenByServiceDateTime': 'string',
                'lastTest': {
                    'initiated': {
                        'apiCallDateTime': 'string',
                        'jobID': 'string'
                    },
                    'reverted': {
                        'apiCallDateTime': 'string'
                    },
                    'finalized': {
                        'apiCallDateTime': 'string'
                    }
                },
                'lastCutover': {
                    'initiated': {
                        'apiCallDateTime': 'string',
                        'jobID': 'string'
                    },
                    'reverted': {
                        'apiCallDateTime': 'string'
                    },
                    'finalized': {
                        'apiCallDateTime': 'string'
                    }
                },
                'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
            },
            'sourceProperties': {
                'lastUpdatedDateTime': 'string',
                'recommendedInstanceType': 'string',
                'identificationHints': {
                    'fqdn': 'string',
                    'hostname': 'string',
                    'vmWareUuid': 'string',
                    'awsInstanceID': 'string',
                    'vmPath': 'string'
                },
                'networkInterfaces': [
                    {
                        'macAddress': 'string',
                        'ips': [
                            'string',
                        ],
                        'isPrimary': True|False
                    },
                ],
                'disks': [
                    {
                        'deviceName': 'string',
                        'bytes': 123
                    },
                ],
                'cpus': [
                    {
                        'cores': 123,
                        'modelName': 'string'
                    },
                ],
                'ramBytes': 123,
                'os': {
                    'fullString': 'string'
                }
            },
            'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
            'vcenterClientID': 'string',
            'applicationID': 'string',
            'userProvidedID': 'string',
            'fqdnForActionFramework': 'string',
            'connectorAction': {
                'credentialsSecretArn': 'string',
                'connectorArn': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  Request to filter Source Servers list by item.
  - (dict) --
    - sourceServerID (string) --
      
      Source server ID.
    - arn (string) --
      
      Source server ARN.
    - isArchived (boolean) --
      
      Source server archived status.
    - tags (dict) --
      
      Source server Tags.
      - (string) --
        
        (string) --
    - launchedInstance (dict) --
      
      Source server launched instance.
      - ec2InstanceID (string) --
        
        Launched instance EC2 ID.
      - jobID (string) --
        
        Launched instance Job ID.
      - firstBoot (string) --
        
        Launched instance first boot.
      - lastKnownChecks (list) --
        
        Launched instance last known checks.
        
        (dict) --
        
        Last known check performed on a launched instance.
        
        type (string) --
        
        Last known check type.
        
        name (string) --
        
        Last known check name.
        
        status (string) --
        
        Last known check status.
        
        error (string) --
        
        Last known check error.
        
        checkedAt (datetime) --
        
        Last known check timestamp.
      - lastKnownFsxChecksStatus (string) --
        
        Launched instance last known FSx checks status.
    - dataReplicationInfo (dict) --
      
      Source server data replication info.
      - lagDuration (string) --
        
        Request to query data replication lag duration.
      - etaDateTime (string) --
        
        Request to query the time when data replication will be complete.
      - replicatedDisks (list) --
        
        Request to query disks replicated.
        
        (dict) --
        
        Request to query disks replicated.
        
        deviceName (string) --
        
        Request to query device name.
        
        totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
        
        replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
        
        rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
        
        backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
      - dataReplicationState (string) --
        
        Request to query the data replication state.
      - dataReplicationInitiation (dict) --
        
        Request to query whether data replication has been initiated.
        
        startDateTime (string) --
        
        Request to query data initiation start date and time.
        
        nextAttemptDateTime (string) --
        
        Request to query next data initiation date and time.
        
        steps (list) --
        
        Request to query data initiation steps.
        
        (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
      - dataReplicationError (dict) --
        
        Error in obtaining data replication info.
        
        error (string) --
        
        Error in data replication.
        
        rawError (string) --
        
        Error in data replication.
      - lastSnapshotDateTime (string) --
        
        Request to query data replication last snapshot time.
      - replicatorId (string) --
        
        Replication server instance ID.
    - lifeCycle (dict) --
      
      Source server lifecycle state.
      - addedToServiceDateTime (string) --
        
        Lifecycle added to service data and time.
      - firstByteDateTime (string) --
        
        Lifecycle replication initiation date and time.
      - elapsedReplicationDuration (string) --
        
        Lifecycle elapsed time and duration.
      - lastSeenByServiceDateTime (string) --
        
        Lifecycle last seen date and time.
      - lastTest (dict) --
        
        Lifecycle last Test.
        
        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.
        
        finalized (dict) --
        
        Lifecycle last Test finalized.
        
        apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
      - lastCutover (dict) --
        
        Lifecycle last Cutover.
        
        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.
        
        finalized (dict) --
        
        Lifecycle Cutover finalized date and time.
        
        apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
      - state (string) --
        
        Lifecycle state.
    - sourceProperties (dict) --
      
      Source server properties.
      - lastUpdatedDateTime (string) --
        
        Source server last update date and time.
      - recommendedInstanceType (string) --
        
        Source server recommended instance type.
      - identificationHints (dict) --
        
        Source server identification hints.
        
        fqdn (string) --
        
        FQDN address identification hint.
        
        hostname (string) --
        
        Hostname identification hint.
        
        vmWareUuid (string) --
        
        vmWare UUID identification hint.
        
        awsInstanceID (string) --
        
        AWS Instance ID identification hint.
        
        vmPath (string) --
        
        vCenter VM path identification hint.
      - networkInterfaces (list) --
        
        Source server network interfaces.
        
        (dict) --
        
        Network interface.
        
        macAddress (string) --
        
        Network interface Mac address.
        
        ips (list) --
        
        Network interface IPs.
        
        (string) --
        
        isPrimary (boolean) --
        
        Network interface primary IP.
      - disks (list) --
        
        Source Server disks.
        
        (dict) --
        
        The disk identifier.
        
        deviceName (string) --
        
        The disk or device name.
        
        bytes (integer) --
        
        The amount of storage on the disk in bytes.
      - 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.
      - ramBytes (integer) --
        
        Source server RAM in bytes.
      - os (dict) --
        
        Source server OS.
        
        fullString (string) --
        
        OS full string.
    - replicationType (string) --
      
      Source server replication type.
    - vcenterClientID (string) --
      
      Source server vCenter client id.
    - applicationID (string) --
      
      Source server application ID.
    - userProvidedID (string) --
      
      Source server user provided ID.
    - fqdnForActionFramework (string) --
      
      Source server fqdn for action framework.
    - connectorAction (dict) --
      
      Source Server connector action.
      - credentialsSecretArn (string) --
        
        Source Server connector action credentials secret arn.
      - connectorArn (string) --
        
        Source Server connector action connector arn.
- nextToken (string) --
  
  Request to filter Source Servers next token.

DisconnectFromService (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

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 communicating 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.lagDuration will be nullified.

See also: AWS API Documentation

Request Syntax

client.disconnect_from_service(
    sourceServerID='string',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Request to disconnect Source Server from service by Server ID.

type accountID:

string

param accountID:

Request to disconnect Source Server from service by Account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

FinalizeCutover (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

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 changed 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.lagDuration will be nullified.

See also: AWS API Documentation

Request Syntax

client.finalize_cutover(
    sourceServerID='string',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Request to finalize Cutover by Source Server ID.

type accountID:

string

param accountID:

Request to finalize Cutover by Source Account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

GetReplicationConfiguration (updated)

Link ¶
Changes (response)

{'replicatedDisks': {'stagingDiskType': {'FSX_ONTAP'}},
 'storageConfiguration': {'fsxOntapConfiguration': {'credentialsSecretArn': 'string',
                                                    'storageVirtualMachineId': 'string'},
                          'storageType': 'EBS | FSX_ONTAP'}}

Lists all ReplicationConfigurations, filtered by Source Server ID.

See also: AWS API Documentation

Request Syntax

client.get_replication_configuration(
    sourceServerID='string',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Request to get Replication Configuration by Source Server ID.

type accountID:

string

param accountID:

Request to get Replication Configuration by Account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'name': 'string',
    'stagingAreaSubnetId': 'string',
    'associateDefaultSecurityGroup': True|False,
    'replicationServersSecurityGroupsIDs': [
        'string',
    ],
    'replicationServerInstanceType': 'string',
    'useDedicatedReplicationServer': True|False,
    'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
    'replicatedDisks': [
        {
            'deviceName': 'string',
            'isBootDisk': True|False,
            'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2'|'FSX_ONTAP',
            'iops': 123,
            'throughput': 123
        },
    ],
    'ebsEncryption': 'DEFAULT'|'CUSTOM',
    'ebsEncryptionKeyArn': 'string',
    'bandwidthThrottling': 123,
    'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
    'createPublicIP': True|False,
    'stagingAreaTags': {
        'string': 'string'
    },
    'useFipsEndpoint': True|False,
    'internetProtocol': 'IPV4'|'IPV6',
    'storeSnapshotOnLocalZone': True|False,
    'storageConfiguration': {
        'storageType': 'EBS'|'FSX_ONTAP',
        'fsxOntapConfiguration': {
            'storageVirtualMachineId': 'string',
            'credentialsSecretArn': 'string'
        }
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Replication Configuration Source Server ID.
- name (string) --
  
  Replication Configuration name.
- stagingAreaSubnetId (string) --
  
  Replication Configuration Staging Area subnet ID.
- associateDefaultSecurityGroup (boolean) --
  
  Replication Configuration associate default Application Migration Service Security Group.
- replicationServersSecurityGroupsIDs (list) --
  
  Replication Configuration Replication Server Security Group IDs.
  - (string) --
- replicationServerInstanceType (string) --
  
  Replication Configuration Replication Server instance type.
- useDedicatedReplicationServer (boolean) --
  
  Replication Configuration use Dedicated Replication Server.
- defaultLargeStagingDiskType (string) --
  
  Replication Configuration use default large Staging Disks.
- replicatedDisks (list) --
  
  Replication Configuration replicated disks.
  - (dict) --
    
    Replication Configuration replicated disk.
    - deviceName (string) --
      
      Replication Configuration replicated disk device name.
    - isBootDisk (boolean) --
      
      Replication Configuration replicated disk boot disk.
    - stagingDiskType (string) --
      
      Replication Configuration replicated disk staging disk type.
    - iops (integer) --
      
      Replication Configuration replicated disk IOPs.
    - throughput (integer) --
      
      Replication Configuration replicated disk throughput.
- ebsEncryption (string) --
  
  Replication Configuration EBS encryption.
- ebsEncryptionKeyArn (string) --
  
  Replication Configuration EBS encryption key ARN.
- bandwidthThrottling (integer) --
  
  Replication Configuration set bandwidth throttling.
- dataPlaneRouting (string) --
  
  Replication Configuration data plane routing.
- createPublicIP (boolean) --
  
  Replication Configuration create Public IP.
- stagingAreaTags (dict) --
  
  Replication Configuration Staging Area tags.
  - (string) --
    - (string) --
- useFipsEndpoint (boolean) --
  
  Replication Configuration use Fips Endpoint.
- internetProtocol (string) --
  
  Replication Configuration internet protocol.
- storeSnapshotOnLocalZone (boolean) --
  
  Replication Configuration store snapshot on local zone.
- storageConfiguration (dict) --
  
  Replication Configuration storage configuration.
  - storageType (string) --
    
    Storage configuration storage type.
  - fsxOntapConfiguration (dict) --
    
    Storage configuration FSx ONTAP configuration.
    - storageVirtualMachineId (string) --
      
      FSx ONTAP configuration storage virtual machine ID.
    - credentialsSecretArn (string) --
      
      FSx ONTAP configuration credentials secret ARN.

MarkAsArchived (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

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',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Mark as archived by Source Server ID.

type accountID:

string

param accountID:

Mark as archived by Account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

PauseReplication (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

Pause Replication.

See also: AWS API Documentation

Request Syntax

client.pause_replication(
    sourceServerID='string',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Pause Replication Request source server ID.

type accountID:

string

param accountID:

Pause Replication Request account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

ResumeReplication (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

Resume Replication.

See also: AWS API Documentation

Request Syntax

client.resume_replication(
    sourceServerID='string',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Resume Replication Request source server ID.

type accountID:

string

param accountID:

Resume Replication Request account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

RetryDataReplication (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

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',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Retry data replication for Source Server ID.

type accountID:

string

param accountID:

Retry data replication for Account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

StartReplication (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

Start replication for source server irrespective of its replication type.

See also: AWS API Documentation

Request Syntax

client.start_replication(
    sourceServerID='string',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

ID of source server on which to start replication.

type accountID:

string

param accountID:

Account ID on which to start replication.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

StopReplication (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

Stop Replication.

See also: AWS API Documentation

Request Syntax

client.stop_replication(
    sourceServerID='string',
    accountID='string'
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Stop Replication Request source server ID.

type accountID:

string

param accountID:

Stop Replication Request account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

UpdateReplicationConfiguration (updated)

Link ¶
Changes (both)

{'replicatedDisks': {'stagingDiskType': {'FSX_ONTAP'}},
 'storageConfiguration': {'fsxOntapConfiguration': {'credentialsSecretArn': 'string',
                                                    'storageVirtualMachineId': 'string'},
                          'storageType': 'EBS | FSX_ONTAP'}}

Allows you to update multiple ReplicationConfigurations by Source Server ID.

See also: AWS API Documentation

Request Syntax

client.update_replication_configuration(
    sourceServerID='string',
    name='string',
    stagingAreaSubnetId='string',
    associateDefaultSecurityGroup=True|False,
    replicationServersSecurityGroupsIDs=[
        'string',
    ],
    replicationServerInstanceType='string',
    useDedicatedReplicationServer=True|False,
    defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
    replicatedDisks=[
        {
            'deviceName': 'string',
            'isBootDisk': True|False,
            'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2'|'FSX_ONTAP',
            'iops': 123,
            'throughput': 123
        },
    ],
    ebsEncryption='DEFAULT'|'CUSTOM',
    ebsEncryptionKeyArn='string',
    bandwidthThrottling=123,
    dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
    createPublicIP=True|False,
    stagingAreaTags={
        'string': 'string'
    },
    useFipsEndpoint=True|False,
    accountID='string',
    internetProtocol='IPV4'|'IPV6',
    storeSnapshotOnLocalZone=True|False,
    storageConfiguration={
        'storageType': 'EBS'|'FSX_ONTAP',
        'fsxOntapConfiguration': {
            'storageVirtualMachineId': 'string',
            'credentialsSecretArn': 'string'
        }
    }
)

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Update replication configuration Source Server ID request.

type name:

string

param name:

Update replication configuration name request.

type stagingAreaSubnetId:

string

param stagingAreaSubnetId:

Update replication configuration Staging Area subnet request.

type associateDefaultSecurityGroup:

boolean

param associateDefaultSecurityGroup:

Update replication configuration associate default Application Migration Service Security group request.

type replicationServersSecurityGroupsIDs:

list

param replicationServersSecurityGroupsIDs:

Update replication configuration Replication Server Security Groups IDs request.

(string) --

type replicationServerInstanceType:

string

param replicationServerInstanceType:

Update replication configuration Replication Server instance type request.

type useDedicatedReplicationServer:

boolean

param useDedicatedReplicationServer:

Update replication configuration use dedicated Replication Server request.

type defaultLargeStagingDiskType:

string

param defaultLargeStagingDiskType:

Update replication configuration use default large Staging Disk type request.

type replicatedDisks:

list

param replicatedDisks:

Update replication configuration replicated disks request.

(dict) --

Replication Configuration replicated disk.
- deviceName (string) --
  
  Replication Configuration replicated disk device name.
- isBootDisk (boolean) --
  
  Replication Configuration replicated disk boot disk.
- stagingDiskType (string) --
  
  Replication Configuration replicated disk staging disk type.
- iops (integer) --
  
  Replication Configuration replicated disk IOPs.
- throughput (integer) --
  
  Replication Configuration replicated disk throughput.

type ebsEncryption:

string

param ebsEncryption:

Update replication configuration EBS encryption request.

type ebsEncryptionKeyArn:

string

param ebsEncryptionKeyArn:

Update replication configuration EBS encryption key ARN request.

type bandwidthThrottling:

integer

param bandwidthThrottling:

Update replication configuration bandwidth throttling request.

type dataPlaneRouting:

string

param dataPlaneRouting:

Update replication configuration data plane routing request.

type createPublicIP:

boolean

param createPublicIP:

Update replication configuration create Public IP request.

type stagingAreaTags:

dict

param stagingAreaTags:

Update replication configuration Staging Area Tags request.

(string) --
- (string) --

type useFipsEndpoint:

boolean

param useFipsEndpoint:

Update replication configuration use Fips Endpoint.

type accountID:

string

param accountID:

Update replication configuration Account ID request.

type internetProtocol:

string

param internetProtocol:

Update replication configuration internet protocol.

type storeSnapshotOnLocalZone:

boolean

param storeSnapshotOnLocalZone:

Update replication configuration store snapshot on local zone.

type storageConfiguration:

dict

param storageConfiguration:

Update replication configuration storage configuration.

storageType (string) -- [REQUIRED]

Storage configuration storage type.
fsxOntapConfiguration (dict) --

Storage configuration FSx ONTAP configuration.
- storageVirtualMachineId (string) -- [REQUIRED]
  
  FSx ONTAP configuration storage virtual machine ID.
- credentialsSecretArn (string) -- [REQUIRED]
  
  FSx ONTAP configuration credentials secret ARN.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'name': 'string',
    'stagingAreaSubnetId': 'string',
    'associateDefaultSecurityGroup': True|False,
    'replicationServersSecurityGroupsIDs': [
        'string',
    ],
    'replicationServerInstanceType': 'string',
    'useDedicatedReplicationServer': True|False,
    'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
    'replicatedDisks': [
        {
            'deviceName': 'string',
            'isBootDisk': True|False,
            'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2'|'FSX_ONTAP',
            'iops': 123,
            'throughput': 123
        },
    ],
    'ebsEncryption': 'DEFAULT'|'CUSTOM',
    'ebsEncryptionKeyArn': 'string',
    'bandwidthThrottling': 123,
    'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
    'createPublicIP': True|False,
    'stagingAreaTags': {
        'string': 'string'
    },
    'useFipsEndpoint': True|False,
    'internetProtocol': 'IPV4'|'IPV6',
    'storeSnapshotOnLocalZone': True|False,
    'storageConfiguration': {
        'storageType': 'EBS'|'FSX_ONTAP',
        'fsxOntapConfiguration': {
            'storageVirtualMachineId': 'string',
            'credentialsSecretArn': 'string'
        }
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Replication Configuration Source Server ID.
- name (string) --
  
  Replication Configuration name.
- stagingAreaSubnetId (string) --
  
  Replication Configuration Staging Area subnet ID.
- associateDefaultSecurityGroup (boolean) --
  
  Replication Configuration associate default Application Migration Service Security Group.
- replicationServersSecurityGroupsIDs (list) --
  
  Replication Configuration Replication Server Security Group IDs.
  - (string) --
- replicationServerInstanceType (string) --
  
  Replication Configuration Replication Server instance type.
- useDedicatedReplicationServer (boolean) --
  
  Replication Configuration use Dedicated Replication Server.
- defaultLargeStagingDiskType (string) --
  
  Replication Configuration use default large Staging Disks.
- replicatedDisks (list) --
  
  Replication Configuration replicated disks.
  - (dict) --
    
    Replication Configuration replicated disk.
    - deviceName (string) --
      
      Replication Configuration replicated disk device name.
    - isBootDisk (boolean) --
      
      Replication Configuration replicated disk boot disk.
    - stagingDiskType (string) --
      
      Replication Configuration replicated disk staging disk type.
    - iops (integer) --
      
      Replication Configuration replicated disk IOPs.
    - throughput (integer) --
      
      Replication Configuration replicated disk throughput.
- ebsEncryption (string) --
  
  Replication Configuration EBS encryption.
- ebsEncryptionKeyArn (string) --
  
  Replication Configuration EBS encryption key ARN.
- bandwidthThrottling (integer) --
  
  Replication Configuration set bandwidth throttling.
- dataPlaneRouting (string) --
  
  Replication Configuration data plane routing.
- createPublicIP (boolean) --
  
  Replication Configuration create Public IP.
- stagingAreaTags (dict) --
  
  Replication Configuration Staging Area tags.
  - (string) --
    - (string) --
- useFipsEndpoint (boolean) --
  
  Replication Configuration use Fips Endpoint.
- internetProtocol (string) --
  
  Replication Configuration internet protocol.
- storeSnapshotOnLocalZone (boolean) --
  
  Replication Configuration store snapshot on local zone.
- storageConfiguration (dict) --
  
  Replication Configuration storage configuration.
  - storageType (string) --
    
    Storage configuration storage type.
  - fsxOntapConfiguration (dict) --
    
    Storage configuration FSx ONTAP configuration.
    - storageVirtualMachineId (string) --
      
      FSx ONTAP configuration storage virtual machine ID.
    - credentialsSecretArn (string) --
      
      FSx ONTAP configuration credentials secret ARN.

UpdateReplicationConfigurationTemplate (updated)

Link ¶
Changes (both)

{'storageConfiguration': {'fsxOntapConfiguration': {'credentialsSecretArn': 'string',
                                                    'storageVirtualMachineId': 'string'},
                          'storageType': 'EBS | FSX_ONTAP'}}

Updates multiple ReplicationConfigurationTemplates by ID.

See also: AWS API Documentation

Request Syntax

client.update_replication_configuration_template(
    replicationConfigurationTemplateID='string',
    arn='string',
    stagingAreaSubnetId='string',
    associateDefaultSecurityGroup=True|False,
    replicationServersSecurityGroupsIDs=[
        'string',
    ],
    replicationServerInstanceType='string',
    useDedicatedReplicationServer=True|False,
    defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
    ebsEncryption='DEFAULT'|'CUSTOM',
    ebsEncryptionKeyArn='string',
    bandwidthThrottling=123,
    dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
    createPublicIP=True|False,
    stagingAreaTags={
        'string': 'string'
    },
    useFipsEndpoint=True|False,
    internetProtocol='IPV4'|'IPV6',
    storeSnapshotOnLocalZone=True|False,
    storageConfiguration={
        'storageType': 'EBS'|'FSX_ONTAP',
        'fsxOntapConfiguration': {
            'storageVirtualMachineId': 'string',
            'credentialsSecretArn': 'string'
        }
    }
)

type replicationConfigurationTemplateID:

string

param replicationConfigurationTemplateID:

[REQUIRED]

Update replication configuration template template ID request.

type arn:

string

param arn:

Update replication configuration template ARN request.

type stagingAreaSubnetId:

string

param stagingAreaSubnetId:

Update replication configuration template Staging Area subnet ID request.

type associateDefaultSecurityGroup:

boolean

param associateDefaultSecurityGroup:

Update replication configuration template associate default Application Migration Service Security group request.

type replicationServersSecurityGroupsIDs:

list

param replicationServersSecurityGroupsIDs:

Update replication configuration template Replication Server Security groups IDs request.

(string) --

type replicationServerInstanceType:

string

param replicationServerInstanceType:

Update replication configuration template Replication Server instance type request.

type useDedicatedReplicationServer:

boolean

param useDedicatedReplicationServer:

Update replication configuration template use dedicated Replication Server request.

type defaultLargeStagingDiskType:

string

param defaultLargeStagingDiskType:

Update replication configuration template use default large Staging Disk type request.

type ebsEncryption:

string

param ebsEncryption:

Update replication configuration template EBS encryption request.

type ebsEncryptionKeyArn:

string

param ebsEncryptionKeyArn:

Update replication configuration template EBS encryption key ARN request.

type bandwidthThrottling:

integer

param bandwidthThrottling:

Update replication configuration template bandwidth throttling request.

type dataPlaneRouting:

string

param dataPlaneRouting:

Update replication configuration template data plane routing request.

type createPublicIP:

boolean

param createPublicIP:

Update replication configuration template create Public IP request.

type stagingAreaTags:

dict

param stagingAreaTags:

Update replication configuration template Staging Area Tags request.

(string) --
- (string) --

type useFipsEndpoint:

boolean

param useFipsEndpoint:

Update replication configuration template use Fips Endpoint request.

type internetProtocol:

string

param internetProtocol:

Update replication configuration template internet protocol request.

type storeSnapshotOnLocalZone:

boolean

param storeSnapshotOnLocalZone:

Update replication configuration template store snapshot on local zone request.

type storageConfiguration:

dict

param storageConfiguration:

Update replication configuration template storage configuration request.

storageType (string) -- [REQUIRED]

Storage configuration storage type.
fsxOntapConfiguration (dict) --

Storage configuration FSx ONTAP configuration.
- storageVirtualMachineId (string) -- [REQUIRED]
  
  FSx ONTAP configuration storage virtual machine ID.
- credentialsSecretArn (string) -- [REQUIRED]
  
  FSx ONTAP configuration credentials secret ARN.

rtype:

dict

returns:

Response Syntax

{
    'replicationConfigurationTemplateID': 'string',
    'arn': 'string',
    'stagingAreaSubnetId': 'string',
    'associateDefaultSecurityGroup': True|False,
    'replicationServersSecurityGroupsIDs': [
        'string',
    ],
    'replicationServerInstanceType': 'string',
    'useDedicatedReplicationServer': True|False,
    'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
    'ebsEncryption': 'DEFAULT'|'CUSTOM',
    'ebsEncryptionKeyArn': 'string',
    'bandwidthThrottling': 123,
    'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
    'createPublicIP': True|False,
    'stagingAreaTags': {
        'string': 'string'
    },
    'useFipsEndpoint': True|False,
    'tags': {
        'string': 'string'
    },
    'internetProtocol': 'IPV4'|'IPV6',
    'storeSnapshotOnLocalZone': True|False,
    'storageConfiguration': {
        'storageType': 'EBS'|'FSX_ONTAP',
        'fsxOntapConfiguration': {
            'storageVirtualMachineId': 'string',
            'credentialsSecretArn': 'string'
        }
    }
}

Response Structure

(dict) --
- replicationConfigurationTemplateID (string) --
  
  Replication Configuration template ID.
- arn (string) --
  
  Replication Configuration template ARN.
- stagingAreaSubnetId (string) --
  
  Replication Configuration template Staging Area subnet ID.
- associateDefaultSecurityGroup (boolean) --
  
  Replication Configuration template associate default Application Migration Service Security group.
- replicationServersSecurityGroupsIDs (list) --
  
  Replication Configuration template server Security Groups IDs.
  - (string) --
- replicationServerInstanceType (string) --
  
  Replication Configuration template server instance type.
- useDedicatedReplicationServer (boolean) --
  
  Replication Configuration template use Dedicated Replication Server.
- defaultLargeStagingDiskType (string) --
  
  Replication Configuration template use default large Staging Disk type.
- ebsEncryption (string) --
  
  Replication Configuration template EBS encryption.
- ebsEncryptionKeyArn (string) --
  
  Replication Configuration template EBS encryption key ARN.
- bandwidthThrottling (integer) --
  
  Replication Configuration template bandwidth throttling.
- dataPlaneRouting (string) --
  
  Replication Configuration template data plane routing.
- createPublicIP (boolean) --
  
  Replication Configuration template create Public IP.
- stagingAreaTags (dict) --
  
  Replication Configuration template Staging Area Tags.
  - (string) --
    - (string) --
- useFipsEndpoint (boolean) --
  
  Replication Configuration template use Fips Endpoint.
- tags (dict) --
  
  Replication Configuration template Tags.
  - (string) --
    - (string) --
- internetProtocol (string) --
  
  Replication Configuration template internet protocol.
- storeSnapshotOnLocalZone (boolean) --
  
  Replication Configuration template store snapshot on local zone.
- storageConfiguration (dict) --
  
  Replication Configuration template storage configuration.
  - storageType (string) --
    
    Storage configuration storage type.
  - fsxOntapConfiguration (dict) --
    
    Storage configuration FSx ONTAP configuration.
    - storageVirtualMachineId (string) --
      
      FSx ONTAP configuration storage virtual machine ID.
    - credentialsSecretArn (string) --
      
      FSx ONTAP configuration credentials secret ARN.

UpdateSourceServer (updated)

Link ¶
Changes (request, response)
Request

{'fqdnForActionFramework': 'string',
 'platform': 'string',
 'userProvidedID': 'string'}

Response

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

Update Source Server.

See also: AWS API Documentation

Request Syntax

client.update_source_server(
    accountID='string',
    sourceServerID='string',
    connectorAction={
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    },
    userProvidedID='string',
    fqdnForActionFramework='string',
    platform='string'
)

type accountID:

string

param accountID:

Update Source Server request account ID.

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Update Source Server request source server ID.

type connectorAction:

dict

param connectorAction:

Update Source Server request connector action.

credentialsSecretArn (string) --

Source Server connector action credentials secret arn.
connectorArn (string) --

Source Server connector action connector arn.

type userProvidedID:

string

param userProvidedID:

Update Source Server request user provided ID.

type fqdnForActionFramework:

string

param fqdnForActionFramework:

Update Source Server request FQDN for action framework.

type platform:

string

param platform:

Update Source Server request platform operating system.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.

UpdateSourceServerReplicationType (updated)

Link ¶
Changes (response)

{'dataReplicationInfo': {'dataReplicationError': {'error': {'FAILED_TO_CREATE_FSX_SNAPSHOT',
                                                            'FAILED_TO_SETUP_FSX_PROXY'}},
                         'dataReplicationInitiation': {'steps': {'name': {'SETUP_FSX_PROXY'}}}},
 'launchedInstance': {'lastKnownChecks': [{'checkedAt': 'timestamp',
                                           'error': 'string',
                                           'name': 'string',
                                           'status': 'PASSED | FAILED | '
                                                     'PENDING',
                                           'type': 'EC2 | FSx'}],
                      'lastKnownFsxChecksStatus': 'PASSED | FAILED | PENDING'}}

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

SNAPSHOT_SHIPPING should be used for agentless replication.

See also: AWS API Documentation

Request Syntax

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

type sourceServerID:

string

param sourceServerID:

[REQUIRED]

ID of source server on which to update replication type.

type replicationType:

string

param replicationType:

[REQUIRED]

Replication type to which to update source server.

type accountID:

string

param accountID:

Account ID on which to update replication type.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'arn': 'string',
    'isArchived': True|False,
    'tags': {
        'string': 'string'
    },
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'jobID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'lastKnownChecks': [
            {
                'type': 'EC2'|'FSx',
                'name': 'string',
                'status': 'PASSED'|'FAILED'|'PENDING',
                'error': 'string',
                'checkedAt': datetime(2015, 1, 1)
            },
        ],
        'lastKnownFsxChecksStatus': 'PASSED'|'FAILED'|'PENDING'
    },
    'dataReplicationInfo': {
        'lagDuration': 'string',
        'etaDateTime': 'string',
        'replicatedDisks': [
            {
                'deviceName': 'string',
                'totalStorageBytes': 123,
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'backloggedStorageBytes': 123
            },
        ],
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'dataReplicationInitiation': {
            'startDateTime': 'string',
            'nextAttemptDateTime': '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'|'SETUP_FSX_PROXY',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        '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'|'FAILED_TO_SETUP_FSX_PROXY'|'FAILED_TO_CREATE_FSX_SNAPSHOT',
            'rawError': 'string'
        },
        'lastSnapshotDateTime': 'string',
        'replicatorId': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'firstByteDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'lastCutover': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            },
            'finalized': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'sourceProperties': {
        'lastUpdatedDateTime': 'string',
        'recommendedInstanceType': 'string',
        'identificationHints': {
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string',
            'awsInstanceID': 'string',
            'vmPath': 'string'
        },
        'networkInterfaces': [
            {
                'macAddress': 'string',
                'ips': [
                    'string',
                ],
                'isPrimary': True|False
            },
        ],
        'disks': [
            {
                'deviceName': 'string',
                'bytes': 123
            },
        ],
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'ramBytes': 123,
        'os': {
            'fullString': 'string'
        }
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'vcenterClientID': 'string',
    'applicationID': 'string',
    'userProvidedID': 'string',
    'fqdnForActionFramework': 'string',
    'connectorAction': {
        'credentialsSecretArn': 'string',
        'connectorArn': 'string'
    }
}

Response Structure

(dict) --
- sourceServerID (string) --
  
  Source server ID.
- arn (string) --
  
  Source server ARN.
- isArchived (boolean) --
  
  Source server archived status.
- tags (dict) --
  
  Source server Tags.
  - (string) --
    - (string) --
- launchedInstance (dict) --
  
  Source server launched instance.
  - ec2InstanceID (string) --
    
    Launched instance EC2 ID.
  - jobID (string) --
    
    Launched instance Job ID.
  - firstBoot (string) --
    
    Launched instance first boot.
  - lastKnownChecks (list) --
    
    Launched instance last known checks.
    - (dict) --
      
      Last known check performed on a launched instance.
      - type (string) --
        
        Last known check type.
      - name (string) --
        
        Last known check name.
      - status (string) --
        
        Last known check status.
      - error (string) --
        
        Last known check error.
      - checkedAt (datetime) --
        
        Last known check timestamp.
  - lastKnownFsxChecksStatus (string) --
    
    Launched instance last known FSx checks status.
- dataReplicationInfo (dict) --
  
  Source server data replication info.
  - lagDuration (string) --
    
    Request to query data replication lag duration.
  - etaDateTime (string) --
    
    Request to query the time when data replication will be complete.
  - replicatedDisks (list) --
    
    Request to query disks replicated.
    - (dict) --
      
      Request to query disks replicated.
      - deviceName (string) --
        
        Request to query device name.
      - totalStorageBytes (integer) --
        
        Request to query total amount of data replicated in bytes.
      - replicatedStorageBytes (integer) --
        
        Request to query amount of data replicated in bytes.
      - rescannedStorageBytes (integer) --
        
        Request to query amount of data rescanned in bytes.
      - backloggedStorageBytes (integer) --
        
        Request to query data replication backlog size in bytes.
  - dataReplicationState (string) --
    
    Request to query the data replication state.
  - dataReplicationInitiation (dict) --
    
    Request to query whether data replication has been initiated.
    - startDateTime (string) --
      
      Request to query data initiation start date and time.
    - nextAttemptDateTime (string) --
      
      Request to query next data initiation date and time.
    - steps (list) --
      
      Request to query data initiation steps.
      - (dict) --
        
        Data replication initiation step.
        
        name (string) --
        
        Request to query data initiation step name.
        
        status (string) --
        
        Request to query data initiation status.
  - dataReplicationError (dict) --
    
    Error in obtaining data replication info.
    - error (string) --
      
      Error in data replication.
    - rawError (string) --
      
      Error in data replication.
  - lastSnapshotDateTime (string) --
    
    Request to query data replication last snapshot time.
  - replicatorId (string) --
    
    Replication server instance ID.
- lifeCycle (dict) --
  
  Source server lifecycle state.
  - addedToServiceDateTime (string) --
    
    Lifecycle added to service data and time.
  - firstByteDateTime (string) --
    
    Lifecycle replication initiation date and time.
  - elapsedReplicationDuration (string) --
    
    Lifecycle elapsed time and duration.
  - lastSeenByServiceDateTime (string) --
    
    Lifecycle last seen date and time.
  - lastTest (dict) --
    
    Lifecycle last Test.
    - 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.
    - finalized (dict) --
      
      Lifecycle last Test finalized.
      - apiCallDateTime (string) --
        
        Lifecycle Test failed API call date and time.
  - lastCutover (dict) --
    
    Lifecycle last Cutover.
    - 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.
    - finalized (dict) --
      
      Lifecycle Cutover finalized date and time.
      - apiCallDateTime (string) --
        
        Lifecycle Cutover finalized date and time.
  - state (string) --
    
    Lifecycle state.
- sourceProperties (dict) --
  
  Source server properties.
  - lastUpdatedDateTime (string) --
    
    Source server last update date and time.
  - recommendedInstanceType (string) --
    
    Source server recommended instance type.
  - identificationHints (dict) --
    
    Source server identification hints.
    - fqdn (string) --
      
      FQDN address identification hint.
    - hostname (string) --
      
      Hostname identification hint.
    - vmWareUuid (string) --
      
      vmWare UUID identification hint.
    - awsInstanceID (string) --
      
      AWS Instance ID identification hint.
    - vmPath (string) --
      
      vCenter VM path identification hint.
  - networkInterfaces (list) --
    
    Source server network interfaces.
    - (dict) --
      
      Network interface.
      - macAddress (string) --
        
        Network interface Mac address.
      - ips (list) --
        
        Network interface IPs.
        
        (string) --
      - isPrimary (boolean) --
        
        Network interface primary IP.
  - disks (list) --
    
    Source Server disks.
    - (dict) --
      
      The disk identifier.
      - deviceName (string) --
        
        The disk or device name.
      - bytes (integer) --
        
        The amount of storage on the disk in bytes.
  - 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.
  - ramBytes (integer) --
    
    Source server RAM in bytes.
  - os (dict) --
    
    Source server OS.
    - fullString (string) --
      
      OS full string.
- replicationType (string) --
  
  Source server replication type.
- vcenterClientID (string) --
  
  Source server vCenter client id.
- applicationID (string) --
  
  Source server application ID.
- userProvidedID (string) --
  
  Source server user provided ID.
- fqdnForActionFramework (string) --
  
  Source server fqdn for action framework.
- connectorAction (dict) --
  
  Source Server connector action.
  - credentialsSecretArn (string) --
    
    Source Server connector action credentials secret arn.
  - connectorArn (string) --
    
    Source Server connector action connector arn.