# StartMetadataModelImport
<a name="API_StartMetadataModelImport"></a>

Loads the metadata for all the dependent database objects of the parent object.

This operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.

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

```
{
   "MigrationProjectIdentifier": "string",
   "Origin": "string",
   "Refresh": boolean,
   "SelectionRules": "string"
}
```

## Request Parameters
<a name="API_StartMetadataModelImport_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.

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

 ** [Origin](#API_StartMetadataModelImport_RequestSyntax) **   <a name="DMS-StartMetadataModelImport-request-Origin"></a>
Whether to load metadata to the source or target database.  
Type: String  
Valid Values: `SOURCE | TARGET`   
Required: Yes

 ** [Refresh](#API_StartMetadataModelImport_RequestSyntax) **   <a name="DMS-StartMetadataModelImport-request-Refresh"></a>
If `true`, AWS DMS loads metadata for the specified objects from the source database.  
Type: Boolean  
Required: No

 ** [SelectionRules](#API_StartMetadataModelImport_RequestSyntax) **   <a name="DMS-StartMetadataModelImport-request-SelectionRules"></a>
A value that specifies the database objects to import.  
Type: String  
Required: Yes

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

```
{
   "RequestIdentifier": "string"
}
```

## Response Elements
<a name="API_StartMetadataModelImport_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.

 ** [RequestIdentifier](#API_StartMetadataModelImport_ResponseSyntax) **   <a name="DMS-StartMetadataModelImport-response-RequestIdentifier"></a>
The identifier for the import operation.  
Type: String

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

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

 ** AccessDeniedFault **   
 AWS DMS was denied access to the endpoint. Check that the role is correctly configured.    
 ** message **   

HTTP Status Code: 400

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

HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
 AWS DMS cannot access the KMS key.    
 ** message **   

HTTP Status Code: 400

 ** ResourceAlreadyExistsFault **   
The resource you are attempting to create already exists.    
 ** message **   
  
 ** resourceArn **   

HTTP Status Code: 400

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

HTTP Status Code: 400

 ** ResourceQuotaExceededFault **   
The quota for this resource quota has been exceeded.    
 ** message **   

HTTP Status Code: 400

 ** S3AccessDeniedFault **   
Insufficient privileges are preventing access to an Amazon S3 object.  
HTTP Status Code: 400

 ** S3ResourceNotFoundFault **   
A specified Amazon S3 bucket, bucket folder, or other object can't be found.  
HTTP Status Code: 400

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

### Example
<a name="API_StartMetadataModelImport_Example_1"></a>

This example illustrates one usage of StartMetadataModelImport.

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

```
awsdms start-metadata-model-import --migration-project-identifier
arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345 
--selection-rules "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0A1B2C3D4E5F.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}" 
--origin SOURCE --refresh false
```

## See Also
<a name="API_StartMetadataModelImport_SeeAlso"></a>

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