QuickSight / Paginator / ListNamespaces

ListNamespaces

class QuickSight.Paginator.ListNamespaces

paginator = client.get_paginator('list_namespaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QuickSight.Client.list_namespaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Namespaces': [
        {
            'Name': 'string',
            'Arn': 'string',
            'CapacityRegion': 'string',
            'CreationStatus': 'CREATED'|'CREATING'|'DELETING'|'RETRYABLE_FAILURE'|'NON_RETRYABLE_FAILURE',
            'IdentityStore': 'QUICKSIGHT',
            'NamespaceError': {
                'Type': 'PERMISSION_DENIED'|'INTERNAL_SERVICE_ERROR',
                'Message': 'string'
            },
            'IamIdentityCenterApplicationArn': 'string',
            'IamIdentityCenterInstanceArn': 'string'
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • Namespaces (list) –

    The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.

    • (dict) –

      The error type.

      • Name (string) –

        The name of the error.

      • Arn (string) –

        The namespace ARN.

      • CapacityRegion (string) –

        The namespace Amazon Web Services Region.

      • CreationStatus (string) –

        The creation status of a namespace that is not yet completely created.

      • IdentityStore (string) –

        The identity store used for the namespace.

      • NamespaceError (dict) –

        An error that occurred when the namespace was created.

        • Type (string) –

          The error type.

        • Message (string) –

          The message for the error.

      • IamIdentityCenterApplicationArn (string) –

        The Amazon Resource Name (ARN) for the IAM Identity Center application.

      • IamIdentityCenterInstanceArn (string) –

        The Amazon Resource Name (ARN) for the IAM Identity Center instance.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.