[ aws . dms ]

refresh-schemas

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  refresh-schemas
--endpoint-arn <value>
--replication-instance-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--endpoint-arn (string)

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

--replication-instance-arn (string)

The Amazon Resource Name (ARN) of the replication instance.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To refresh database schemas

The following refresh-schemas example requests that AWS DMS refresh the list of schemas at an endpoint.

aws dms refresh-schemas \
    --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \
    --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA"

Output:

{
    "RefreshSchemasStatus": {
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "Status": "refreshing",
        "LastRefreshDate": 1590019949.103
    }
}

Output

RefreshSchemasStatus -> (structure)

The status of the refreshed schema.

EndpointArn -> (string)

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

ReplicationInstanceArn -> (string)

The Amazon Resource Name (ARN) of the replication instance.

Status -> (string)

The status of the schema.

LastRefreshDate -> (timestamp)

The date the schema was last refreshed.

LastFailureMessage -> (string)

The last failure message for the schema.