QuickSight / Client / describe_topic_v2

describe_topic_v2

QuickSight.Client.describe_topic_v2(**kwargs)

Describes a Q topic.

See also: AWS API Documentation

Request Syntax

response = client.describe_topic_v2(
    AwsAccountId='string',
    TopicId='string'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID of the Amazon Web Services account that contains the topic that 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.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'TopicId': 'string',
    'Topic': {
        'Name': 'string',
        'Description': 'string',
        'DataSets': [
            {
                'DataSetArn': 'string',
                'DataSetName': 'string'
            },
        ],
        'DataSetRelations': [
            {
                'Left': {
                    'DataSetArn': 'string',
                    'ColumnNames': [
                        'string',
                    ]
                },
                'Right': {
                    'DataSetArn': 'string',
                    'ColumnNames': [
                        'string',
                    ]
                }
            },
        ]
    },
    'CustomInstructions': {
        'CustomInstructionsString': 'string'
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name (ARN) of the topic.

  • TopicId (string) –

    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.

  • Topic (dict) –

    The definition of a topic.

    • Name (string) –

      The name of the topic.

    • Description (string) –

      The description of the topic.

    • DataSets (list) –

      The data sets that the topic is associated with.

      • (dict) –

        A structure that represents a data set reference of a topic.

        • DataSetArn (string) –

          The Amazon Resource Name (ARN) of the data set.

        • DataSetName (string) –

          The name of the data set.

    • DataSetRelations (list) –

      The relations between the data sets that the topic is associated with.

      • (dict) –

        A structure that represents a relation between two data sets of a topic.

        • Left (dict) –

          The left endpoint of the data set relation.

          • DataSetArn (string) –

            The Amazon Resource Name (ARN) of the data set at this endpoint of the relation.

          • ColumnNames (list) –

            The names of the columns that are used in the data set relation.

            • (string) –

        • Right (dict) –

          The right endpoint of the data set relation.

          • DataSetArn (string) –

            The Amazon Resource Name (ARN) of the data set at this endpoint of the relation.

          • ColumnNames (list) –

            The names of the columns that are used in the data set relation.

            • (string) –

  • CustomInstructions (dict) –

    Instructions that provide additional guidance and context for response generation.

    • CustomInstructionsString (string) –

      A text field for providing additional guidance or context for response generation.

  • Status (integer) –

    The HTTP status of the request.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.InternalFailureException