QuickSight / Client / list_templates

list_templates#

QuickSight.Client.list_templates(**kwargs)#

Lists all the templates in the current Amazon QuickSight account.

Request Syntax

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

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the templates that you’re listing.
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

{
    'TemplateSummaryList': [
        {
            'Arn': 'string',
            'TemplateId': 'string',
            'Name': 'string',
            'LatestVersionNumber': 123,
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

(dict) –
- TemplateSummaryList (list) –
  
  A structure containing information about the templates in the list.
  - (dict) –
    
    The template summary.
    - Arn (string) –
      
      A summary of a template.
    - TemplateId (string) –
      
      The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
    - Name (string) –
      
      A display name for the template.
    - LatestVersionNumber (integer) –
      
      A structure containing a list of version numbers for the template summary.
    - CreatedTime (datetime) –
      
      The last time that this template was created.
    - LastUpdatedTime (datetime) –
      
      The last time that this template was updated.
- NextToken (string) –
  
  The token for the next set of results, or null if there are no more results.
- Status (integer) –
  
  The HTTP status of the request.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.InvalidNextTokenException
QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.InternalFailureException