QuickSight / Client / list_namespaces

list_namespaces#

QuickSight.Client.list_namespaces(**kwargs)#

Lists the namespaces for the specified Amazon Web Services account. This operation doesn’t list deleted namespaces.

See also: AWS API Documentation

Request Syntax

response = client.list_namespaces(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • NextToken (string) – A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

  • MaxResults (integer) – The maximum number of results to return.

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'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions