RefreshSchemas
Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
Request Syntax
{
"EndpointArn": "string",
"ReplicationInstanceArn": "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.
- EndpointArn
-
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
Type: String
Required: Yes
- ReplicationInstanceArn
-
The Amazon Resource Name (ARN) of the replication instance.
Type: String
Required: Yes
Response Syntax
{
"RefreshSchemasStatus": {
"EndpointArn": "string",
"LastFailureMessage": "string",
"LastRefreshDate": number,
"ReplicationInstanceArn": "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.
- RefreshSchemasStatus
-
The status of the refreshed schema.
Type: RefreshSchemasStatus object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
- KMSKeyNotAccessibleFault
-
AWS DMS cannot access the KMS key.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
- ResourceQuotaExceededFault
-
The quota for this resource quota has been exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
