DatabaseMigrationService / Client / refresh_schemas

refresh_schemas#

DatabaseMigrationService.Client.refresh_schemas(**kwargs)#

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

Request Syntax

response = client.refresh_schemas(
    EndpointArn='string',
    ReplicationInstanceArn='string'
)
Parameters:

  • EndpointArn (string) –

    [REQUIRED]

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

  • ReplicationInstanceArn (string) –

    [REQUIRED]

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

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

  • DatabaseMigrationService.Client.exceptions.KMSKeyNotAccessibleFault

  • DatabaseMigrationService.Client.exceptions.ResourceQuotaExceededFault

Examples

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 describe-refresh-schemas-status operation.

response = client.refresh_schemas(
    EndpointArn='',
    ReplicationInstanceArn='',
)

print(response)

Expected Output:

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