Application Migration Service

2026/11/17 - Application Migration Service - 11 new 29 updated api methods

Changes  AWS Transform adds Express Migration for MAP, remote source actions, per-server default launch settings, F5 BIG-IP to Elastic Load Balancing migration, AWS Outposts support, greenfield network design, and replication of volumes up to 64 TB.

DeleteRemoteSourceAction (new) Link ¶

Deletes a source action. This operation also deletes the invocation results of the source action.

See also: AWS API Documentation

Request Syntax

client.delete_remote_source_action(
    remoteSourceActionID='string',
    accountID='string'
)
type remoteSourceActionID:

string

param remoteSourceActionID:

[REQUIRED]

The unique identifier of the source action to delete.

type accountID:

string

param accountID:

Account ID.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

StartRemoteSourceActionJob (new) Link ¶

Starts a job that runs a source action on source servers through a connector.

See also: AWS API Documentation

Request Syntax

client.start_remote_source_action_job(
    remoteSourceActionArns=[
        'string',
    ],
    connectorArn='string',
    sourceServerArns=[
        'string',
    ],
    clientToken='string',
    tags={
        'string': 'string'
    },
    accountID='string'
)
type remoteSourceActionArns:

list

param remoteSourceActionArns:

[REQUIRED]

The ARNs of the source actions to run.

  • (string) --

type connectorArn:

string

param connectorArn:

[REQUIRED]

The ARN of the connector that runs the source actions.

type sourceServerArns:

list

param sourceServerArns:

[REQUIRED]

The ARNs of the source servers to run the source actions on.

  • (string) --

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type tags:

dict

param tags:

Tags to assign to the job.

  • (string) --

    • (string) --

type accountID:

string

param accountID:

Account ID.

rtype:

dict

returns:

Response Syntax

{
    'remoteSourceActionJob': {
        'remoteSourceActionJobID': 'string',
        'arn': 'string',
        'status': 'PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'STALLED',
        'sourceServerArns': [
            'string',
        ],
        'remoteSourceActionArns': [
            'string',
        ],
        'connectorArn': 'string',
        'startedAt': datetime(2015, 1, 1),
        'endedAt': datetime(2015, 1, 1),
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • remoteSourceActionJob (dict) --

      The job that was started.

      • remoteSourceActionJobID (string) --

        The unique identifier of the job.

      • arn (string) --

        The Amazon Resource Name (ARN) of the job.

      • status (string) --

        The current status of the job.

      • sourceServerArns (list) --

        The ARNs of the source servers that the job runs on.

        • (string) --

      • remoteSourceActionArns (list) --

        The ARNs of the source actions that the job runs.

        • (string) --

      • connectorArn (string) --

        The ARN of the connector that runs the job.

      • startedAt (datetime) --

        The timestamp when the job started running.

      • endedAt (datetime) --

        The timestamp when the job completed or failed.

      • statusReason (string) --

        The reason the job failed.

      • tags (dict) --

        Tags assigned to the job.

        • (string) --

          • (string) --

ListNetworkMigrationInsights (new) Link ¶

Lists network migration insights for a network migration definition.

See also: AWS API Documentation

Request Syntax

client.list_network_migration_insights(
    networkMigrationDefinitionID='string',
    networkMigrationExecutionID='string',
    producerID='string',
    segmentID='string',
    constructID='string',
    filters={
        'insightTypes': [
            'INTENT_GAP'|'WARNING'|'QUESTION'|'INFO'|'ERROR'|'CONTEXT'|'EXCLUDED'|'BEHAVIOR_CHANGE',
        ]
    },
    maxResults=123,
    nextToken='string'
)
type networkMigrationDefinitionID:

string

param networkMigrationDefinitionID:

[REQUIRED]

The unique identifier of the network migration definition.

type networkMigrationExecutionID:

string

param networkMigrationExecutionID:

The unique identifier of the network migration execution to narrow the results to.

type producerID:

string

param producerID:

The identifier of the job or API request to narrow the results to.

type segmentID:

string

param segmentID:

The unique identifier of the segment to narrow the results to.

type constructID:

string

param constructID:

The unique identifier of the construct to narrow the results to.

type filters:

dict

param filters:

Filters to apply when listing insights.

  • insightTypes (list) --

    The insight types to include in the results.

    • (string) --

      The type of a network migration insight.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'networkMigrationDefinitionID': 'string',
            'networkMigrationExecutionID': 'string',
            'producerID': 'string',
            'producerType': 'JOB'|'API',
            'producerName': 'MAPPING'|'MAPPING_UPDATE'|'CODE_GENERATION'|'DEPLOY'|'DEPLOYED_STACKS_DELETION'|'ANALYZE',
            'segmentID': 'string',
            'constructID': 'string',
            'insightID': 'string',
            'insightLevel': 'RUN'|'SEGMENT'|'CONSTRUCT',
            'insightType': 'INTENT_GAP'|'WARNING'|'QUESTION'|'INFO'|'ERROR'|'CONTEXT'|'EXCLUDED'|'BEHAVIOR_CHANGE',
            'insightMessage': {
                'code': 'string',
                'message': 'string',
                'topic': 'string'
            },
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of network migration insights.

      • (dict) --

        An insight produced during a network migration, such as a warning, decision, question, or other context beyond the migrated output.

        • networkMigrationDefinitionID (string) --

          The unique identifier of the network migration definition the insight belongs to.

        • networkMigrationExecutionID (string) --

          The unique identifier of the network migration execution the insight belongs to.

        • producerID (string) --

          The identifier of the job or API request that produced the insight.

        • producerType (string) --

          Whether the insight was produced by a job or by an API request.

        • producerName (string) --

          The job type or API name that produced the insight.

        • segmentID (string) --

          The unique identifier of the segment the insight relates to; absent for run-level insights.

        • constructID (string) --

          The unique identifier of the construct the insight relates to; absent for run-level and segment-level insights.

        • insightID (string) --

          The unique identifier of the insight.

        • insightLevel (string) --

          The level that the insight applies to: the run, a segment, or a construct.

        • insightType (string) --

          The type of the insight.

        • insightMessage (dict) --

          The content of the insight.

          • code (string) --

            A stable identifier for the kind of insight.

          • message (string) --

            The human-readable insight message.

          • topic (string) --

            The topic that the insight relates to.

        • createdAt (datetime) --

          The timestamp when the insight was created.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ListRemoteSourceActionInvocations (new) Link ¶

Lists the invocations of a source action job, one for each source server and source action, with optional filtering.

See also: AWS API Documentation

Request Syntax

client.list_remote_source_action_invocations(
    remoteSourceActionJobID='string',
    filters={
        'sourceServerArns': [
            'string',
        ],
        'remoteSourceActionArns': [
            'string',
        ],
        'statuses': [
            'PENDING'|'IN_PROGRESS'|'DELAYED'|'SUCCESS'|'CANCELLED'|'TIMED_OUT'|'FAILED'|'CANCELLING'|'STALLED',
        ]
    },
    maxResults=123,
    nextToken='string',
    accountID='string'
)
type remoteSourceActionJobID:

string

param remoteSourceActionJobID:

[REQUIRED]

The unique identifier of the job to list invocations for.

type filters:

dict

param filters:

Filters to apply when listing invocations, such as source server or status.

  • sourceServerArns (list) --

    A list of source server ARNs to filter by.

    • (string) --

  • remoteSourceActionArns (list) --

    A list of source action ARNs to filter by.

    • (string) --

  • statuses (list) --

    A list of invocation statuses to filter by.

    • (string) --

      The status of a source action invocation. Can be PENDING, IN_PROGRESS, DELAYED, SUCCESS, CANCELLED, TIMED_OUT, FAILED, CANCELLING, or STALLED.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

The token for the next page of results.

type accountID:

string

param accountID:

Account ID.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'sourceServerArn': 'string',
            'remoteSourceActionArn': 'string',
            'ssmCommandInvocationID': 'string',
            'status': 'PENDING'|'IN_PROGRESS'|'DELAYED'|'SUCCESS'|'CANCELLED'|'TIMED_OUT'|'FAILED'|'CANCELLING'|'STALLED',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of source action invocations.

      • (dict) --

        The run of a source action on one source server as part of a job.

        • sourceServerArn (string) --

          The ARN of the source server.

        • remoteSourceActionArn (string) --

          The ARN of the source action.

        • ssmCommandInvocationID (string) --

          The ID of the AWS Systems Manager command that runs the source action on the connector.

        • status (string) --

          The current status of the invocation.

        • startedAt (datetime) --

          The timestamp when the command started running.

        • endedAt (datetime) --

          The timestamp when the command finished.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ListRemoteSourceActionInvocationResults (new) Link ¶

Lists the latest invocation result of each source action that ran on a source server.

See also: AWS API Documentation

Request Syntax

client.list_remote_source_action_invocation_results(
    sourceServerID='string',
    maxResults=123,
    nextToken='string',
    accountID='string'
)
type sourceServerID:

string

param sourceServerID:

[REQUIRED]

The unique identifier of the source server to list invocation results for.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

The token for the next page of results.

type accountID:

string

param accountID:

Account ID.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'remoteSourceActionID': 'string',
            'connectorOwnerAccountID': 'string',
            'status': 'PENDING'|'IN_PROGRESS'|'DELAYED'|'SUCCESS'|'CANCELLED'|'TIMED_OUT'|'FAILED'|'CANCELLING'|'STALLED',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of source action invocation results.

      • (dict) --

        The latest invocation result of a source action on a source server.

        • remoteSourceActionID (string) --

          The unique identifier of the source action.

        • connectorOwnerAccountID (string) --

          The ID of the account that owns the connector that ran the source action.

        • status (string) --

          The status of the latest invocation.

        • startedAt (datetime) --

          The timestamp when the command started running.

        • endedAt (datetime) --

          The timestamp when the command finished.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

GetLaunchConfigurationDefaults (new) Link ¶

Gets the launch configuration defaults of a source server: the Amazon Elastic Block Store (Amazon EBS) volume configuration used for the disk mappings created later in the source server's Amazon Elastic Compute Cloud (Amazon EC2) launch template.

See also: AWS API Documentation

Request Syntax

client.get_launch_configuration_defaults(
    sourceServerID='string',
    accountID='string'
)
type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Request to get the launch configuration defaults by Source Server ID.

type accountID:

string

param accountID:

Request to get the launch configuration defaults by Account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'smallVolumeMaxSize': 123,
    'smallVolumeConfiguration': {
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': 'ENABLED'|'DISABLED'
    },
    'largeVolumeConfiguration': {
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': 'ENABLED'|'DISABLED'
    }
}

Response Structure

  • (dict) --

    • sourceServerID (string) --

      Source Server ID of the launch configuration defaults.

    • smallVolumeMaxSize (integer) --

      Disks up to this size, in GiB, use the small volume configuration, and larger disks use the large one. 0 means every disk uses the large one.

    • smallVolumeConfiguration (dict) --

      Volume configuration for disks up to smallVolumeMaxSize. Omitted when none of its fields is set.

      • volumeType (string) --

        EBS volume type.

      • iops (integer) --

        Provisioned IOPS, for io1, io2 and gp3 volumes.

      • throughput (integer) --

        Throughput in MiB/s, for gp3 volumes only.

      • volumeInitializationRate (integer) --

        Provisioned rate for volume initialization, in MiB/s.

      • deleteOnTermination (string) --

        Specifies whether the volume is deleted when the launched instance terminates.

    • largeVolumeConfiguration (dict) --

      Volume configuration for disks larger than smallVolumeMaxSize. Omitted when none of its fields is set.

      • volumeType (string) --

        EBS volume type.

      • iops (integer) --

        Provisioned IOPS, for io1, io2 and gp3 volumes.

      • throughput (integer) --

        Throughput in MiB/s, for gp3 volumes only.

      • volumeInitializationRate (integer) --

        Provisioned rate for volume initialization, in MiB/s.

      • deleteOnTermination (string) --

        Specifies whether the volume is deleted when the launched instance terminates.

ListRemoteSourceActionJobs (new) Link ¶

Lists the source action jobs in the account, with optional filtering.

See also: AWS API Documentation

Request Syntax

client.list_remote_source_action_jobs(
    filters={
        'remoteSourceActionJobIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string',
    accountID='string'
)
type filters:

dict

param filters:

Filters to apply when listing source action jobs.

  • remoteSourceActionJobIDs (list) --

    A list of job IDs to filter by.

    • (string) --

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

The token for the next page of results.

type accountID:

string

param accountID:

Account ID.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'remoteSourceActionJobID': 'string',
            'arn': 'string',
            'status': 'PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'STALLED',
            'sourceServerArns': [
                'string',
            ],
            'remoteSourceActionArns': [
                'string',
            ],
            'connectorArn': 'string',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'statusReason': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of source action jobs.

      • (dict) --

        A job that runs a source action on source servers through a connector.

        • remoteSourceActionJobID (string) --

          The unique identifier of the job.

        • arn (string) --

          The Amazon Resource Name (ARN) of the job.

        • status (string) --

          The current status of the job.

        • sourceServerArns (list) --

          The ARNs of the source servers that the job runs on.

          • (string) --

        • remoteSourceActionArns (list) --

          The ARNs of the source actions that the job runs.

          • (string) --

        • connectorArn (string) --

          The ARN of the connector that runs the job.

        • startedAt (datetime) --

          The timestamp when the job started running.

        • endedAt (datetime) --

          The timestamp when the job completed or failed.

        • statusReason (string) --

          The reason the job failed.

        • tags (dict) --

          Tags assigned to the job.

          • (string) --

            • (string) --

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ListRemoteSourceActions (new) Link ¶

Lists the source actions in the account, with optional filtering.

See also: AWS API Documentation

Request Syntax

client.list_remote_source_actions(
    filters={
        'remoteSourceActionIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string',
    accountID='string'
)
type filters:

dict

param filters:

Filters to apply when listing source actions.

  • remoteSourceActionIDs (list) --

    A list of source action IDs to filter by.

    • (string) --

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

The token for the next page of results.

type accountID:

string

param accountID:

Account ID.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'remoteSourceActionID': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'ssmParameterName': 'string',
            'timeoutSeconds': 123,
            'operatingSystem': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of source actions.

      • (dict) --

        A source action, which references a script in AWS Systems Manager Parameter Store that Application Migration Service runs on source servers through a connector.

        • remoteSourceActionID (string) --

          The unique identifier of the source action.

        • arn (string) --

          The Amazon Resource Name (ARN) of the source action.

        • name (string) --

          The name of the source action.

        • description (string) --

          A description of the source action.

        • ssmParameterName (string) --

          AWS Systems Manager Parameter Store parameter name.

        • timeoutSeconds (integer) --

          The maximum time, in seconds, that the script can run on each source server.

        • operatingSystem (string) --

          The operating system of the source servers that the script runs on. Absent when the script runs on both Linux and Windows.

        • tags (dict) --

          Tags assigned to the source action.

          • (string) --

            • (string) --

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

UpdateLaunchConfigurationDefaults (new) Link ¶

Updates the launch configuration defaults of a source server. They apply only to disk mappings created later in the source server's Amazon Elastic Compute Cloud (Amazon EC2) launch template, and members you omit keep their current values.

See also: AWS API Documentation

Request Syntax

client.update_launch_configuration_defaults(
    sourceServerID='string',
    accountID='string',
    smallVolumeMaxSize=123,
    smallVolumeConfiguration={
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': 'ENABLED'|'DISABLED'
    },
    largeVolumeConfiguration={
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': 'ENABLED'|'DISABLED'
    }
)
type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Request to update the launch configuration defaults by Source Server ID.

type accountID:

string

param accountID:

Request to update the launch configuration defaults by Account ID.

type smallVolumeMaxSize:

integer

param smallVolumeMaxSize:

Disks up to this size, in GiB, use the small volume configuration, and larger disks use the large one. 0 means every disk uses the large one. If you omit it, the current value is kept.

type smallVolumeConfiguration:

dict

param smallVolumeConfiguration:

Volume configuration for disks up to smallVolumeMaxSize. If you omit it, the current one is kept. If you send it, it replaces the current one: fields you omit are cleared, and an empty configuration, {}, clears all of them.

  • volumeType (string) --

    EBS volume type.

  • iops (integer) --

    Provisioned IOPS, for io1, io2 and gp3 volumes.

  • throughput (integer) --

    Throughput in MiB/s, for gp3 volumes only.

  • volumeInitializationRate (integer) --

    Provisioned rate for volume initialization, in MiB/s.

  • deleteOnTermination (string) --

    Specifies whether the volume is deleted when the launched instance terminates.

type largeVolumeConfiguration:

dict

param largeVolumeConfiguration:

Volume configuration for disks larger than smallVolumeMaxSize. If you omit it, the current one is kept. If you send it, it replaces the current one: fields you omit are cleared, and an empty configuration, {}, clears all of them.

  • volumeType (string) --

    EBS volume type.

  • iops (integer) --

    Provisioned IOPS, for io1, io2 and gp3 volumes.

  • throughput (integer) --

    Throughput in MiB/s, for gp3 volumes only.

  • volumeInitializationRate (integer) --

    Provisioned rate for volume initialization, in MiB/s.

  • deleteOnTermination (string) --

    Specifies whether the volume is deleted when the launched instance terminates.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'smallVolumeMaxSize': 123,
    'smallVolumeConfiguration': {
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': 'ENABLED'|'DISABLED'
    },
    'largeVolumeConfiguration': {
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': 'ENABLED'|'DISABLED'
    }
}

Response Structure

  • (dict) --

    • sourceServerID (string) --

      Source Server ID of the launch configuration defaults.

    • smallVolumeMaxSize (integer) --

      Disks up to this size, in GiB, use the small volume configuration, and larger disks use the large one. 0 means every disk uses the large one.

    • smallVolumeConfiguration (dict) --

      Volume configuration for disks up to smallVolumeMaxSize. Omitted when none of its fields is set.

      • volumeType (string) --

        EBS volume type.

      • iops (integer) --

        Provisioned IOPS, for io1, io2 and gp3 volumes.

      • throughput (integer) --

        Throughput in MiB/s, for gp3 volumes only.

      • volumeInitializationRate (integer) --

        Provisioned rate for volume initialization, in MiB/s.

      • deleteOnTermination (string) --

        Specifies whether the volume is deleted when the launched instance terminates.

    • largeVolumeConfiguration (dict) --

      Volume configuration for disks larger than smallVolumeMaxSize. Omitted when none of its fields is set.

      • volumeType (string) --

        EBS volume type.

      • iops (integer) --

        Provisioned IOPS, for io1, io2 and gp3 volumes.

      • throughput (integer) --

        Throughput in MiB/s, for gp3 volumes only.

      • volumeInitializationRate (integer) --

        Provisioned rate for volume initialization, in MiB/s.

      • deleteOnTermination (string) --

        Specifies whether the volume is deleted when the launched instance terminates.

CreateRemoteSourceAction (new) Link ¶

Creates a source action, which references a script in AWS Systems Manager Parameter Store that Application Migration Service runs on source environment.

See also: AWS API Documentation

Request Syntax

client.create_remote_source_action(
    name='string',
    description='string',
    ssmParameterName='string',
    timeoutSeconds=123,
    operatingSystem='string',
    tags={
        'string': 'string'
    },
    accountID='string'
)
type name:

string

param name:

[REQUIRED]

The name of the source action.

type description:

string

param description:

A description of the source action.

type ssmParameterName:

string

param ssmParameterName:

[REQUIRED]

AWS Systems Manager Parameter Store parameter name.

type timeoutSeconds:

integer

param timeoutSeconds:

The maximum time, in seconds, that the script can run on each source server.

type operatingSystem:

string

param operatingSystem:

The operating system of the source servers that the script runs on. Set to linux or windows to run the script only on source servers with that operating system, or all to run it on both.

type tags:

dict

param tags:

Tags to assign to the source action.

  • (string) --

    • (string) --

type accountID:

string

param accountID:

Account ID.

rtype:

dict

returns:

Response Syntax

{
    'remoteSourceActionID': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'ssmParameterName': 'string',
    'timeoutSeconds': 123,
    'operatingSystem': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • remoteSourceActionID (string) --

      The unique identifier of the source action.

    • arn (string) --

      The Amazon Resource Name (ARN) of the source action.

    • name (string) --

      The name of the source action.

    • description (string) --

      A description of the source action.

    • ssmParameterName (string) --

      AWS Systems Manager Parameter Store parameter name.

    • timeoutSeconds (integer) --

      The maximum time, in seconds, that the script can run on each source server.

    • operatingSystem (string) --

      The operating system of the source servers that the script runs on. Absent when the script runs on both Linux and Windows.

    • tags (dict) --

      Tags assigned to the source action.

      • (string) --

        • (string) --

UpdateRemoteSourceAction (new) Link ¶

Updates a source action.

See also: AWS API Documentation

Request Syntax

client.update_remote_source_action(
    remoteSourceActionID='string',
    name='string',
    description='string',
    ssmParameterName='string',
    timeoutSeconds=123,
    operatingSystem='string',
    accountID='string'
)
type remoteSourceActionID:

string

param remoteSourceActionID:

[REQUIRED]

The unique identifier of the source action to update.

type name:

string

param name:

The updated name of the source action.

type description:

string

param description:

The updated description of the source action.

type ssmParameterName:

string

param ssmParameterName:

AWS Systems Manager Parameter Store parameter name.

type timeoutSeconds:

integer

param timeoutSeconds:

The updated maximum time, in seconds, that the script can run on each source server.

type operatingSystem:

string

param operatingSystem:

The updated operating system of the source servers that the script runs on. Set to linux or windows to run the script only on source servers with that operating system, or all to run it on both.

type accountID:

string

param accountID:

Account ID.

rtype:

dict

returns:

Response Syntax

{
    'remoteSourceActionID': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'ssmParameterName': 'string',
    'timeoutSeconds': 123,
    'operatingSystem': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • remoteSourceActionID (string) --

      The unique identifier of the source action.

    • arn (string) --

      The Amazon Resource Name (ARN) of the source action.

    • name (string) --

      The name of the source action.

    • description (string) --

      A description of the source action.

    • ssmParameterName (string) --

      AWS Systems Manager Parameter Store parameter name.

    • timeoutSeconds (integer) --

      The maximum time, in seconds, that the script can run on each source server.

    • operatingSystem (string) --

      The operating system of the source servers that the script runs on. Absent when the script runs on both Linux and Windows.

    • tags (dict) --

      Tags assigned to the source action.

      • (string) --

        • (string) --

ChangeServerLifeCycleState (updated) Link ¶
Changes (response)
{'dataReplicationInfo': {'stagingOutpostArn': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.change_server_life_cycle_state(
    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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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.

CreateLaunchConfigurationTemplate (updated) Link ¶
Changes (both)
{'mapAutoTaggingKey': 'string'}

Creates a new Launch Configuration Template.

See also: AWS API Documentation

Request Syntax

client.create_launch_configuration_template(
    postLaunchActions={
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'cloudWatchLogGroupName': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123,
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterType': 'STRING'|'SECURE_STRING',
                            'parameterName': 'string'
                        },
                    ]
                },
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                }
            },
        ]
    },
    enableMapAutoTagging=True|False,
    mapAutoTaggingMpeID='string',
    mapAutoTaggingKey='string',
    tags={
        'string': 'string'
    },
    launchDisposition='STOPPED'|'STARTED',
    targetInstanceTypeRightSizingMethod='NONE'|'BASIC',
    copyPrivateIp=True|False,
    associatePublicIpAddress=True|False,
    copyTags=True|False,
    licensing={
        'osByol': True|False
    },
    bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
    smallVolumeMaxSize=123,
    smallVolumeConf={
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': True|False
    },
    largeVolumeConf={
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': True|False
    },
    enableParametersEncryption=True|False,
    parametersEncryptionKey='string'
)
type postLaunchActions:

dict

param postLaunchActions:

Launch configuration template post launch actions.

  • deployment (string) --

    Deployment type in which AWS Systems Manager Documents will be executed.

  • s3LogBucket (string) --

    AWS Systems Manager Command's logs S3 log bucket.

  • s3OutputKeyPrefix (string) --

    AWS Systems Manager Command's logs S3 output key prefix.

  • cloudWatchLogGroupName (string) --

    AWS Systems Manager Command's CloudWatch log group name.

  • ssmDocuments (list) --

    AWS Systems Manager Documents.

    • (dict) --

      AWS Systems Manager Document.

      • actionName (string) -- [REQUIRED]

        User-friendly name for the AWS Systems Manager Document.

      • ssmDocumentName (string) -- [REQUIRED]

        AWS Systems Manager Document name or full ARN.

      • timeoutSeconds (integer) --

        AWS Systems Manager Document timeout seconds.

      • mustSucceedForCutover (boolean) --

        If true, Cutover will not be enabled if the document has failed.

      • parameters (dict) --

        AWS Systems Manager Document parameters.

        • (string) --

          • (list) --

            • (dict) --

              AWS Systems Manager Parameter Store parameter.

              • parameterType (string) -- [REQUIRED]

                AWS Systems Manager Parameter Store parameter type.

              • parameterName (string) -- [REQUIRED]

                AWS Systems Manager Parameter Store parameter name.

      • externalParameters (dict) --

        AWS Systems Manager Document external parameters.

        • (string) --

          • (dict) --

            AWS Systems Manager Document external parameter.

            • dynamicPath (string) --

              AWS Systems Manager Document external parameters dynamic path.

type enableMapAutoTagging:

boolean

param enableMapAutoTagging:

Enable map auto tagging.

type mapAutoTaggingMpeID:

string

param mapAutoTaggingMpeID:

Launch configuration template map auto tagging MPE ID.

type mapAutoTaggingKey:

string

param mapAutoTaggingKey:

Launch configuration template map auto tagging key.

type tags:

dict

param tags:

Request to associate tags during creation of a Launch Configuration Template.

  • (string) --

    • (string) --

type launchDisposition:

string

param launchDisposition:

Launch disposition.

type targetInstanceTypeRightSizingMethod:

string

param targetInstanceTypeRightSizingMethod:

Target instance type right-sizing method.

type copyPrivateIp:

boolean

param copyPrivateIp:

Copy private Ip.

type associatePublicIpAddress:

boolean

param associatePublicIpAddress:

Associate public Ip address.

type copyTags:

boolean

param copyTags:

Copy tags.

type licensing:

dict

param licensing:

Configure Licensing.

  • osByol (boolean) --

    Configure BYOL OS licensing.

type bootMode:

string

param bootMode:

Launch configuration template boot mode.

type smallVolumeMaxSize:

integer

param smallVolumeMaxSize:

Small volume maximum size.

type smallVolumeConf:

dict

param smallVolumeConf:

Small volume config.

  • volumeType (string) --

    Launch template disk volume type configuration.

  • iops (integer) --

    Launch template disk iops configuration.

  • throughput (integer) --

    Launch template disk throughput configuration.

  • volumeInitializationRate (integer) --

    Launch template disk volume initialization rate configuration.

  • deleteOnTermination (boolean) --

    Launch template disk delete on termination configuration.

type largeVolumeConf:

dict

param largeVolumeConf:

Large volume config.

  • volumeType (string) --

    Launch template disk volume type configuration.

  • iops (integer) --

    Launch template disk iops configuration.

  • throughput (integer) --

    Launch template disk throughput configuration.

  • volumeInitializationRate (integer) --

    Launch template disk volume initialization rate configuration.

  • deleteOnTermination (boolean) --

    Launch template disk delete on termination configuration.

type enableParametersEncryption:

boolean

param enableParametersEncryption:

Enable parameters encryption.

type parametersEncryptionKey:

string

param parametersEncryptionKey:

Parameters encryption key.

rtype:

dict

returns:

Response Syntax

{
    'launchConfigurationTemplateID': 'string',
    'arn': 'string',
    'postLaunchActions': {
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'cloudWatchLogGroupName': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123,
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterType': 'STRING'|'SECURE_STRING',
                            'parameterName': 'string'
                        },
                    ]
                },
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                }
            },
        ]
    },
    'enableMapAutoTagging': True|False,
    'mapAutoTaggingMpeID': 'string',
    'mapAutoTaggingKey': 'string',
    'tags': {
        'string': 'string'
    },
    'ec2LaunchTemplateID': 'string',
    'launchDisposition': 'STOPPED'|'STARTED',
    'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
    'copyPrivateIp': True|False,
    'associatePublicIpAddress': True|False,
    'copyTags': True|False,
    'licensing': {
        'osByol': True|False
    },
    'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
    'smallVolumeMaxSize': 123,
    'smallVolumeConf': {
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': True|False
    },
    'largeVolumeConf': {
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': True|False
    },
    'enableParametersEncryption': True|False,
    'parametersEncryptionKey': 'string'
}

Response Structure

  • (dict) --

    • launchConfigurationTemplateID (string) --

      ID of the Launch Configuration Template.

    • arn (string) --

      ARN of the Launch Configuration Template.

    • postLaunchActions (dict) --

      Post Launch Actions of the Launch Configuration Template.

      • deployment (string) --

        Deployment type in which AWS Systems Manager Documents will be executed.

      • s3LogBucket (string) --

        AWS Systems Manager Command's logs S3 log bucket.

      • s3OutputKeyPrefix (string) --

        AWS Systems Manager Command's logs S3 output key prefix.

      • cloudWatchLogGroupName (string) --

        AWS Systems Manager Command's CloudWatch log group name.

      • ssmDocuments (list) --

        AWS Systems Manager Documents.

        • (dict) --

          AWS Systems Manager Document.

          • actionName (string) --

            User-friendly name for the AWS Systems Manager Document.

          • ssmDocumentName (string) --

            AWS Systems Manager Document name or full ARN.

          • timeoutSeconds (integer) --

            AWS Systems Manager Document timeout seconds.

          • mustSucceedForCutover (boolean) --

            If true, Cutover will not be enabled if the document has failed.

          • parameters (dict) --

            AWS Systems Manager Document parameters.

            • (string) --

              • (list) --

                • (dict) --

                  AWS Systems Manager Parameter Store parameter.

                  • parameterType (string) --

                    AWS Systems Manager Parameter Store parameter type.

                  • parameterName (string) --

                    AWS Systems Manager Parameter Store parameter name.

          • externalParameters (dict) --

            AWS Systems Manager Document external parameters.

            • (string) --

              • (dict) --

                AWS Systems Manager Document external parameter.

                • dynamicPath (string) --

                  AWS Systems Manager Document external parameters dynamic path.

    • enableMapAutoTagging (boolean) --

      Enable map auto tagging.

    • mapAutoTaggingMpeID (string) --

      Launch configuration template map auto tagging MPE ID.

    • mapAutoTaggingKey (string) --

      Launch configuration template map auto tagging key.

    • tags (dict) --

      Tags of the Launch Configuration Template.

      • (string) --

        • (string) --

    • ec2LaunchTemplateID (string) --

      EC2 launch template ID.

    • launchDisposition (string) --

      Launch disposition.

    • targetInstanceTypeRightSizingMethod (string) --

      Target instance type right-sizing method.

    • copyPrivateIp (boolean) --

      Copy private Ip.

    • associatePublicIpAddress (boolean) --

      Associate public Ip address.

    • copyTags (boolean) --

      Copy tags.

    • licensing (dict) --

      Configure Licensing.

      • osByol (boolean) --

        Configure BYOL OS licensing.

    • bootMode (string) --

      Launch configuration template boot mode.

    • smallVolumeMaxSize (integer) --

      Small volume maximum size.

    • smallVolumeConf (dict) --

      Small volume config.

      • volumeType (string) --

        Launch template disk volume type configuration.

      • iops (integer) --

        Launch template disk iops configuration.

      • throughput (integer) --

        Launch template disk throughput configuration.

      • volumeInitializationRate (integer) --

        Launch template disk volume initialization rate configuration.

      • deleteOnTermination (boolean) --

        Launch template disk delete on termination configuration.

    • largeVolumeConf (dict) --

      Large volume config.

      • volumeType (string) --

        Launch template disk volume type configuration.

      • iops (integer) --

        Launch template disk iops configuration.

      • throughput (integer) --

        Launch template disk throughput configuration.

      • volumeInitializationRate (integer) --

        Launch template disk volume initialization rate configuration.

      • deleteOnTermination (boolean) --

        Launch template disk delete on termination configuration.

    • enableParametersEncryption (boolean) --

      Enable parameters encryption.

    • parametersEncryptionKey (string) --

      Parameters encryption key.

CreateNetworkMigrationDefinition (updated) Link ¶
Changes (both)
{'definitionType': 'MIGRATION | NEW_NETWORK',
 'sourceConfigurations': {'sourceEnvironment': {'F5_BIGIP'}}}

Creates a new network migration definition that specifies the source and target network configuration for a migration.

See also: AWS API Documentation

Request Syntax

client.create_network_migration_definition(
    clientToken='string',
    name='string',
    description='string',
    sourceConfigurations=[
        {
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT'|'AWS_DISCOVERY_COLLECTOR'|'MIGRATION_PLANNING_ARTIFACTS'|'F5_BIGIP',
            'sourceS3Configuration': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            }
        },
    ],
    definitionType='MIGRATION'|'NEW_NETWORK',
    targetS3Configuration={
        's3Bucket': 'string',
        's3BucketOwner': 'string'
    },
    targetNetwork={
        'topology': 'ISOLATED_VPC'|'HUB_AND_SPOKE',
        'inboundCidr': 'string',
        'outboundCidr': 'string',
        'inspectionCidr': 'string'
    },
    targetDeployment='SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
    vpcProvisioningStrategy='CREATE_NEW'|'USE_EXISTING',
    cidrMappings=[
        {
            'originalCidr': 'string',
            'updatedCidr': 'string'
        },
    ],
    tags={
        'string': 'string'
    },
    scopeTags={
        'string': 'string'
    }
)
type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type name:

string

param name:

[REQUIRED]

The name of the network migration definition.

type description:

string

param description:

A description of the network migration definition.

type sourceConfigurations:

list

param sourceConfigurations:

A list of source configurations for the network migration.

  • (dict) --

    Configuration for a migration source environment.

    • sourceEnvironment (string) -- [REQUIRED]

      The source environment type.

    • sourceS3Configuration (dict) -- [REQUIRED]

      The S3 configuration for the source data.

      • s3Bucket (string) -- [REQUIRED]

        The name of the S3 bucket containing source data.

      • s3BucketOwner (string) -- [REQUIRED]

        The AWS account ID of the S3 bucket owner.

      • s3Key (string) -- [REQUIRED]

        The S3 key (path) for the source data.

type definitionType:

string

param definitionType:

Specifies the type of the definition. MIGRATION migrates an existing network. NEW_NETWORK designs a new network. If you omit this value, the definition type is MIGRATION.

type targetS3Configuration:

dict

param targetS3Configuration:

[REQUIRED]

The S3 configuration for storing the target network artifacts.

  • s3Bucket (string) -- [REQUIRED]

    The name of the S3 bucket for target artifacts.

  • s3BucketOwner (string) -- [REQUIRED]

    The AWS account ID of the S3 bucket owner.

type targetNetwork:

dict

param targetNetwork:

[REQUIRED]

The target network configuration including topology and CIDR ranges.

  • topology (string) -- [REQUIRED]

    The network topology type for the target environment.

  • inboundCidr (string) --

    The CIDR block for inbound traffic in the target network.

  • outboundCidr (string) --

    The CIDR block for outbound traffic in the target network.

  • inspectionCidr (string) --

    The CIDR block for inspection traffic in the target network.

type targetDeployment:

string

param targetDeployment:

The target deployment configuration for the migrated network.

type vpcProvisioningStrategy:

string

param vpcProvisioningStrategy:

Specifies whether to create new target VPCs or use existing ones. Set to CREATE_NEW to provision new target VPCs as part of the migration, or USE_EXISTING to migrate into existing VPCs in the target account.

type cidrMappings:

list

param cidrMappings:

A list of CIDR mappings that map original source CIDR ranges to updated target CIDR ranges. CIDR mappings can be provided only when vpcProvisioningStrategy is set to USE_EXISTING.

  • (dict) --

    Maps a source CIDR range to the corresponding target CIDR range to use in the target network.

    • originalCidr (string) -- [REQUIRED]

      The original CIDR range in the source network.

    • updatedCidr (string) -- [REQUIRED]

      The updated CIDR range to use in the target network.

type tags:

dict

param tags:

Tags to assign to the network migration definition.

  • (string) --

    • (string) --

type scopeTags:

dict

param scopeTags:

Scope tags for the network migration definition to control access and organization.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'networkMigrationDefinitionID': 'string',
    'name': 'string',
    'description': 'string',
    'sourceConfigurations': [
        {
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT'|'AWS_DISCOVERY_COLLECTOR'|'MIGRATION_PLANNING_ARTIFACTS'|'F5_BIGIP',
            'sourceS3Configuration': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            }
        },
    ],
    'definitionType': 'MIGRATION'|'NEW_NETWORK',
    'targetS3Configuration': {
        's3Bucket': 'string',
        's3BucketOwner': 'string'
    },
    'targetNetwork': {
        'topology': 'ISOLATED_VPC'|'HUB_AND_SPOKE',
        'inboundCidr': 'string',
        'outboundCidr': 'string',
        'inspectionCidr': 'string'
    },
    'targetDeployment': 'SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
    'vpcProvisioningStrategy': 'CREATE_NEW'|'USE_EXISTING',
    'cidrMappings': [
        {
            'originalCidr': 'string',
            'updatedCidr': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'scopeTags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the network migration definition.

    • networkMigrationDefinitionID (string) --

      The unique identifier of the network migration definition.

    • name (string) --

      The name of the network migration definition.

    • description (string) --

      A description of the network migration definition.

    • sourceConfigurations (list) --

      A list of source configurations for the network migration.

      • (dict) --

        Configuration for a migration source environment.

        • sourceEnvironment (string) --

          The source environment type.

        • sourceS3Configuration (dict) --

          The S3 configuration for the source data.

          • s3Bucket (string) --

            The name of the S3 bucket containing source data.

          • s3BucketOwner (string) --

            The AWS account ID of the S3 bucket owner.

          • s3Key (string) --

            The S3 key (path) for the source data.

    • definitionType (string) --

      Specifies the type of the definition. MIGRATION migrates an existing network. NEW_NETWORK designs a new network.

    • targetS3Configuration (dict) --

      The S3 configuration for storing the target network artifacts.

      • s3Bucket (string) --

        The name of the S3 bucket for target artifacts.

      • s3BucketOwner (string) --

        The AWS account ID of the S3 bucket owner.

    • targetNetwork (dict) --

      The target network configuration including topology and CIDR ranges.

      • topology (string) --

        The network topology type for the target environment.

      • inboundCidr (string) --

        The CIDR block for inbound traffic in the target network.

      • outboundCidr (string) --

        The CIDR block for outbound traffic in the target network.

      • inspectionCidr (string) --

        The CIDR block for inspection traffic in the target network.

    • targetDeployment (string) --

      The target deployment configuration for the migrated network.

    • vpcProvisioningStrategy (string) --

      Indicates whether the migration creates new target VPCs or uses existing ones. CREATE_NEW provisions new target VPCs; USE_EXISTING migrates into existing VPCs in the target account.

    • cidrMappings (list) --

      A list of CIDR mappings that map original source CIDR ranges to updated target CIDR ranges. CIDR mappings apply only when vpcProvisioningStrategy is set to USE_EXISTING.

      • (dict) --

        Maps a source CIDR range to the corresponding target CIDR range to use in the target network.

        • originalCidr (string) --

          The original CIDR range in the source network.

        • updatedCidr (string) --

          The updated CIDR range to use in the target network.

    • createdAt (datetime) --

      The timestamp when the network migration definition was created.

    • updatedAt (datetime) --

      The timestamp when the network migration definition was last updated.

    • tags (dict) --

      Tags assigned to the network migration definition.

      • (string) --

        • (string) --

    • scopeTags (dict) --

      Scope tags for the network migration definition.

      • (string) --

        • (string) --

CreateReplicationConfigurationTemplate (updated) Link ¶
Changes (both)
{'outpostSnapshotLocation': 'OUTPOST | REGION'}

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,
    outpostSnapshotLocation='OUTPOST'|'REGION',
    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 outpostSnapshotLocation:

string

param outpostSnapshotLocation:

Request to set the location of replication snapshots when the staging area subnet is on an AWS Outpost during Replication Settings template creation. Set to OUTPOST to keep replication snapshots on the Outpost, or REGION to store them in the AWS Region. Required when the staging area subnet is on an Outpost, and not allowed otherwise.

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,
    'outpostSnapshotLocation': 'OUTPOST'|'REGION',
    '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.

    • outpostSnapshotLocation (string) --

      Indicates the location of replication snapshots in the Replication Configuration template when the staging area subnet is on an AWS Outpost. OUTPOST keeps replication snapshots on the Outpost, and REGION stores them in the AWS Region.

    • 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.

DescribeLaunchConfigurationTemplates (updated) Link ¶
Changes (response)
{'items': {'mapAutoTaggingKey': 'string'}}

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

See also: AWS API Documentation

Request Syntax

client.describe_launch_configuration_templates(
    launchConfigurationTemplateIDs=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)
type launchConfigurationTemplateIDs:

list

param launchConfigurationTemplateIDs:

Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

  • (string) --

type maxResults:

integer

param maxResults:

Maximum results to be returned in DescribeLaunchConfigurationTemplates.

type nextToken:

string

param nextToken:

Next pagination token returned from DescribeLaunchConfigurationTemplates.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'launchConfigurationTemplateID': 'string',
            'arn': 'string',
            'postLaunchActions': {
                'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
                's3LogBucket': 'string',
                's3OutputKeyPrefix': 'string',
                'cloudWatchLogGroupName': 'string',
                'ssmDocuments': [
                    {
                        'actionName': 'string',
                        'ssmDocumentName': 'string',
                        'timeoutSeconds': 123,
                        'mustSucceedForCutover': True|False,
                        'parameters': {
                            'string': [
                                {
                                    'parameterType': 'STRING'|'SECURE_STRING',
                                    'parameterName': 'string'
                                },
                            ]
                        },
                        'externalParameters': {
                            'string': {
                                'dynamicPath': 'string'
                            }
                        }
                    },
                ]
            },
            'enableMapAutoTagging': True|False,
            'mapAutoTaggingMpeID': 'string',
            'mapAutoTaggingKey': 'string',
            'tags': {
                'string': 'string'
            },
            'ec2LaunchTemplateID': 'string',
            'launchDisposition': 'STOPPED'|'STARTED',
            'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
            'copyPrivateIp': True|False,
            'associatePublicIpAddress': True|False,
            'copyTags': True|False,
            'licensing': {
                'osByol': True|False
            },
            'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
            'smallVolumeMaxSize': 123,
            'smallVolumeConf': {
                'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
                'iops': 123,
                'throughput': 123,
                'volumeInitializationRate': 123,
                'deleteOnTermination': True|False
            },
            'largeVolumeConf': {
                'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
                'iops': 123,
                'throughput': 123,
                'volumeInitializationRate': 123,
                'deleteOnTermination': True|False
            },
            'enableParametersEncryption': True|False,
            'parametersEncryptionKey': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      List of items returned by DescribeLaunchConfigurationTemplates.

      • (dict) --

        • launchConfigurationTemplateID (string) --

          ID of the Launch Configuration Template.

        • arn (string) --

          ARN of the Launch Configuration Template.

        • postLaunchActions (dict) --

          Post Launch Actions of the Launch Configuration Template.

          • deployment (string) --

            Deployment type in which AWS Systems Manager Documents will be executed.

          • s3LogBucket (string) --

            AWS Systems Manager Command's logs S3 log bucket.

          • s3OutputKeyPrefix (string) --

            AWS Systems Manager Command's logs S3 output key prefix.

          • cloudWatchLogGroupName (string) --

            AWS Systems Manager Command's CloudWatch log group name.

          • ssmDocuments (list) --

            AWS Systems Manager Documents.

            • (dict) --

              AWS Systems Manager Document.

              • actionName (string) --

                User-friendly name for the AWS Systems Manager Document.

              • ssmDocumentName (string) --

                AWS Systems Manager Document name or full ARN.

              • timeoutSeconds (integer) --

                AWS Systems Manager Document timeout seconds.

              • mustSucceedForCutover (boolean) --

                If true, Cutover will not be enabled if the document has failed.

              • parameters (dict) --

                AWS Systems Manager Document parameters.

                • (string) --

                  • (list) --

                    • (dict) --

                      AWS Systems Manager Parameter Store parameter.

                      • parameterType (string) --

                        AWS Systems Manager Parameter Store parameter type.

                      • parameterName (string) --

                        AWS Systems Manager Parameter Store parameter name.

              • externalParameters (dict) --

                AWS Systems Manager Document external parameters.

                • (string) --

                  • (dict) --

                    AWS Systems Manager Document external parameter.

                    • dynamicPath (string) --

                      AWS Systems Manager Document external parameters dynamic path.

        • enableMapAutoTagging (boolean) --

          Enable map auto tagging.

        • mapAutoTaggingMpeID (string) --

          Launch configuration template map auto tagging MPE ID.

        • mapAutoTaggingKey (string) --

          Launch configuration template map auto tagging key.

        • tags (dict) --

          Tags of the Launch Configuration Template.

          • (string) --

            • (string) --

        • ec2LaunchTemplateID (string) --

          EC2 launch template ID.

        • launchDisposition (string) --

          Launch disposition.

        • targetInstanceTypeRightSizingMethod (string) --

          Target instance type right-sizing method.

        • copyPrivateIp (boolean) --

          Copy private Ip.

        • associatePublicIpAddress (boolean) --

          Associate public Ip address.

        • copyTags (boolean) --

          Copy tags.

        • licensing (dict) --

          Configure Licensing.

          • osByol (boolean) --

            Configure BYOL OS licensing.

        • bootMode (string) --

          Launch configuration template boot mode.

        • smallVolumeMaxSize (integer) --

          Small volume maximum size.

        • smallVolumeConf (dict) --

          Small volume config.

          • volumeType (string) --

            Launch template disk volume type configuration.

          • iops (integer) --

            Launch template disk iops configuration.

          • throughput (integer) --

            Launch template disk throughput configuration.

          • volumeInitializationRate (integer) --

            Launch template disk volume initialization rate configuration.

          • deleteOnTermination (boolean) --

            Launch template disk delete on termination configuration.

        • largeVolumeConf (dict) --

          Large volume config.

          • volumeType (string) --

            Launch template disk volume type configuration.

          • iops (integer) --

            Launch template disk iops configuration.

          • throughput (integer) --

            Launch template disk throughput configuration.

          • volumeInitializationRate (integer) --

            Launch template disk volume initialization rate configuration.

          • deleteOnTermination (boolean) --

            Launch template disk delete on termination configuration.

        • enableParametersEncryption (boolean) --

          Enable parameters encryption.

        • parametersEncryptionKey (string) --

          Parameters encryption key.

    • nextToken (string) --

      Next pagination token returned from DescribeLaunchConfigurationTemplates.

DescribeReplicationConfigurationTemplates (updated) Link ¶
Changes (response)
{'items': {'outpostSnapshotLocation': 'OUTPOST | REGION'}}

Lists all ReplicationConfigurationTemplates, filtered by replication configuration template 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,
            'outpostSnapshotLocation': 'OUTPOST'|'REGION',
            '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.

        • outpostSnapshotLocation (string) --

          Indicates the location of replication snapshots in the Replication Configuration template when the staging area subnet is on an AWS Outpost. OUTPOST keeps replication snapshots on the Outpost, and REGION stores them in the AWS Region.

        • 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': {'stagingOutpostArn': 'string'}}}

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 Account 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',
                'stagingOutpostArn': '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) --

      The list of returned Source Servers.

      • (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.

          • stagingOutpostArn (string) --

            The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

        • lifeCycle (dict) --

          Source server lifecycle state.

          • addedToServiceDateTime (string) --

            Lifecycle added to service date 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 finalized 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) --

      The token of the next Source Server to retrieve.

DisconnectFromService (updated) Link ¶
Changes (response)
{'dataReplicationInfo': {'stagingOutpostArn': 'string'}}

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with Application Migration 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.etaDateTime 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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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': {'stagingOutpostArn': 'string'}}

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

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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.

GetLaunchConfiguration (updated) Link ¶
Changes (response)
{'mapAutoTaggingKey': 'string'}

Lists all LaunchConfigurations available, filtered by Source Server IDs.

See also: AWS API Documentation

Request Syntax

client.get_launch_configuration(
    sourceServerID='string',
    accountID='string'
)
type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Request to get Launch Configuration information by Source Server ID.

type accountID:

string

param accountID:

Request to get Launch Configuration information by Account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'name': 'string',
    'ec2LaunchTemplateID': 'string',
    'launchDisposition': 'STOPPED'|'STARTED',
    'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
    'copyPrivateIp': True|False,
    'copyTags': True|False,
    'licensing': {
        'osByol': True|False
    },
    'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
    'postLaunchActions': {
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'cloudWatchLogGroupName': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123,
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterType': 'STRING'|'SECURE_STRING',
                            'parameterName': 'string'
                        },
                    ]
                },
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                }
            },
        ]
    },
    'enableMapAutoTagging': True|False,
    'mapAutoTaggingMpeID': 'string',
    'mapAutoTaggingKey': 'string'
}

Response Structure

  • (dict) --

    • sourceServerID (string) --

      Launch configuration Source Server ID.

    • name (string) --

      Launch configuration name.

    • ec2LaunchTemplateID (string) --

      Launch configuration EC2 Launch template ID.

    • launchDisposition (string) --

      Launch disposition for launch configuration.

    • targetInstanceTypeRightSizingMethod (string) --

      Launch configuration Target instance type right sizing method.

    • copyPrivateIp (boolean) --

      Copy Private IP during Launch Configuration.

    • copyTags (boolean) --

      Copy Tags during Launch Configuration.

    • licensing (dict) --

      Launch configuration OS licensing.

      • osByol (boolean) --

        Configure BYOL OS licensing.

    • bootMode (string) --

      Launch configuration boot mode.

    • postLaunchActions (dict) --

      Post Launch Actions to be executed on the Test or Cutover instance.

      • deployment (string) --

        Deployment type in which AWS Systems Manager Documents will be executed.

      • s3LogBucket (string) --

        AWS Systems Manager Command's logs S3 log bucket.

      • s3OutputKeyPrefix (string) --

        AWS Systems Manager Command's logs S3 output key prefix.

      • cloudWatchLogGroupName (string) --

        AWS Systems Manager Command's CloudWatch log group name.

      • ssmDocuments (list) --

        AWS Systems Manager Documents.

        • (dict) --

          AWS Systems Manager Document.

          • actionName (string) --

            User-friendly name for the AWS Systems Manager Document.

          • ssmDocumentName (string) --

            AWS Systems Manager Document name or full ARN.

          • timeoutSeconds (integer) --

            AWS Systems Manager Document timeout seconds.

          • mustSucceedForCutover (boolean) --

            If true, Cutover will not be enabled if the document has failed.

          • parameters (dict) --

            AWS Systems Manager Document parameters.

            • (string) --

              • (list) --

                • (dict) --

                  AWS Systems Manager Parameter Store parameter.

                  • parameterType (string) --

                    AWS Systems Manager Parameter Store parameter type.

                  • parameterName (string) --

                    AWS Systems Manager Parameter Store parameter name.

          • externalParameters (dict) --

            AWS Systems Manager Document external parameters.

            • (string) --

              • (dict) --

                AWS Systems Manager Document external parameter.

                • dynamicPath (string) --

                  AWS Systems Manager Document external parameters dynamic path.

    • enableMapAutoTagging (boolean) --

      Enable map auto tagging.

    • mapAutoTaggingMpeID (string) --

      Map auto tagging MPE ID.

    • mapAutoTaggingKey (string) --

      Map auto tagging key.

