list_dashboards

QuickSight.Client.list_dashboards(**kwargs)

Lists dashboards in an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_dashboards(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • AwsAccountId (string) --

    [REQUIRED]

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

{
    'DashboardSummaryList': [
        {
            'Arn': 'string',
            'DashboardId': 'string',
            'Name': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'PublishedVersionNumber': 123,
            'LastPublishedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • DashboardSummaryList (list) --

      A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.

      • (dict) --

        Dashboard summary.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the resource.

        • DashboardId (string) --

          Dashboard ID.

        • Name (string) --

          A display name for the dashboard.

        • CreatedTime (datetime) --

          The time that this dashboard was created.

        • LastUpdatedTime (datetime) --

          The last time that this dashboard was updated.

        • PublishedVersionNumber (integer) --

          Published version number.

        • LastPublishedTime (datetime) --

          The last time that this dashboard was published.

    • 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.InvalidNextTokenException
  • QuickSight.Client.exceptions.UnsupportedUserEditionException
  • QuickSight.Client.exceptions.InternalFailureException