DescribeMetadataModelCreations
Returns a paginated list of metadata model creation requests for a migration project.
Request Syntax
{
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"Marker": "string",
"MaxRecords": number,
"MigrationProjectIdentifier": "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.
- Filters
-
Filters applied to the metadata model creation requests described in the form of key-value pairs. The supported filters are request-id and status.
Type: Array of Filter objects
Required: No
- Marker
-
Specifies the unique pagination token that makes it possible to display the next page of metadata model creation requests. If Marker is returned by a previous response, there are more metadata model creation requests available.
Type: String
Required: No
- MaxRecords
-
The maximum number of metadata model creation requests to include in the response. If more requests exist than the specified MaxRecords value, a pagination token is provided in the response so that you can retrieve the remaining results.
Type: Integer
Required: No
- MigrationProjectIdentifier
-
The migration project name or Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
Response Syntax
{
"Marker": "string",
"Requests": [
{
"Error": { ... },
"ExportSqlDetails": {
"ObjectURL": "string",
"S3ObjectKey": "string"
},
"MigrationProjectArn": "string",
"RequestIdentifier": "string",
"Status": "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
-
Specifies the unique pagination token that makes it possible to display the next page of metadata model creation requests. If Marker is returned, there are more metadata model creation requests available.
Type: String
- Requests
-
A list of metadata model creation requests. The ExportSqlDetails field will never be populated for the DescribeMetadataModelCreations operation.
Type: Array of SchemaConversionRequest objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
AWS DMS was denied access to the endpoint. Check that the role is correctly configured.
- message
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
- message
HTTP Status Code: 400
Examples
Sample Request
This example illustrates retrieval of a metadata model creation requests for a migration project. The provided filter allow querying specific request by its identifier. The response includes a list of creation requests with their current status and details.
POST / HTTP/1.1 Host: dms.<region>.<domain> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<SignedHeaders>, Signature=<Signature> X-Amz-Date: <Date> X-Amz-Target: AmazonDMSv20160101.DescribeMetadataModelCreations { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Filters": [ { "Name": "request-id", "Values": [ "00000000-0000-0000-0000-000000000000" ] } ] }
Sample Response
This example illustrates one usage of DescribeMetadataModelCreations.
HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "Requests": [ { "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "00000000-0000-0000-0000-000000000000", "Status": "SUCCESS" } ] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
