QuickSight / Client / list_topics

list_topics#

QuickSight.Client.list_topics(**kwargs)#

Lists all of the topics within an account.

Request Syntax

response = client.list_topics(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the topics that you want to list.
NextToken (string) – The token for the next set of results, or null if there are no more results.
MaxResults (integer) – The maximum number of results to be returned per request.

Return type:

dict

Returns:

Response Syntax

{
    'TopicsSummaries': [
        {
            'Arn': 'string',
            'TopicId': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) –
- TopicsSummaries (list) –
  
  A list of topic summaries.
  - (dict) –
    
    A topic summary.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the topic.
    - TopicId (string) –
      
      The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
    - Name (string) –
      
      The name of the topic.
- NextToken (string) –
  
  The token for the next set of results, or null if there are no more results.
- 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.InvalidParameterValueException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidNextTokenException
QuickSight.Client.exceptions.InternalFailureException