GetNetworkMigrationDefinition (updated) Link ¶
Changes (response)
{'definitionType': 'MIGRATION | NEW_NETWORK',
 'sourceConfigurations': {'sourceEnvironment': {'F5_BIGIP'}}}

Retrieves the details of a network migration definition including source and target configurations.

See also: AWS API Documentation

Request Syntax

client.get_network_migration_definition(
    networkMigrationDefinitionID='string'
)
type networkMigrationDefinitionID:

string

param networkMigrationDefinitionID:

[REQUIRED]

The unique identifier of the network migration definition to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'networkMigrationDefinitionID': 'string',
    'name': 'string',
    'description': 'string',
    'sourceConfigurations': [
        {
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT'|'AWS_DISCOVERY_COLLECTOR'|'MIGRATION_PLANNING_ARTIFACTS'|'F5_BIGIP',
            'sourceS3Configuration': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            }
        },
    ],
    'definitionType': 'MIGRATION'|'NEW_NETWORK',
    'targetS3Configuration': {
        's3Bucket': 'string',
        's3BucketOwner': 'string'
    },
    'targetNetwork': {
        'topology': 'ISOLATED_VPC'|'HUB_AND_SPOKE',
        'inboundCidr': 'string',
        'outboundCidr': 'string',
        'inspectionCidr': 'string'
    },
    'targetDeployment': 'SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
    'vpcProvisioningStrategy': 'CREATE_NEW'|'USE_EXISTING',
    'cidrMappings': [
        {
            'originalCidr': 'string',
            'updatedCidr': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'scopeTags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the network migration definition.

    • networkMigrationDefinitionID (string) --

      The unique identifier of the network migration definition.

    • name (string) --

      The name of the network migration definition.

    • description (string) --

      A description of the network migration definition.

    • sourceConfigurations (list) --

      A list of source configurations for the network migration.

      • (dict) --

        Configuration for a migration source environment.

        • sourceEnvironment (string) --

          The source environment type.

        • sourceS3Configuration (dict) --

          The S3 configuration for the source data.

          • s3Bucket (string) --

            The name of the S3 bucket containing source data.

          • s3BucketOwner (string) --

            The AWS account ID of the S3 bucket owner.

          • s3Key (string) --

            The S3 key (path) for the source data.

    • definitionType (string) --

      Specifies the type of the definition. MIGRATION migrates an existing network. NEW_NETWORK designs a new network.

    • targetS3Configuration (dict) --

      The S3 configuration for storing the target network artifacts.

      • s3Bucket (string) --

        The name of the S3 bucket for target artifacts.

      • s3BucketOwner (string) --

        The AWS account ID of the S3 bucket owner.

    • targetNetwork (dict) --

      The target network configuration including topology and CIDR ranges.

      • topology (string) --

        The network topology type for the target environment.

      • inboundCidr (string) --

        The CIDR block for inbound traffic in the target network.

      • outboundCidr (string) --

        The CIDR block for outbound traffic in the target network.

      • inspectionCidr (string) --

        The CIDR block for inspection traffic in the target network.

    • targetDeployment (string) --

      The target deployment configuration for the migrated network.

    • vpcProvisioningStrategy (string) --

      Indicates whether the migration creates new target VPCs or uses existing ones. CREATE_NEW provisions new target VPCs; USE_EXISTING migrates into existing VPCs in the target account.

    • cidrMappings (list) --

      A list of CIDR mappings that map original source CIDR ranges to updated target CIDR ranges. CIDR mappings apply only when vpcProvisioningStrategy is set to USE_EXISTING.

      • (dict) --

        Maps a source CIDR range to the corresponding target CIDR range to use in the target network.

        • originalCidr (string) --

          The original CIDR range in the source network.

        • updatedCidr (string) --

          The updated CIDR range to use in the target network.

    • createdAt (datetime) --

      The timestamp when the network migration definition was created.

    • updatedAt (datetime) --

      The timestamp when the network migration definition was last updated.

    • tags (dict) --

      Tags assigned to the network migration definition.

      • (string) --

        • (string) --

    • scopeTags (dict) --

      Scope tags for the network migration definition.

      • (string) --

        • (string) --

GetNetworkMigrationMapperSegmentConstruct (updated) Link ¶
Changes (response)
{'construct': {'configuration': {'securityGroup': {'associations': {'cidrs': ['string'],
                                                                    'userProvidedIDs': ['string'],
                                                                    'vmUUIDs': ['string']}},
                                 'securityGroupRule': {'enableReferencing': 'boolean'}},
               'enrichedProperties': {'string': {}}}}

Retrieves detailed information about a specific construct within a mapper segment, including its properties and configuration data.

See also: AWS API Documentation

Request Syntax

client.get_network_migration_mapper_segment_construct(
    networkMigrationDefinitionID='string',
    networkMigrationExecutionID='string',
    segmentID='string',
    constructID='string'
)
type networkMigrationDefinitionID:

string

param networkMigrationDefinitionID:

[REQUIRED]

The unique identifier of the network migration definition.

type networkMigrationExecutionID:

string

param networkMigrationExecutionID:

[REQUIRED]

The unique identifier of the network migration execution.

type segmentID:

string

param segmentID:

[REQUIRED]

The unique identifier of the mapper segment.

type constructID:

string

param constructID:

[REQUIRED]

The unique identifier of the construct within the segment.

rtype:

dict

returns:

Response Syntax

{
    'construct': {
        'constructID': 'string',
        'constructType': 'string',
        'name': 'string',
        'description': 'string',
        'logicalID': 'string',
        'excluded': True|False,
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'properties': {
            'string': 'string'
        },
        'enrichedProperties': {
            'string': {...}|[...]|123|123.4|'string'|True|None
        },
        'configuration': {
            'securityGroup': {
                'associations': {
                    'cidrs': [
                        'string',
                    ],
                    'vmUUIDs': [
                        'string',
                    ],
                    'userProvidedIDs': [
                        'string',
                    ]
                }
            },
            'securityGroupRule': {
                'enableReferencing': True|False
            }
        }
    }
}

Response Structure

  • (dict) --

    • construct (dict) --

      The construct metadata including type, name, and configuration.

      • constructID (string) --

        The unique identifier of the construct.

      • constructType (string) --

        The type of the construct, such as VPC, subnet, security group, or route table.

      • name (string) --

        The name of the construct.

      • description (string) --

        A description of the construct.

      • logicalID (string) --

        The logical identifier for the construct in the infrastructure code.

      • excluded (boolean) --

        Whether this construct is excluded from the migration.

      • createdAt (datetime) --

        The timestamp when the construct was created.

      • updatedAt (datetime) --

        The timestamp when the construct was last updated.

      • properties (dict) --

        The properties and configuration of the construct.

        • (string) --

          • (string) --

      • enrichedProperties (dict) --

        The construct properties using their native value types. Returned by Get, and by List when includeEnrichedProperties is true.

        • (string) --

          • (:ref:`document<document>`) --

      • configuration (dict) --

        The construct-type-specific behavioral configuration. Returned by Get, and by List when includeConfiguration is true.

        • securityGroup (dict) --

          Behavioral configuration for a security group construct.

          • associations (dict) --

            The CIDR ranges and machine identifiers that associate source machines with the security group. Each list provided replaces the stored list rather than merging into it.

            • cidrs (list) --

              The CIDR ranges associated with the security group. A provided list replaces the stored list; an empty list clears it, and omitting the field leaves it unchanged.

              • (string) --

            • vmUUIDs (list) --

              The UUIDs of the source machines associated with the security group.

              • (string) --

            • userProvidedIDs (list) --

              The user-provided identifiers of the source machines associated with the security group.

              • (string) --

        • securityGroupRule (dict) --

          Behavioral configuration for a security group rule construct.

          • enableReferencing (boolean) --

            Whether automatic conversion of CIDR-based sources and destinations to security group references applies to this rule.

GetReplicationConfiguration (updated) Link ¶
Changes (response)
{'outpostSnapshotLocation': 'OUTPOST | REGION'}

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,
    'outpostSnapshotLocation': 'OUTPOST'|'REGION',
    '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.

    • outpostSnapshotLocation (string) --

      Indicates the location of replication snapshots when the staging area subnet is on an AWS Outpost. OUTPOST keeps replication snapshots on the Outpost, and REGION stores them in the AWS Region.

    • 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.

ListNetworkMigrationDefinitions (updated) Link ¶
Changes (response)
{'items': {'definitionType': 'MIGRATION | NEW_NETWORK',
           'sourceEnvironment': {'F5_BIGIP'}}}

Lists all network migration definitions in the account, with optional filtering.

See also: AWS API Documentation

Request Syntax

client.list_network_migration_definitions(
    filters={
        'networkMigrationDefinitionIDs': [
            'string',
        ]
    },
    nextToken='string',
    maxResults=123
)
type filters:

dict

param filters:

Filters to apply when listing network migration definitions.

  • networkMigrationDefinitionIDs (list) --

    A list of definition IDs to filter by.

    • (string) --

type nextToken:

string

param nextToken:

The token for the next page of results.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'networkMigrationDefinitionID': 'string',
            'name': 'string',
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT'|'AWS_DISCOVERY_COLLECTOR'|'MIGRATION_PLANNING_ARTIFACTS'|'F5_BIGIP',
            'arn': 'string',
            'tags': {
                'string': 'string'
            },
            'scopeTags': {
                'string': 'string'
            },
            'definitionType': 'MIGRATION'|'NEW_NETWORK'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of network migration definition summaries.

      • (dict) --

        A summary of a network migration definition.

        • networkMigrationDefinitionID (string) --

          The unique identifier of the network migration definition.

        • name (string) --

          The name of the network migration definition.

        • sourceEnvironment (string) --

          The source environment configuration.

        • arn (string) --

          The Amazon Resource Name (ARN) of the network migration definition.

        • tags (dict) --

          Tags assigned to the network migration definition.

          • (string) --

            • (string) --

        • scopeTags (dict) --

          Scope tags for the network migration definition.

          • (string) --

            • (string) --

        • definitionType (string) --

          The type of the network migration definition.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ListNetworkMigrationMapperSegmentConstructs (updated) Link ¶
Changes (request, response)
Request
{'includeConfiguration': 'boolean', 'includeEnrichedProperties': 'boolean'}
Response
{'items': {'configuration': {'securityGroup': {'associations': {'cidrs': ['string'],
                                                                'userProvidedIDs': ['string'],
                                                                'vmUUIDs': ['string']}},
                             'securityGroupRule': {'enableReferencing': 'boolean'}},
           'enrichedProperties': {'string': {}}}}

Lists constructs within a mapper segment, representing individual infrastructure components like VPCs, subnets, or security groups.

See also: AWS API Documentation

Request Syntax

client.list_network_migration_mapper_segment_constructs(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    segmentID='string',
    filters={
        'constructIDs': [
            'string',
        ],
        'constructTypes': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string',
    includeEnrichedProperties=True|False,
    includeConfiguration=True|False
)
type networkMigrationExecutionID:

string

param networkMigrationExecutionID:

[REQUIRED]

The unique identifier of the network migration execution.

type networkMigrationDefinitionID:

string

param networkMigrationDefinitionID:

[REQUIRED]

The unique identifier of the network migration definition.

type segmentID:

string

param segmentID:

[REQUIRED]

The unique identifier of the segment to list constructs for.

type filters:

dict

param filters:

Filters to apply when listing constructs, such as construct type or ID.

  • constructIDs (list) --

    A list of construct IDs to filter by.

    • (string) --

  • constructTypes (list) --

    A list of construct types to filter by.

    • (string) --

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

The token for the next page of results.

type includeEnrichedProperties:

boolean

param includeEnrichedProperties:

Whether to return construct properties using their native value types.

type includeConfiguration:

boolean

param includeConfiguration:

Whether to return construct-type-specific behavioral configuration.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'constructID': 'string',
            'constructType': 'string',
            'name': 'string',
            'description': 'string',
            'logicalID': 'string',
            'excluded': True|False,
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'properties': {
                'string': 'string'
            },
            'enrichedProperties': {
                'string': {...}|[...]|123|123.4|'string'|True|None
            },
            'configuration': {
                'securityGroup': {
                    'associations': {
                        'cidrs': [
                            'string',
                        ],
                        'vmUUIDs': [
                            'string',
                        ],
                        'userProvidedIDs': [
                            'string',
                        ]
                    }
                },
                'securityGroupRule': {
                    'enableReferencing': True|False
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of mapper segment constructs.

      • (dict) --

        Represents a construct within a mapper segment. A construct is an individual infrastructure component such as a VPC, subnet, security group, route table, or other network resource that is part of the network migration.

        • constructID (string) --

          The unique identifier of the construct.

        • constructType (string) --

          The type of the construct, such as VPC, subnet, security group, or route table.

        • name (string) --

          The name of the construct.

        • description (string) --

          A description of the construct.

        • logicalID (string) --

          The logical identifier for the construct in the infrastructure code.

        • excluded (boolean) --

          Whether this construct is excluded from the migration.

        • createdAt (datetime) --

          The timestamp when the construct was created.

        • updatedAt (datetime) --

          The timestamp when the construct was last updated.

        • properties (dict) --

          The properties and configuration of the construct.

          • (string) --

            • (string) --

        • enrichedProperties (dict) --

          The construct properties using their native value types. Returned by Get, and by List when includeEnrichedProperties is true.

          • (string) --

            • (:ref:`document<document>`) --

        • configuration (dict) --

          The construct-type-specific behavioral configuration. Returned by Get, and by List when includeConfiguration is true.

          • securityGroup (dict) --

            Behavioral configuration for a security group construct.

            • associations (dict) --

              The CIDR ranges and machine identifiers that associate source machines with the security group. Each list provided replaces the stored list rather than merging into it.

              • cidrs (list) --

                The CIDR ranges associated with the security group. A provided list replaces the stored list; an empty list clears it, and omitting the field leaves it unchanged.

                • (string) --

              • vmUUIDs (list) --

                The UUIDs of the source machines associated with the security group.

                • (string) --

              • userProvidedIDs (list) --

                The user-provided identifiers of the source machines associated with the security group.

                • (string) --

          • securityGroupRule (dict) --

            Behavioral configuration for a security group rule construct.

            • enableReferencing (boolean) --

              Whether automatic conversion of CIDR-based sources and destinations to security group references applies to this rule.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

MarkAsArchived (updated) Link ¶
Changes (response)
{'dataReplicationInfo': {'stagingOutpostArn': 'string'}}

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle state that 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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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': {'stagingOutpostArn': 'string'}}

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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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': {'stagingOutpostArn': 'string'}}

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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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': {'stagingOutpostArn': 'string'}}

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

See also: AWS API Documentation

Request Syntax

client.retry_data_replication(
    sourceServerID='string',
    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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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.

StartNetworkMigrationMappingUpdate (updated) Link ¶
Changes (request)
{'constructs': {'constructLogicalID': 'string',
                'operation': {'create': {'configuration': {'securityGroup': {'associations': {'cidrs': ['string'],
                                                                                              'userProvidedIDs': ['string'],
                                                                                              'vmUUIDs': ['string']}},
                                                           'securityGroupRule': {'enableReferencing': 'boolean'}},
                                         'excluded': 'boolean',
                                         'name': 'string',
                                         'properties': {'string': {}}},
                              'updateV2': {'configuration': {'securityGroup': {'associations': {'cidrs': ['string'],
                                                                                                'userProvidedIDs': ['string'],
                                                                                                'vmUUIDs': ['string']}},
                                                             'securityGroupRule': {'enableReferencing': 'boolean'}},
                                           'excluded': 'boolean',
                                           'name': 'string',
                                           'properties': {'string': {}},
                                           'propertiesToDelete': ['string']}},
                'segmentLogicalID': 'string'},
 'segments': {'operation': {'create': {'description': 'string',
                                       'name': 'string',
                                       'scopeTags': {'string': 'string'},
                                       'targetAccount': 'string'},
                            'delete': {},
                            'update': {'description': 'string',
                                       'name': 'string',
                                       'scopeTags': {'string': 'string'},
                                       'targetAccount': 'string'}},
              'segmentLogicalID': 'string'}}

Starts a job to apply customer modifications to network migration mappings, such as changing properties.

See also: AWS API Documentation

Request Syntax

client.start_network_migration_mapping_update(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    constructs=[
        {
            'segmentID': 'string',
            'segmentLogicalID': 'string',
            'constructID': 'string',
            'constructType': 'string',
            'constructLogicalID': 'string',
            'operation': {
                'merge': {
                    'mergeConstructs': [
                        {
                            'segmentID': 'string',
                            'constructID': 'string'
                        },
                    ]
                },
                'split': {
                    'splitConstructs': [
                        {
                            'cidrBlock': 'string'
                        },
                    ]
                },
                'delete': {}
                ,
                'update': {
                    'name': 'string',
                    'excluded': True|False,
                    'properties': {
                        'string': 'string'
                    }
                },
                'updateV2': {
                    'name': 'string',
                    'excluded': True|False,
                    'properties': {
                        'string': {...}|[...]|123|123.4|'string'|True|None
                    },
                    'propertiesToDelete': [
                        'string',
                    ],
                    'configuration': {
                        'securityGroup': {
                            'associations': {
                                'cidrs': [
                                    'string',
                                ],
                                'vmUUIDs': [
                                    'string',
                                ],
                                'userProvidedIDs': [
                                    'string',
                                ]
                            }
                        },
                        'securityGroupRule': {
                            'enableReferencing': True|False
                        }
                    }
                },
                'create': {
                    'name': 'string',
                    'excluded': True|False,
                    'properties': {
                        'string': {...}|[...]|123|123.4|'string'|True|None
                    },
                    'configuration': {
                        'securityGroup': {
                            'associations': {
                                'cidrs': [
                                    'string',
                                ],
                                'vmUUIDs': [
                                    'string',
                                ],
                                'userProvidedIDs': [
                                    'string',
                                ]
                            }
                        },
                        'securityGroupRule': {
                            'enableReferencing': True|False
                        }
                    }
                }
            }
        },
    ],
    segments=[
        {
            'segmentID': 'string',
            'segmentLogicalID': 'string',
            'operation': {
                'create': {
                    'name': 'string',
                    'description': 'string',
                    'targetAccount': 'string',
                    'scopeTags': {
                        'string': 'string'
                    }
                },
                'update': {
                    'name': 'string',
                    'description': 'string',
                    'targetAccount': 'string',
                    'scopeTags': {
                        'string': 'string'
                    }
                },
                'delete': {}

            },
            'targetAccount': 'string',
            'scopeTags': {
                'string': 'string'
            }
        },
    ]
)
type networkMigrationExecutionID:

string

param networkMigrationExecutionID:

[REQUIRED]

The unique identifier of the network migration execution.

type networkMigrationDefinitionID:

string

param networkMigrationDefinitionID:

[REQUIRED]

The unique identifier of the network migration definition.

type constructs:

list

param constructs:

A list of construct updates to apply.

  • (dict) --

    A construct update to apply during a mapping update operation.

    • segmentID (string) --

      The ID of the segment containing the construct.

    • segmentLogicalID (string) --

      The identifier of a segment created in the same request that this construct belongs to. Use it instead of segmentID for a new segment.

    • constructID (string) --

      The ID of the construct to update.

    • constructType (string) -- [REQUIRED]

      The type of the construct.

    • constructLogicalID (string) --

      The logical identifier for a construct created by a create operation; other operations identify the construct by constructID. Other entries in the same request can reference the new construct as {"Ref": "<constructLogicalID>"}.

    • operation (dict) --

      The operation to perform on the construct.

      • merge (dict) --

        A merge operation to combine constructs from different segments.

        • mergeConstructs (list) --

          The list of constructs to merge into the target.

          • (dict) --

            A construct reference specifying the source segment and construct to merge.

            • segmentID (string) --

              The segment ID of the construct to merge.

            • constructID (string) --

              The construct ID to merge.

      • split (dict) --

        A split operation to divide a construct into multiple constructs with specified CIDR blocks.

        • splitConstructs (list) --

          The list of split targets with their CIDR blocks.

          • (dict) --

            A split target specifying the CIDR block for the new construct.

            • cidrBlock (string) --

              The CIDR block for the split construct.

      • delete (dict) --

        A delete operation to remove a construct from the mapping.

      • update (dict) --

        An update operation to modify construct properties.

        • name (string) --

          The updated name for the construct.

        • excluded (boolean) --

          Whether to exclude this construct from the migration.

        • properties (dict) --

          The properties to update on the construct.

          • (string) --

            • (string) --

      • updateV2 (dict) --

        An update operation that modifies a construct using native property value types and behavioral configuration, with partial updates and property removal.

        • name (string) --

          The updated name for the construct.

        • excluded (boolean) --

          Whether to exclude this construct from the migration.

        • properties (dict) --

          The properties to set or overwrite on the construct, using their native value types; omitted keys are unchanged.

          • (string) --

            • (:ref:`document<document>`) --

        • propertiesToDelete (list) --

          The property keys to remove from the construct.

          • (string) --

        • configuration (dict) --

          Construct-type-specific behavioral configuration to apply, such as security group associations or security group rule referencing.

          • securityGroup (dict) --

            Behavioral configuration for a security group construct.

            • associations (dict) --

              The CIDR ranges and machine identifiers that associate source machines with the security group. Each list provided replaces the stored list rather than merging into it.

              • cidrs (list) --

                The CIDR ranges associated with the security group. A provided list replaces the stored list; an empty list clears it, and omitting the field leaves it unchanged.

                • (string) --

              • vmUUIDs (list) --

                The UUIDs of the source machines associated with the security group.

                • (string) --

              • userProvidedIDs (list) --

                The user-provided identifiers of the source machines associated with the security group.

                • (string) --

          • securityGroupRule (dict) --

            Behavioral configuration for a security group rule construct.

            • enableReferencing (boolean) --

              Whether automatic conversion of CIDR-based sources and destinations to security group references applies to this rule.

      • create (dict) --

        A create operation that adds a new construct to the segment, identified by the constructLogicalID on the parent construct entry.

        • name (string) --

          The name for the new construct.

        • excluded (boolean) --

          Whether the new construct is excluded from the migration.

        • properties (dict) --

          The properties of the new construct, using their native value types.

          • (string) --

            • (:ref:`document<document>`) --

        • configuration (dict) --

          The initial construct-type-specific behavioral configuration for the new construct.

          • securityGroup (dict) --

            Behavioral configuration for a security group construct.

            • associations (dict) --

              The CIDR ranges and machine identifiers that associate source machines with the security group. Each list provided replaces the stored list rather than merging into it.

              • cidrs (list) --

                The CIDR ranges associated with the security group. A provided list replaces the stored list; an empty list clears it, and omitting the field leaves it unchanged.

                • (string) --

              • vmUUIDs (list) --

                The UUIDs of the source machines associated with the security group.

                • (string) --

              • userProvidedIDs (list) --

                The user-provided identifiers of the source machines associated with the security group.

                • (string) --

          • securityGroupRule (dict) --

            Behavioral configuration for a security group rule construct.

            • enableReferencing (boolean) --

              Whether automatic conversion of CIDR-based sources and destinations to security group references applies to this rule.

type segments:

list

param segments:

A list of segment updates to apply.

  • (dict) --

    A segment update to apply during a mapping update operation.

    • segmentID (string) --

      The ID of the segment to update.

    • segmentLogicalID (string) --

      An identifier that you choose for a segment created by this request. You can use it in other constructs in the same request to refer to the new segment.

    • operation (dict) --

      The operation to perform on the segment.

      • create (dict) --

        A create operation to add a new segment.

        • name (string) -- [REQUIRED]

          The name of the new segment.

        • description (string) --

          A description of the new segment.

        • targetAccount (string) --

          The target AWS account for the new segment.

        • scopeTags (dict) --

          Scope tags for the new segment.

          • (string) --

            • (string) --

      • update (dict) --

        An update operation to modify segment properties.

        • name (string) --

          The updated name for the segment.

        • description (string) --

          The updated description for the segment.

        • targetAccount (string) --

          The updated target AWS account for the segment.

        • scopeTags (dict) --

          The updated scope tags for the segment.

          • (string) --

            • (string) --

      • delete (dict) --

        A delete operation to remove a segment from the mapping.

    • targetAccount (string) --

      The updated target AWS account for the segment.

    • scopeTags (dict) --

      The updated scope tags for the segment.

      • (string) --

        • (string) --

rtype:

dict

returns:

Response Syntax

{
    'jobID': 'string'
}

Response Structure

  • (dict) --

    • jobID (string) --

      The unique identifier of the mapping update job that was started.

StartReplication (updated) Link ¶
Changes (response)
{'dataReplicationInfo': {'stagingOutpostArn': 'string'}}

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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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': {'stagingOutpostArn': 'string'}}

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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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.

UpdateLaunchConfiguration (updated) Link ¶
Changes (both)
{'mapAutoTaggingKey': 'string'}

Updates multiple LaunchConfigurations by Source Server ID.

See also: AWS API Documentation

Request Syntax

client.update_launch_configuration(
    sourceServerID='string',
    name='string',
    launchDisposition='STOPPED'|'STARTED',
    targetInstanceTypeRightSizingMethod='NONE'|'BASIC',
    copyPrivateIp=True|False,
    copyTags=True|False,
    licensing={
        'osByol': True|False
    },
    bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
    postLaunchActions={
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'cloudWatchLogGroupName': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123,
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterType': 'STRING'|'SECURE_STRING',
                            'parameterName': 'string'
                        },
                    ]
                },
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                }
            },
        ]
    },
    enableMapAutoTagging=True|False,
    mapAutoTaggingMpeID='string',
    mapAutoTaggingKey='string',
    accountID='string'
)
type sourceServerID:

string

param sourceServerID:

[REQUIRED]

Update Launch configuration by Source Server ID request.

type name:

string

param name:

Update Launch configuration name request.

type launchDisposition:

string

param launchDisposition:

Update Launch configuration launch disposition request.

type targetInstanceTypeRightSizingMethod:

string

param targetInstanceTypeRightSizingMethod:

Update Launch configuration Target instance right sizing request.

type copyPrivateIp:

boolean

param copyPrivateIp:

Update Launch configuration copy Private IP request.

type copyTags:

boolean

param copyTags:

Update Launch configuration copy Tags request.

type licensing:

dict

param licensing:

Update Launch configuration licensing request.

  • osByol (boolean) --

    Configure BYOL OS licensing.

type bootMode:

string

param bootMode:

Update Launch configuration boot mode request.

type postLaunchActions:

dict

param postLaunchActions:

Post Launch Actions to be executed on the Test or Cutover instance.

  • deployment (string) --

    Deployment type in which AWS Systems Manager Documents will be executed.

  • s3LogBucket (string) --

    AWS Systems Manager Command's logs S3 log bucket.

  • s3OutputKeyPrefix (string) --

    AWS Systems Manager Command's logs S3 output key prefix.

  • cloudWatchLogGroupName (string) --

    AWS Systems Manager Command's CloudWatch log group name.

  • ssmDocuments (list) --

    AWS Systems Manager Documents.

    • (dict) --

      AWS Systems Manager Document.

      • actionName (string) -- [REQUIRED]

        User-friendly name for the AWS Systems Manager Document.

      • ssmDocumentName (string) -- [REQUIRED]

        AWS Systems Manager Document name or full ARN.

      • timeoutSeconds (integer) --

        AWS Systems Manager Document timeout seconds.

      • mustSucceedForCutover (boolean) --

        If true, Cutover will not be enabled if the document has failed.

      • parameters (dict) --

        AWS Systems Manager Document parameters.

        • (string) --

          • (list) --

            • (dict) --

              AWS Systems Manager Parameter Store parameter.

              • parameterType (string) -- [REQUIRED]

                AWS Systems Manager Parameter Store parameter type.

              • parameterName (string) -- [REQUIRED]

                AWS Systems Manager Parameter Store parameter name.

      • externalParameters (dict) --

        AWS Systems Manager Document external parameters.

        • (string) --

          • (dict) --

            AWS Systems Manager Document external parameter.

            • dynamicPath (string) --

              AWS Systems Manager Document external parameters dynamic path.

