QuickSight / Client / describe_namespace

describe_namespace#

QuickSight.Client.describe_namespace(**kwargs)#

Describes the current namespace.

Request Syntax

response = client.describe_namespace(
    AwsAccountId='string',
    Namespace='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
Namespace (string) –
[REQUIRED]

The namespace that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'Namespace': {
        '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) –
- Namespace (dict) –
  
  The information about the namespace that you’re describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
  - 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.

Exceptions

QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.ResourceUnavailableException