QuickSight / Client / create_topic_v2

create_topic_v2

QuickSight.Client.create_topic_v2(**kwargs)

Creates a new Q topic.

See also: AWS API Documentation

Request Syntax

response = client.create_topic_v2(
    AwsAccountId='string',
    TopicId='string',
    Topic={
        'Name': 'string',
        'Description': 'string',
        'DataSets': [
            {
                'DataSetArn': 'string',
                'DataSetName': 'string'
            },
        ],
        'DataSetRelations': [
            {
                'Left': {
                    'DataSetArn': 'string',
                    'ColumnNames': [
                        'string',
                    ]
                },
                'Right': {
                    'DataSetArn': 'string',
                    'ColumnNames': [
                        'string',
                    ]
                }
            },
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    FolderArns=[
        'string',
    ],
    CustomInstructions={
        'CustomInstructionsString': 'string'
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID of the Amazon Web Services account that you want to create a topic in.

• TopicId (string) –

  [REQUIRED]

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

• Topic (dict) –

  [REQUIRED]

  The definition of a topic to create.

  • Name (string) – [REQUIRED]

    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) – [REQUIRED]

        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) – [REQUIRED]

        The left endpoint of the data set relation.

        • DataSetArn (string) – [REQUIRED]

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

        • ColumnNames (list) – [REQUIRED]

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

          • (string) –

      • Right (dict) – [REQUIRED]

        The right endpoint of the data set relation.

        • DataSetArn (string) – [REQUIRED]

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

        • ColumnNames (list) – [REQUIRED]

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

          • (string) –

• Tags (list) –

  Contains a map of the key-value pairs for the resource tag or tags that are assigned to the topic.

  • (dict) –

    The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

    • Key (string) – [REQUIRED]

      Tag key.

    • Value (string) – [REQUIRED]

      Tag value.

• FolderArns (list) –

  The Amazon Resource Names (ARNs) of the folders that you want the topic to reside in.

  • (string) –

• CustomInstructions (dict) –

  Instructions that provide additional guidance and context for response generation.

  • CustomInstructionsString (string) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'TopicId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name (ARN) of the topic.

  • TopicId (string) –

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

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.ConflictException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.LimitExceededException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.ResourceExistsException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InternalFailureException