Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeDataMigrations

Returns information about data migrations.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Marker": "string",
   "MaxRecords": number,
   "WithoutSettings": boolean,
   "WithoutStatistics": boolean
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

Filters applied to the data migrations.

Type: Array of Filter objects

Required: No

Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Type: Integer

Required: No

WithoutSettings

An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose true; otherwise, choose false (the default).

Type: Boolean

Required: No

WithoutStatistics

An option to set to avoid returning information about statistics. Use this to reduce overhead when statistics information is too large. To use this option, choose true; otherwise, choose false (the default).

Type: Boolean

Required: No

Response Syntax


{
   "DataMigrations": [ 
      { 
         "DataMigrationArn": "string",
         "DataMigrationCidrBlocks": [ "string" ],
         "DataMigrationCreateTime": "string",
         "DataMigrationEndTime": "string",
         "DataMigrationName": "string",
         "DataMigrationSettings": { 
            "CloudwatchLogsEnabled": boolean,
            "NumberOfJobs": number,
            "SelectionRules": "string"
         },
         "DataMigrationStartTime": "string",
         "DataMigrationStatistics": { 
            "CDCLatency": number,
            "ElapsedTimeMillis": number,
            "FullLoadPercentage": number,
            "StartTime": "string",
            "StopTime": "string",
            "TablesErrored": number,
            "TablesLoaded": number,
            "TablesLoading": number,
            "TablesQueued": number
         },
         "DataMigrationStatus": "string",
         "DataMigrationType": "string",
         "LastFailureMessage": "string",
         "MigrationProjectArn": "string",
         "PublicIpAddresses": [ "string" ],
         "ServiceAccessRoleArn": "string",
         "SourceDataSettings": [ 
            { 
               "CDCStartPosition": "string",
               "CDCStartTime": "string",
               "CDCStopTime": "string",
               "SlotName": "string"
            }
         ],
         "StopReason": "string"
      }
   ],
   "Marker": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DataMigrations

Returns information about the data migrations used in the project.

Type: Array of DataMigration objects

Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Length Constraints: Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

FailedDependencyFault

A dependency threw an exception.

HTTP Status Code: 400

InvalidResourceStateFault

The resource is in a state that prevents it from being used for database migration.

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400