GetTargetSelectionRules - AWS Database Migration Service

GetTargetSelectionRules

Converts source selection rules into their target counterparts for schema conversion operations.

Request Syntax

{ "MigrationProjectIdentifier": "string", "SelectionRules": "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.

MigrationProjectIdentifier

The migration project name or Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

SelectionRules

The JSON string representing the source selection rules for conversion. Selection rules must contain only supported metadata model types. For more information, see Selection Rules in the DMS User Guide.

Type: String

Required: Yes

Response Syntax

{ "TargetSelectionRules": "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.

TargetSelectionRules

The JSON string representing the counterpart selection rules in the target.

Type: String

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

InvalidResourceStateFault

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

message

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

message

HTTP Status Code: 400

Examples

Sample Request

This example illustrates conversion of source selection rules into their target counterparts for schema conversion operations.

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.GetTargetSelectionRules { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": {\"server-name\": \"source-database-server.us-east-1.rds.amazonaws.com\", \"database-name\": \"database1\", \"schema-name\": \"schema1\", \"table-name\": \"Table1\"}, \"rule-action\": \"explicit\"} ]}" }

Sample Response

This example illustrates one usage of GetTargetSelectionRules.

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "TargetSelectionRules": "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": {\"server-name\": \"target-database-server.us-east-1.rds.amazonaws.com\", \"schema-name\": \"database1_schema1\", \"table-name\": \"table1\"}, \"rule-action\": \"explicit\"} ]}" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: