DescribeNamespace - Amazon QuickSight

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DescribeNamespace

現在の名前空間を記述します。

リクエストの構文

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

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

AwsAccountId

の IDAWSAmazonを含むアカウント QuickSight 指定する名前空間。

長さの制約: 固定長は 12 です。

パターン: ^[0-9]{12}$

必須: はい

Namespace

指定する名前空間。

長さの制約: 最大長は 64 文字です。

パターン: ^[a-zA-Z0-9._-]*$

必須: はい

リクエスト本文

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 Status Content-type: application/json { "Namespace": { "Arn": "string", "CapacityRegion": "string", "CreationStatus": "string", "IdentityStore": "string", "Name": "string", "NamespaceError": { "Message": "string", "Type": "string" } }, "RequestId": "string" }

レスポンス要素

アクションが成功すると、以下の HTTP レスポンスが返されます。

Status

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

Namespace

記述している名前空間に関する情報。レスポンスには、名前空間 ARN、name、AWS リージョン、作成ステータス、および ID ストアです。DescribeNamespace作成過程にある名前空間でも機能します。不完全な名前空間の場合、この API オペレーションは、作成プロセスに関連付けられた名前空間のエラータイプとメッセージを一覧表示します。

型: NamespaceInfoV2 オブジェクト

RequestId

-AWSこの処理のリクエスト ID。

Type: 文字列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

AccessDeniedException

このアイテムにはアクセスできません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。あなたのアカウントがAmazonの使用を許可されていることを確認してください QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401

InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500

InvalidParameterValueException

1 つ以上のパラメータに無効な値があります。

HTTP ステータスコード: 400

ResourceNotFoundException

1 つ以上のリソースが見つかりません。

HTTP ステータスコード: 404

ResourceUnavailableException

このリソースは現在使用できません。

HTTP ステータスコード: 503

ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。