SMS / Client / get_replication_runs

get_replication_runs#

SMS.Client.get_replication_runs(**kwargs)#

Describes the replication runs for the specified replication job.

See also: AWS API Documentation

Request Syntax

response = client.get_replication_runs(
    replicationJobId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • replicationJobId (string) –

    [REQUIRED]

    The ID of the replication job.

  • nextToken (string) – The token for the next set of results.

  • maxResults (integer) – The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'replicationJob': {
        'replicationJobId': 'string',
        'serverId': 'string',
        'serverType': 'VIRTUAL_MACHINE',
        'vmServer': {
            'vmServerAddress': {
                'vmManagerId': 'string',
                'vmId': 'string'
            },
            'vmName': 'string',
            'vmManagerName': 'string',
            'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
            'vmPath': 'string'
        },
        'seedReplicationTime': datetime(2015, 1, 1),
        'frequency': 123,
        'runOnce': True|False,
        'nextReplicationRunStartTime': datetime(2015, 1, 1),
        'licenseType': 'AWS'|'BYOL',
        'roleName': 'string',
        'latestAmiId': 'string',
        'state': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED'|'COMPLETED'|'PAUSED_ON_FAILURE'|'FAILING',
        'statusMessage': 'string',
        'description': 'string',
        'numberOfRecentAmisToKeep': 123,
        'encrypted': True|False,
        'kmsKeyId': 'string',
        'replicationRunList': [
            {
                'replicationRunId': 'string',
                'state': 'PENDING'|'MISSED'|'ACTIVE'|'FAILED'|'COMPLETED'|'DELETING'|'DELETED',
                'type': 'ON_DEMAND'|'AUTOMATIC',
                'stageDetails': {
                    'stage': 'string',
                    'stageProgress': 'string'
                },
                'statusMessage': 'string',
                'amiId': 'string',
                'scheduledStartTime': datetime(2015, 1, 1),
                'completedTime': datetime(2015, 1, 1),
                'description': 'string',
                'encrypted': True|False,
                'kmsKeyId': 'string'
            },
        ]
    },
    'replicationRunList': [
        {
            'replicationRunId': 'string',
            'state': 'PENDING'|'MISSED'|'ACTIVE'|'FAILED'|'COMPLETED'|'DELETING'|'DELETED',
            'type': 'ON_DEMAND'|'AUTOMATIC',
            'stageDetails': {
                'stage': 'string',
                'stageProgress': 'string'
            },
            'statusMessage': 'string',
            'amiId': 'string',
            'scheduledStartTime': datetime(2015, 1, 1),
            'completedTime': datetime(2015, 1, 1),
            'description': 'string',
            'encrypted': True|False,
            'kmsKeyId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • replicationJob (dict) –

      Information about the replication job.

      • replicationJobId (string) –

        The ID of the replication job.

      • serverId (string) –

        The ID of the server.

      • serverType (string) –

        The type of server.

      • vmServer (dict) –

        Information about the VM server.

        • vmServerAddress (dict) –

          The VM server location.

          • vmManagerId (string) –

            The ID of the VM manager.

          • vmId (string) –

            The ID of the VM.

        • vmName (string) –

          The name of the VM.

        • vmManagerName (string) –

          The name of the VM manager.

        • vmManagerType (string) –

          The type of VM management product.

        • vmPath (string) –

          The VM folder path in the vCenter Server virtual machine inventory tree.

      • seedReplicationTime (datetime) –

        The seed replication time.

      • frequency (integer) –

        The time between consecutive replication runs, in hours.

      • runOnce (boolean) –

        Indicates whether to run the replication job one time.

      • nextReplicationRunStartTime (datetime) –

        The start time of the next replication run.

      • licenseType (string) –

        The license type to be used for the AMI created by a successful replication run.

      • roleName (string) –

        The name of the IAM role to be used by Server Migration Service.

      • latestAmiId (string) –

        The ID of the latest Amazon Machine Image (AMI).

      • state (string) –

        The state of the replication job.

      • statusMessage (string) –

        The description of the current status of the replication job.

      • description (string) –

        The description of the replication job.

      • numberOfRecentAmisToKeep (integer) –

        The number of recent AMIs to keep in the customer’s account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

      • encrypted (boolean) –

        Indicates whether the replication job should produce encrypted AMIs.

      • kmsKeyId (string) –

        The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

        • KMS key ID

        • KMS key alias

        • ARN referring to the KMS key ID

        • ARN referring to the KMS key alias

        If encrypted is enabled but a KMS key ID is not specified, the customer’s default KMS key for Amazon EBS is used.

      • replicationRunList (list) –

        Information about the replication runs.

        • (dict) –

          Represents a replication run.

          • replicationRunId (string) –

            The ID of the replication run.

          • state (string) –

            The state of the replication run.

          • type (string) –

            The type of replication run.

          • stageDetails (dict) –

            Details about the current stage of the replication run.

            • stage (string) –

              The current stage of a replication run.

            • stageProgress (string) –

              The progress of the current stage of a replication run.

          • statusMessage (string) –

            The description of the current status of the replication job.

          • amiId (string) –

            The ID of the Amazon Machine Image (AMI) from the replication run.

          • scheduledStartTime (datetime) –

            The start time of the next replication run.

          • completedTime (datetime) –

            The completion time of the last replication run.

          • description (string) –

            The description of the replication run.

          • encrypted (boolean) –

            Indicates whether the replication run should produce an encrypted AMI.

          • kmsKeyId (string) –

            The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

            • KMS key ID

            • KMS key alias

            • ARN referring to the KMS key ID

            • ARN referring to the KMS key alias

            If encrypted is true but a KMS key ID is not specified, the customer’s default KMS key for Amazon EBS is used.

    • replicationRunList (list) –

      Information about the replication runs.

      • (dict) –

        Represents a replication run.

        • replicationRunId (string) –

          The ID of the replication run.

        • state (string) –

          The state of the replication run.

        • type (string) –

          The type of replication run.

        • stageDetails (dict) –

          Details about the current stage of the replication run.

          • stage (string) –

            The current stage of a replication run.

          • stageProgress (string) –

            The progress of the current stage of a replication run.

        • statusMessage (string) –

          The description of the current status of the replication job.

        • amiId (string) –

          The ID of the Amazon Machine Image (AMI) from the replication run.

        • scheduledStartTime (datetime) –

          The start time of the next replication run.

        • completedTime (datetime) –

          The completion time of the last replication run.

        • description (string) –

          The description of the replication run.

        • encrypted (boolean) –

          Indicates whether the replication run should produce an encrypted AMI.

        • kmsKeyId (string) –

          The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

          • KMS key ID

          • KMS key alias

          • ARN referring to the KMS key ID

          • ARN referring to the KMS key alias

          If encrypted is true but a KMS key ID is not specified, the customer’s default KMS key for Amazon EBS is used.

    • nextToken (string) –

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

Exceptions