# DescribeMetadataModelAssessments
<a name="API_DescribeMetadataModelAssessments"></a>

Returns a paginated list of metadata model assessments for your account in the current region.

 **Required permissions:** `dms:ListMetadataModelAssessments`. For more information, see [Actions, resources, and condition keys for Amazon Database Migration Service](https://docs.amazonaws.cn/service-authorization/latest/reference/list_awsdatabasemigrationservice.html).

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

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

## Request Parameters
<a name="API_DescribeMetadataModelAssessments_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_DescribeMetadataModelAssessments_RequestSyntax) **   <a name="DMS-DescribeMetadataModelAssessments-request-Filters"></a>
The filters to apply to the metadata model assessment requests.  
The following filter names are supported:  
+  `request-id` – The request identifier.
+  `status` – The operation status. Valid values: `RECEIVED`, `IN_PROGRESS`, `SUCCESS`, `FAILED`.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** [Marker](#API_DescribeMetadataModelAssessments_RequestSyntax) **   <a name="DMS-DescribeMetadataModelAssessments-request-Marker"></a>
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
If `Marker` is returned by a previous response, there are more results available. The value of `Marker` is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.  
Type: String  
Required: No

 ** [MaxRecords](#API_DescribeMetadataModelAssessments_RequestSyntax) **   <a name="DMS-DescribeMetadataModelAssessments-request-MaxRecords"></a>
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, Amazon DMS includes a pagination token in the response so that you can retrieve the remaining results.  
Type: Integer  
Required: No

 ** [MigrationProjectIdentifier](#API_DescribeMetadataModelAssessments_RequestSyntax) **   <a name="DMS-DescribeMetadataModelAssessments-request-MigrationProjectIdentifier"></a>
The name or Amazon Resource Name (ARN) of the migration project.  
Type: String  
Length Constraints: Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_DescribeMetadataModelAssessments_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_DescribeMetadataModelAssessments_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_DescribeMetadataModelAssessments_ResponseSyntax) **   <a name="DMS-DescribeMetadataModelAssessments-response-Marker"></a>
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
If `Marker` is returned by a previous response, there are more results available. The value of `Marker` is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.  
Type: String

 ** [Requests](#API_DescribeMetadataModelAssessments_ResponseSyntax) **   <a name="DMS-DescribeMetadataModelAssessments-response-Requests"></a>
A paginated list of metadata model assessments for the specified migration project.  
 Amazon DMS never populates the `ExportSqlDetails` field for this operation.
Type: Array of [SchemaConversionRequest](API_SchemaConversionRequest.md) objects

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

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

 ** ResourceNotFoundFault **   
The resource could not be found.    
 ** message **   

HTTP Status Code: 400

## Examples
<a name="API_DescribeMetadataModelAssessments_Examples"></a>

### Retrieve the status of metadata model assessments
<a name="API_DescribeMetadataModelAssessments_Example_1"></a>

The following example retrieves the status of metadata model assessment operations identified by their request IDs.

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

```
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.DescribeMetadataModelAssessments
{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
    "Filters": [
        {
            "Name": "request-id",
            "Values": ["a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"]
        }
    ]
}
```

#### Sample Response
<a name="API_DescribeMetadataModelAssessments_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Progress": {
                "ProgressPercent": 50.0,
                "TotalObjects": 100,
                "ProgressStep": "ANALYZING",
                "ProcessedObject": {
                    "Name": "ExampleTable",
                    "Type": "table",
                    "EndpointType": "SOURCE"
                }
            }
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again."
                }
            }
        }
    ]
}
```

## See Also
<a name="API_DescribeMetadataModelAssessments_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/DescribeMetadataModelAssessments) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/dms-2016-01-01/DescribeMetadataModelAssessments) 
+  [Amazon SDK for C\+\+](https://docs.amazonaws.cn/goto/SdkForCpp/dms-2016-01-01/DescribeMetadataModelAssessments) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/dms-2016-01-01/DescribeMetadataModelAssessments) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/dms-2016-01-01/DescribeMetadataModelAssessments) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/dms-2016-01-01/DescribeMetadataModelAssessments) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/dms-2016-01-01/DescribeMetadataModelAssessments) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/dms-2016-01-01/DescribeMetadataModelAssessments) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/dms-2016-01-01/DescribeMetadataModelAssessments) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/dms-2016-01-01/DescribeMetadataModelAssessments)