QuickSight / Client / describe_topic_refresh

describe_topic_refresh#

QuickSight.Client.describe_topic_refresh(**kwargs)#

Describes the status of a topic refresh.

See also: AWS API Documentation

Request Syntax

response = client.describe_topic_refresh(
    AwsAccountId='string',
    TopicId='string',
    RefreshId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.

  • TopicId (string) –

    [REQUIRED]

    The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • RefreshId (string) –

    [REQUIRED]

    The ID of the refresh, which is performed when the topic is created or updated.

Return type:

dict

Returns:

Response Syntax

{
    'RefreshDetails': {
        'RefreshArn': 'string',
        'RefreshId': 'string',
        'RefreshStatus': 'INITIALIZED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • RefreshDetails (dict) –

      Details of the refresh, which is performed when the topic is created or updated.

      • RefreshArn (string) –

        The Amazon Resource Name (ARN) of the topic refresh.

      • RefreshId (string) –

        The ID of the refresh, which occurs as a result of topic creation or topic update.

      • RefreshStatus (string) –

        The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions