Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dms ]



Returns the status of the RefreshSchemas operation.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--endpoint-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--endpoint-arn (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.


To list the refresh status for an endpoint

The following describe-refresh-schemas-status example returns the status of a previous refresh request.

aws dms describe-refresh-schemas-status \
    --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA


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


RefreshSchemasStatus -> (structure)

The status of the 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.