

# DescribeMetadataModelCreations
<a name="API_DescribeMetadataModelCreations"></a>

Returns a paginated list of metadata model creation requests for a migration project.

## Request Syntax
<a name="API_DescribeMetadataModelCreations_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Marker": "string",
   "MaxRecords": number,
   "MigrationProjectIdentifier": "string"
}
```

## Request Parameters
<a name="API_DescribeMetadataModelCreations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeMetadataModelCreations_RequestSyntax) **   <a name="DMS-DescribeMetadataModelCreations-request-Filters"></a>
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](API_Filter.md) objects  
Required: No

 ** [Marker](#API_DescribeMetadataModelCreations_RequestSyntax) **   <a name="DMS-DescribeMetadataModelCreations-request-Marker"></a>
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](#API_DescribeMetadataModelCreations_RequestSyntax) **   <a name="DMS-DescribeMetadataModelCreations-request-MaxRecords"></a>
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](#API_DescribeMetadataModelCreations_RequestSyntax) **   <a name="DMS-DescribeMetadataModelCreations-request-MigrationProjectIdentifier"></a>
The migration project name or Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_DescribeMetadataModelCreations_ResponseSyntax"></a>

```
{
   "Marker": "string",
   "Requests": [ 
      { 
         "Error": { ... },
         "ExportSqlDetails": { 
            "ObjectURL": "string",
            "S3ObjectKey": "string"
         },
         "MigrationProjectArn": "string",
         "Progress": { 
            "ProcessedObject": { 
               "EndpointType": "string",
               "Name": "string",
               "Type": "string"
            },
            "ProgressPercent": number,
            "ProgressStep": "string",
            "TotalObjects": number
         },
         "RequestIdentifier": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMetadataModelCreations_ResponseElements"></a>

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](#API_DescribeMetadataModelCreations_ResponseSyntax) **   <a name="DMS-DescribeMetadataModelCreations-response-Marker"></a>
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](#API_DescribeMetadataModelCreations_ResponseSyntax) **   <a name="DMS-DescribeMetadataModelCreations-response-Requests"></a>
A list of metadata model creation requests. The ExportSqlDetails field will never be populated for the DescribeMetadataModelCreations operation.  
Type: Array of [SchemaConversionRequest](API_SchemaConversionRequest.md) objects

## Errors
<a name="API_DescribeMetadataModelCreations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedFault **   
 Amazon 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
<a name="API_DescribeMetadataModelCreations_Examples"></a>

### Sample Request
<a name="API_DescribeMetadataModelCreations_Example_1"></a>

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
<a name="API_DescribeMetadataModelCreations_Example_2"></a>

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
<a name="API_DescribeMetadataModelCreations_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/dms-2016-01-01/DescribeMetadataModelCreations) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/dms-2016-01-01/DescribeMetadataModelCreations) 