type enableMapAutoTagging:

boolean

param enableMapAutoTagging:

Enable map auto tagging.

type mapAutoTaggingMpeID:

string

param mapAutoTaggingMpeID:

Launch configuration map auto tagging MPE ID.

type mapAutoTaggingKey:

string

param mapAutoTaggingKey:

Launch configuration map auto tagging key.

type accountID:

string

param accountID:

Update Launch configuration Account ID.

rtype:

dict

returns:

Response Syntax

{
    'sourceServerID': 'string',
    'name': 'string',
    'ec2LaunchTemplateID': 'string',
    'launchDisposition': 'STOPPED'|'STARTED',
    'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
    'copyPrivateIp': True|False,
    'copyTags': True|False,
    'licensing': {
        'osByol': True|False
    },
    'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
    'postLaunchActions': {
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'cloudWatchLogGroupName': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123,
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterType': 'STRING'|'SECURE_STRING',
                            'parameterName': 'string'
                        },
                    ]
                },
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                }
            },
        ]
    },
    'enableMapAutoTagging': True|False,
    'mapAutoTaggingMpeID': 'string',
    'mapAutoTaggingKey': 'string'
}

Response Structure

  • (dict) --

    • sourceServerID (string) --

      Launch configuration Source Server ID.

    • name (string) --

      Launch configuration name.

    • ec2LaunchTemplateID (string) --

      Launch configuration EC2 Launch template ID.

    • launchDisposition (string) --

      Launch disposition for launch configuration.

    • targetInstanceTypeRightSizingMethod (string) --

      Launch configuration Target instance type right sizing method.

    • copyPrivateIp (boolean) --

      Copy Private IP during Launch Configuration.

    • copyTags (boolean) --

      Copy Tags during Launch Configuration.

    • licensing (dict) --

      Launch configuration OS licensing.

      • osByol (boolean) --

        Configure BYOL OS licensing.

    • bootMode (string) --

      Launch configuration boot mode.

    • postLaunchActions (dict) --

      Post Launch Actions to be executed on the Test or Cutover instance.

      • deployment (string) --

        Deployment type in which AWS Systems Manager Documents will be executed.

      • s3LogBucket (string) --

        AWS Systems Manager Command's logs S3 log bucket.

      • s3OutputKeyPrefix (string) --

        AWS Systems Manager Command's logs S3 output key prefix.

      • cloudWatchLogGroupName (string) --

        AWS Systems Manager Command's CloudWatch log group name.

      • ssmDocuments (list) --

        AWS Systems Manager Documents.

        • (dict) --

          AWS Systems Manager Document.

          • actionName (string) --

            User-friendly name for the AWS Systems Manager Document.

          • ssmDocumentName (string) --

            AWS Systems Manager Document name or full ARN.

          • timeoutSeconds (integer) --

            AWS Systems Manager Document timeout seconds.

          • mustSucceedForCutover (boolean) --

            If true, Cutover will not be enabled if the document has failed.

          • parameters (dict) --

            AWS Systems Manager Document parameters.

            • (string) --

              • (list) --

                • (dict) --

                  AWS Systems Manager Parameter Store parameter.

                  • parameterType (string) --

                    AWS Systems Manager Parameter Store parameter type.

                  • parameterName (string) --

                    AWS Systems Manager Parameter Store parameter name.

          • externalParameters (dict) --

            AWS Systems Manager Document external parameters.

            • (string) --

              • (dict) --

                AWS Systems Manager Document external parameter.

                • dynamicPath (string) --

                  AWS Systems Manager Document external parameters dynamic path.

    • enableMapAutoTagging (boolean) --

      Enable map auto tagging.

    • mapAutoTaggingMpeID (string) --

      Map auto tagging MPE ID.

    • mapAutoTaggingKey (string) --

      Map auto tagging key.

UpdateLaunchConfigurationTemplate (updated) Link ¶
Changes (both)
{'mapAutoTaggingKey': 'string'}

Updates an existing Launch Configuration Template by ID.

See also: AWS API Documentation

Request Syntax

client.update_launch_configuration_template(
    launchConfigurationTemplateID='string',
    postLaunchActions={
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'cloudWatchLogGroupName': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123,
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterType': 'STRING'|'SECURE_STRING',
                            'parameterName': 'string'
                        },
                    ]
                },
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                }
            },
        ]
    },
    enableMapAutoTagging=True|False,
    mapAutoTaggingMpeID='string',
    mapAutoTaggingKey='string',
    launchDisposition='STOPPED'|'STARTED',
    targetInstanceTypeRightSizingMethod='NONE'|'BASIC',
    copyPrivateIp=True|False,
    associatePublicIpAddress=True|False,
    copyTags=True|False,
    licensing={
        'osByol': True|False
    },
    bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
    smallVolumeMaxSize=123,
    smallVolumeConf={
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': True|False
    },
    largeVolumeConf={
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': True|False
    },
    enableParametersEncryption=True|False,
    parametersEncryptionKey='string'
)
type launchConfigurationTemplateID:

string

param launchConfigurationTemplateID:

[REQUIRED]

Launch Configuration Template ID.

type postLaunchActions:

dict

param postLaunchActions:

Post Launch Action to execute on the Test or Cutover instance.

  • deployment (string) --

    Deployment type in which AWS Systems Manager Documents will be executed.

  • s3LogBucket (string) --

    AWS Systems Manager Command's logs S3 log bucket.

  • s3OutputKeyPrefix (string) --

    AWS Systems Manager Command's logs S3 output key prefix.

  • cloudWatchLogGroupName (string) --

    AWS Systems Manager Command's CloudWatch log group name.

  • ssmDocuments (list) --

    AWS Systems Manager Documents.

    • (dict) --

      AWS Systems Manager Document.

      • actionName (string) -- [REQUIRED]

        User-friendly name for the AWS Systems Manager Document.

      • ssmDocumentName (string) -- [REQUIRED]

        AWS Systems Manager Document name or full ARN.

      • timeoutSeconds (integer) --

        AWS Systems Manager Document timeout seconds.

      • mustSucceedForCutover (boolean) --

        If true, Cutover will not be enabled if the document has failed.

      • parameters (dict) --

        AWS Systems Manager Document parameters.

        • (string) --

          • (list) --

            • (dict) --

              AWS Systems Manager Parameter Store parameter.

              • parameterType (string) -- [REQUIRED]

                AWS Systems Manager Parameter Store parameter type.

              • parameterName (string) -- [REQUIRED]

                AWS Systems Manager Parameter Store parameter name.

      • externalParameters (dict) --

        AWS Systems Manager Document external parameters.

        • (string) --

          • (dict) --

            AWS Systems Manager Document external parameter.

            • dynamicPath (string) --

              AWS Systems Manager Document external parameters dynamic path.

type enableMapAutoTagging:

boolean

param enableMapAutoTagging:

Enable map auto tagging.

type mapAutoTaggingMpeID:

string

param mapAutoTaggingMpeID:

Launch configuration template map auto tagging MPE ID.

type mapAutoTaggingKey:

string

param mapAutoTaggingKey:

Launch configuration template map auto tagging key.

type launchDisposition:

string

param launchDisposition:

Launch disposition.

type targetInstanceTypeRightSizingMethod:

string

param targetInstanceTypeRightSizingMethod:

Target instance type right-sizing method.

type copyPrivateIp:

boolean

param copyPrivateIp:

Copy private Ip.

type associatePublicIpAddress:

boolean

param associatePublicIpAddress:

Associate public Ip address.

type copyTags:

boolean

param copyTags:

Copy tags.

type licensing:

dict

param licensing:

Configure Licensing.

  • osByol (boolean) --

    Configure BYOL OS licensing.

type bootMode:

string

param bootMode:

Launch configuration template boot mode.

type smallVolumeMaxSize:

integer

param smallVolumeMaxSize:

Small volume maximum size.

type smallVolumeConf:

dict

param smallVolumeConf:

Small volume config.

  • volumeType (string) --

    Launch template disk volume type configuration.

  • iops (integer) --

    Launch template disk iops configuration.

  • throughput (integer) --

    Launch template disk throughput configuration.

  • volumeInitializationRate (integer) --

    Launch template disk volume initialization rate configuration.

  • deleteOnTermination (boolean) --

    Launch template disk delete on termination configuration.

type largeVolumeConf:

dict

param largeVolumeConf:

Large volume config.

  • volumeType (string) --

    Launch template disk volume type configuration.

  • iops (integer) --

    Launch template disk iops configuration.

  • throughput (integer) --

    Launch template disk throughput configuration.

  • volumeInitializationRate (integer) --

    Launch template disk volume initialization rate configuration.

  • deleteOnTermination (boolean) --

    Launch template disk delete on termination configuration.

type enableParametersEncryption:

boolean

param enableParametersEncryption:

Enable parameters encryption.

type parametersEncryptionKey:

string

param parametersEncryptionKey:

Parameters encryption key.

rtype:

dict

returns:

Response Syntax

{
    'launchConfigurationTemplateID': 'string',
    'arn': 'string',
    'postLaunchActions': {
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'cloudWatchLogGroupName': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123,
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterType': 'STRING'|'SECURE_STRING',
                            'parameterName': 'string'
                        },
                    ]
                },
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                }
            },
        ]
    },
    'enableMapAutoTagging': True|False,
    'mapAutoTaggingMpeID': 'string',
    'mapAutoTaggingKey': 'string',
    'tags': {
        'string': 'string'
    },
    'ec2LaunchTemplateID': 'string',
    'launchDisposition': 'STOPPED'|'STARTED',
    'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
    'copyPrivateIp': True|False,
    'associatePublicIpAddress': True|False,
    'copyTags': True|False,
    'licensing': {
        'osByol': True|False
    },
    'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
    'smallVolumeMaxSize': 123,
    'smallVolumeConf': {
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': True|False
    },
    'largeVolumeConf': {
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
        'iops': 123,
        'throughput': 123,
        'volumeInitializationRate': 123,
        'deleteOnTermination': True|False
    },
    'enableParametersEncryption': True|False,
    'parametersEncryptionKey': 'string'
}

