Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeNamespace

Describes the current namespace.

Request Syntax


GET /accounts/AwsAccountId/namespaces/Namespace HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID for the AWS account that contains the Amazon QuickSight namespace that you want to describe.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Namespace

The namespace that you want to describe.

Length Constraints: Maximum length of 64.

Pattern: ^[a-zA-Z0-9._-]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Namespace": { 
      "Arn": "string",
      "CapacityRegion": "string",
      "CreationStatus": "string",
      "IamIdentityCenterApplicationArn": "string",
      "IamIdentityCenterInstanceArn": "string",
      "IdentityStore": "string",
      "Name": "string",
      "NamespaceError": { 
         "Message": "string",
         "Type": "string"
      }
   },
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

Namespace

The information about the namespace that you're describing. The response includes the namespace ARN, name, AWS 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.

Type: NamespaceInfoV2 object

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

HTTP Status Code: 429