describe_refresh_schemas_status

DatabaseMigrationService.Client.describe_refresh_schemas_status(**kwargs)

Returns the status of the RefreshSchemas operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_refresh_schemas_status(
    EndpointArn='string'
)

Parameters

EndpointArn (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'RefreshSchemasStatus': {
        'EndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'Status': 'successful'|'failed'|'refreshing',
        'LastRefreshDate': datetime(2015, 1, 1),
        'LastFailureMessage': 'string'
    }
}

Response Structure

• (dict) --
  • RefreshSchemasStatus (dict) --

    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 (datetime) --

      The date the schema was last refreshed.

    • LastFailureMessage (string) --

      The last failure message for the schema.

Exceptions

• DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault
• DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault

Examples

Returns the status of the refresh-schemas operation.

response = client.describe_refresh_schemas_status(
    EndpointArn='',
)

print(response)

Expected Output:

{
    'RefreshSchemasStatus': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}