Response Structure

  • (dict) --

    • launchConfigurationTemplateID (string) --

      ID of the Launch Configuration Template.

    • arn (string) --

      ARN of the Launch Configuration Template.

    • postLaunchActions (dict) --

      Post Launch Actions of the Launch Configuration Template.

      • deployment (string) --

        Deployment type in which AWS Systems Manager Documents will be executed.

      • s3LogBucket (string) --

        AWS Systems Manager Command's logs S3 log bucket.

      • s3OutputKeyPrefix (string) --

        AWS Systems Manager Command's logs S3 output key prefix.

      • cloudWatchLogGroupName (string) --

        AWS Systems Manager Command's CloudWatch log group name.

      • ssmDocuments (list) --

        AWS Systems Manager Documents.

        • (dict) --

          AWS Systems Manager Document.

          • actionName (string) --

            User-friendly name for the AWS Systems Manager Document.

          • ssmDocumentName (string) --

            AWS Systems Manager Document name or full ARN.

          • timeoutSeconds (integer) --

            AWS Systems Manager Document timeout seconds.

          • mustSucceedForCutover (boolean) --

            If true, Cutover will not be enabled if the document has failed.

          • parameters (dict) --

            AWS Systems Manager Document parameters.

            • (string) --

              • (list) --

                • (dict) --

                  AWS Systems Manager Parameter Store parameter.

                  • parameterType (string) --

                    AWS Systems Manager Parameter Store parameter type.

                  • parameterName (string) --

                    AWS Systems Manager Parameter Store parameter name.

          • externalParameters (dict) --

            AWS Systems Manager Document external parameters.

            • (string) --

              • (dict) --

                AWS Systems Manager Document external parameter.

                • dynamicPath (string) --

                  AWS Systems Manager Document external parameters dynamic path.

    • enableMapAutoTagging (boolean) --

      Enable map auto tagging.

    • mapAutoTaggingMpeID (string) --

      Launch configuration template map auto tagging MPE ID.

    • mapAutoTaggingKey (string) --

      Launch configuration template map auto tagging key.

    • tags (dict) --

      Tags of the Launch Configuration Template.

      • (string) --

        • (string) --

    • ec2LaunchTemplateID (string) --

      EC2 launch template ID.

    • launchDisposition (string) --

      Launch disposition.

    • targetInstanceTypeRightSizingMethod (string) --

      Target instance type right-sizing method.

    • copyPrivateIp (boolean) --

      Copy private Ip.

    • associatePublicIpAddress (boolean) --

      Associate public Ip address.

    • copyTags (boolean) --

      Copy tags.

    • licensing (dict) --

      Configure Licensing.

      • osByol (boolean) --

        Configure BYOL OS licensing.

    • bootMode (string) --

      Launch configuration template boot mode.

    • smallVolumeMaxSize (integer) --

      Small volume maximum size.

    • smallVolumeConf (dict) --

      Small volume config.

      • volumeType (string) --

        Launch template disk volume type configuration.

      • iops (integer) --

        Launch template disk iops configuration.

      • throughput (integer) --

        Launch template disk throughput configuration.

      • volumeInitializationRate (integer) --

        Launch template disk volume initialization rate configuration.

      • deleteOnTermination (boolean) --

        Launch template disk delete on termination configuration.

    • largeVolumeConf (dict) --

      Large volume config.

      • volumeType (string) --

        Launch template disk volume type configuration.

      • iops (integer) --

        Launch template disk iops configuration.

      • throughput (integer) --

        Launch template disk throughput configuration.

      • volumeInitializationRate (integer) --

        Launch template disk volume initialization rate configuration.

      • deleteOnTermination (boolean) --

        Launch template disk delete on termination configuration.

    • enableParametersEncryption (boolean) --

      Enable parameters encryption.

    • parametersEncryptionKey (string) --

      Parameters encryption key.

UpdateNetworkMigrationDefinition (updated) Link ¶
Changes (both)
{'definitionType': 'MIGRATION | NEW_NETWORK',
 'sourceConfigurations': {'sourceEnvironment': {'F5_BIGIP'}}}

Updates an existing network migration definition with new source or target configurations.

See also: AWS API Documentation

Request Syntax

client.update_network_migration_definition(
    networkMigrationDefinitionID='string',
    name='string',
    description='string',
    sourceConfigurations=[
        {
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT'|'AWS_DISCOVERY_COLLECTOR'|'MIGRATION_PLANNING_ARTIFACTS'|'F5_BIGIP',
            'sourceS3Configuration': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            }
        },
    ],
    targetS3Configuration={
        's3Bucket': 'string',
        's3BucketOwner': 'string'
    },
    targetNetwork={
        'topology': 'ISOLATED_VPC'|'HUB_AND_SPOKE',
        'inboundCidr': 'string',
        'outboundCidr': 'string',
        'inspectionCidr': 'string'
    },
    targetDeployment='SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
    vpcProvisioningStrategy='CREATE_NEW'|'USE_EXISTING',
    cidrMappings=[
        {
            'originalCidr': 'string',
            'updatedCidr': 'string'
        },
    ],
    scopeTags={
        'string': 'string'
    },
    definitionType='MIGRATION'|'NEW_NETWORK'
)
type networkMigrationDefinitionID:

string

param networkMigrationDefinitionID:

[REQUIRED]

The unique identifier of the network migration definition to update.

type name:

string

param name:

The updated name of the network migration definition.

type description:

string

param description:

The updated description of the network migration definition.

type sourceConfigurations:

list

param sourceConfigurations:

The updated list of source configurations.

  • (dict) --

    Configuration for a migration source environment.

    • sourceEnvironment (string) -- [REQUIRED]

      The source environment type.

    • sourceS3Configuration (dict) -- [REQUIRED]

      The S3 configuration for the source data.

      • s3Bucket (string) -- [REQUIRED]

        The name of the S3 bucket containing source data.

      • s3BucketOwner (string) -- [REQUIRED]

        The AWS account ID of the S3 bucket owner.

      • s3Key (string) -- [REQUIRED]

        The S3 key (path) for the source data.

type targetS3Configuration:

dict

param targetS3Configuration:

The updated S3 configuration for storing the target network artifacts.

  • s3Bucket (string) --

    The updated name of the S3 bucket.

  • s3BucketOwner (string) --

    The updated AWS account ID of the S3 bucket owner.

type targetNetwork:

dict

param targetNetwork:

The updated target network configuration.

  • topology (string) --

    The updated network topology type.

  • inboundCidr (string) --

    The updated CIDR block for inbound traffic.

  • outboundCidr (string) --

    The updated CIDR block for outbound traffic.

  • inspectionCidr (string) --

    The updated CIDR block for inspection traffic.

type targetDeployment:

string

param targetDeployment:

The updated target deployment configuration.

type vpcProvisioningStrategy:

string

param vpcProvisioningStrategy:

Updates whether the migration creates new target VPCs or uses existing ones. Set to USE_EXISTING to migrate into existing VPCs in the target account, or to CREATE_NEW to provision new target VPCs.

type cidrMappings:

list

param cidrMappings:

The updated list of CIDR mappings that map original source CIDR ranges to updated target CIDR ranges. CIDR mappings can be provided only when vpcProvisioningStrategy is set to USE_EXISTING.

  • (dict) --

    Maps a source CIDR range to the corresponding target CIDR range to use in the target network.

    • originalCidr (string) -- [REQUIRED]

      The original CIDR range in the source network.

    • updatedCidr (string) -- [REQUIRED]

      The updated CIDR range to use in the target network.

type scopeTags:

dict

param scopeTags:

The updated scope tags for the network migration definition.

  • (string) --

    • (string) --

type definitionType:

string

param definitionType:

The updated type of the network migration definition.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'networkMigrationDefinitionID': 'string',
    'name': 'string',
    'description': 'string',
    'sourceConfigurations': [
        {
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT'|'AWS_DISCOVERY_COLLECTOR'|'MIGRATION_PLANNING_ARTIFACTS'|'F5_BIGIP',
            'sourceS3Configuration': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            }
        },
    ],
    'definitionType': 'MIGRATION'|'NEW_NETWORK',
    'targetS3Configuration': {
        's3Bucket': 'string',
        's3BucketOwner': 'string'
    },
    'targetNetwork': {
        'topology': 'ISOLATED_VPC'|'HUB_AND_SPOKE',
        'inboundCidr': 'string',
        'outboundCidr': 'string',
        'inspectionCidr': 'string'
    },
    'targetDeployment': 'SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
    'vpcProvisioningStrategy': 'CREATE_NEW'|'USE_EXISTING',
    'cidrMappings': [
        {
            'originalCidr': 'string',
            'updatedCidr': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'scopeTags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the network migration definition.

    • networkMigrationDefinitionID (string) --

      The unique identifier of the network migration definition.

    • name (string) --

      The name of the network migration definition.

    • description (string) --

      A description of the network migration definition.

    • sourceConfigurations (list) --

      A list of source configurations for the network migration.

      • (dict) --

        Configuration for a migration source environment.

        • sourceEnvironment (string) --

          The source environment type.

        • sourceS3Configuration (dict) --

          The S3 configuration for the source data.

          • s3Bucket (string) --

            The name of the S3 bucket containing source data.

          • s3BucketOwner (string) --

            The AWS account ID of the S3 bucket owner.

          • s3Key (string) --

            The S3 key (path) for the source data.

    • definitionType (string) --

      Specifies the type of the definition. MIGRATION migrates an existing network. NEW_NETWORK designs a new network.

    • targetS3Configuration (dict) --

      The S3 configuration for storing the target network artifacts.

      • s3Bucket (string) --

        The name of the S3 bucket for target artifacts.

      • s3BucketOwner (string) --

        The AWS account ID of the S3 bucket owner.

    • targetNetwork (dict) --

      The target network configuration including topology and CIDR ranges.

      • topology (string) --

        The network topology type for the target environment.

      • inboundCidr (string) --

        The CIDR block for inbound traffic in the target network.

      • outboundCidr (string) --

        The CIDR block for outbound traffic in the target network.

      • inspectionCidr (string) --

        The CIDR block for inspection traffic in the target network.

    • targetDeployment (string) --

      The target deployment configuration for the migrated network.

    • vpcProvisioningStrategy (string) --

      Indicates whether the migration creates new target VPCs or uses existing ones. CREATE_NEW provisions new target VPCs; USE_EXISTING migrates into existing VPCs in the target account.

    • cidrMappings (list) --

      A list of CIDR mappings that map original source CIDR ranges to updated target CIDR ranges. CIDR mappings apply only when vpcProvisioningStrategy is set to USE_EXISTING.

      • (dict) --

        Maps a source CIDR range to the corresponding target CIDR range to use in the target network.

        • originalCidr (string) --

          The original CIDR range in the source network.

        • updatedCidr (string) --

          The updated CIDR range to use in the target network.

    • createdAt (datetime) --

      The timestamp when the network migration definition was created.

    • updatedAt (datetime) --

      The timestamp when the network migration definition was last updated.

    • tags (dict) --

      Tags assigned to the network migration definition.

      • (string) --

        • (string) --

    • scopeTags (dict) --

      Scope tags for the network migration definition.

      • (string) --

        • (string) --

UpdateReplicationConfiguration (updated) Link ¶
Changes (both)
{'outpostSnapshotLocation': 'OUTPOST | REGION'}

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,
    outpostSnapshotLocation='OUTPOST'|'REGION',
    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 outpostSnapshotLocation:

string

param outpostSnapshotLocation:

Updates the location of replication snapshots when the staging area subnet is on an AWS Outpost. Set to OUTPOST to keep replication snapshots on the Outpost, or REGION to store them in the AWS Region. Required when the staging area subnet is on an Outpost, and not allowed otherwise.

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,
    'outpostSnapshotLocation': 'OUTPOST'|'REGION',
    '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.

    • outpostSnapshotLocation (string) --

      Indicates the location of replication snapshots when the staging area subnet is on an AWS Outpost. OUTPOST keeps replication snapshots on the Outpost, and REGION stores them in the AWS Region.

    • 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)
{'outpostSnapshotLocation': 'OUTPOST | REGION'}

Updates a ReplicationConfigurationTemplate 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,
    outpostSnapshotLocation='OUTPOST'|'REGION',
    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 outpostSnapshotLocation:

string

param outpostSnapshotLocation:

Updates the location of replication snapshots in the Replication Configuration template when the staging area subnet is on an AWS Outpost. Set to OUTPOST to keep replication snapshots on the Outpost, or REGION to store them in the AWS Region. Required when the staging area subnet is on an Outpost, and not allowed otherwise.

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,
    'outpostSnapshotLocation': 'OUTPOST'|'REGION',
    '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.

    • outpostSnapshotLocation (string) --

      Indicates the location of replication snapshots in the Replication Configuration template when the staging area subnet is on an AWS Outpost. OUTPOST keeps replication snapshots on the Outpost, and REGION stores them in the AWS Region.

    • 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 (response)
{'dataReplicationInfo': {'stagingOutpostArn': 'string'}}

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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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': {'stagingOutpostArn': 'string'}}

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',
        'stagingOutpostArn': '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.

      • stagingOutpostArn (string) --

        The ARN of the AWS Outpost that hosts the staging area, when the staging area subnet is on an Outpost.

    • lifeCycle (dict) --

      Source server lifecycle state.

      • addedToServiceDateTime (string) --

        Lifecycle added to service date 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 finalized 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.