schemas
Creates, updates, deletes, gets or lists a schemas resource.
Overview
| Name | schemas |
| Type | Resource |
| Id | aws.dms.schemas |
Fields
The following fields are returned by SELECT queries:
- describe_schemas
| Name | Datatype | Description |
|---|---|---|
schema | string | The described schema. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_schemas | select | region | Returns information about the schema for the specified endpoint. | |
refresh_schemas | exec | region, EndpointArn, ReplicationInstanceArn | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_schemas
Returns information about the schema for the specified endpoint.
SELECT
schema
FROM aws.dms.schemas
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- refresh_schemas
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.
EXEC aws.dms.schemas.refresh_schemas
@region='{{ region }}' --required
@@json=
'{
"EndpointArn": "{{ EndpointArn }}",
"ReplicationInstanceArn": "{{ ReplicationInstanceArn }}"
}'
;