Returns information about the task logs for the specified task.
Request Syntax
{
"Marker": "string",
"MaxRecords": number,
"ReplicationInstanceArn": "string"
}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.
- 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
Required: No
- MaxRecords
-
The maximum number of records to include in the response. If more records exist than the specified
MaxRecordsvalue, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
- ReplicationInstanceArn
-
The Amazon Resource Name (ARN) of the replication instance.
Type: String
Required: Yes
Response Syntax
{
"Marker": "string",
"ReplicationInstanceArn": "string",
"ReplicationInstanceTaskLogs": [
{
"ReplicationInstanceTaskLogSize": number,
"ReplicationTaskArn": "string",
"ReplicationTaskName": "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.
- 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
- ReplicationInstanceArn
-
The Amazon Resource Name (ARN) of the replication instance.
Type: String
- ReplicationInstanceTaskLogs
-
An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).
Type: Array of ReplicationInstanceTaskLog objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
Examples
Example
This example illustrates one usage of DescribeReplicationInstanceTaskLogs.
Sample Request
POST / HTTP/1.1
Host: dms.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256
Credential=<Credential>,
SignedHeaders=contenttype;date;host;user-
agent;x-amz-date;x-amz-target;x-amzn-
requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonDMSv20160101.DescribeReplicationInstanceTaskLogs
{
"Filters":[
{
"Name":"replication-task-arn",
"Values":[
"arn:aws:dms:us-east-
1:237565436:task:MY34U6Z4MSY52GRTIX3O4AY"
]
}
],
"MaxRecords":0,
"Marker":""
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"ReplicationInstanceTaskLogs": [
{
"ReplicationTaskArn": "arn:aws:dms:useast-
1:237565436:task:MY34U6Z4MSY52GRTIX3O4AY",
"ReplicationTaskName": "mysql-to-ddb",
"ReplicationInstanceTaskLogSize": 3726134
}
],
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:237565436:rep:CDSFSFSFFFSSUFCAY"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
