CreateDashboard

テンプレートからダッシュボードを作成します。最初にテンプレートを作成するには、「 CreateTemplate API 操作」を参照してください。

ダッシュボードはAmazonのエンティティです QuickSight アマゾンを識別する QuickSight 分析から作成されたレポート。Amazonを共有できます QuickSight ダッシュボード。適切なアクセス許可を使用して、スケジュール設定された E メールレポートを作成できます。適切なアクセス許可がある場合は、別のに存在するテンプレートからダッシュボードを作成できます。AWSアカウント.

リクエストの構文

POST /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1
Content-type: application/json

{
   "DashboardPublishOptions": { 
      "AdHocFilteringOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportToCSVOption": { 
         "AvailabilityStatus": "string"
      },
      "SheetControlsOption": { 
         "VisibilityState": "string"
      }
   },
   "Name": "string",
   "Parameters": { 
      "DateTimeParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "DecimalParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "IntegerParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "StringParameters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ThemeArn": "string",
   "VersionDescription": "string"
}

URI リクエストパラメータ

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

AwsAccountId

ダッシュボードを作成する AWS アカウントの ID。

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

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

必須: はい

DashboardId

IAM ポリシーにも追加されているダッシュボードの ID。

長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。

パターン: [\w\-]+

必須: はい

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

Name

ダッシュボードの表示名。

Type: 文字列

長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。

必須: はい

SourceEntity

ダッシュボードの作成時にソースとして使用しているエンティティ。In (イン)SourceEntityでは、ソースとして使用するオブジェクトのタイプを指定します。ダッシュボードはテンプレートからしか作成できないため、SourceTemplate エンティティを使用します。分析からダッシュボードを作成する必要がある場合は、まず、 CreateTemplate API オペレーションを使用して分析をテンプレートに変換します。SourceTemplate を使用する場合、ソーステンプレートの Amazon リソースネーム (ARN) を指定します。-SourceTemplateARN には任意のものを含めることができますAWSアカウントと任意の Amazon QuickSight-サポートAWS リージョン。

SourceTemplate 内の DataSetReferences エンティティを使用して、オリジナルに一覧表示されているプレースホルダーの代替データセットを一覧表示します。各データセットのスキーマは、そのプレースホルダーと一致する必要があります。

型: DashboardSourceEntity オブジェクト

必須: はい

DashboardPublishOptions

ダッシュボードの作成時にダッシュボードを公開するためのオプション:

• AdHocFilteringOption の AvailabilityStatus - このステータスは、ENABLED または DISABLED になります。これをDISABLED、アマゾン QuickSight 公開ダッシュボードの左側のフィルターペインが無効になります。このペインは、アドホック (ワンタイム) フィルタリングに使用できます。このオプションはデフォルトで ENABLED に設定されています。

• ExportToCSVOption の AvailabilityStatus - このステータスは、ENABLED または DISABLED になります。これを DISABLED に設定すると、データを .CSV 形式にエクスポートするビジュアルオプションは有効になりません。このオプションはデフォルトで ENABLED に設定されています。

• VisibilityState の SheetControlsOption - この可視性の状態は、COLLAPSED または EXPANDED になります。このオプションはデフォルトで COLLAPSED に設定されています。

型: DashboardPublishOptions オブジェクト

必須: いいえ

Parameters

デフォルト設定を上書きするために使用する、ダッシュボードを作成するためのパラメータ。ダッシュボードには任意のパラメータタイプを指定でき、パラメータによっては複数の値を受け入れることができます。

型: Parameters オブジェクト

必須: いいえ

Permissions

ダッシュボードのアクセス許可を含む構造体。この構造体を使用して、各プリンシパル ARN の IAM アクション情報のリストを提供することで、アクセス許可を付与できます。

アクセス許可を指定しない場合は、アクセス許可リストを省略します。

Type: 配列ResourcePermissionオブジェクト

配列メンバー: 最小数は 1 項目です。最大数は 64 項目です。

必須: いいえ

Tags

ダッシュボードに割り当てられたリソースタグのキーと値のペアのマップが含まれます。

Type: 配列Tagオブジェクト

配列メンバー: 最小数は 1 項目です。最大 200 項目。

必須: いいえ

ThemeArn

このダッシュボードで使用されているテーマの Amazon リソースネーム (ARN)。このフィールドに値を追加すると、ソースエンティティで使用されている値が上書きされます。テーマ ARN は、ダッシュボードを作成する AWS アカウントと同じアカウントに存在する必要があります。

Type: 文字列

必須: いいえ

VersionDescription

作成されるダッシュボードの最初のバージョンの説明。

Type: 文字列

長さの制約: 最小長は 1 です｡ 最大長は 512 です。

必須: いいえ

レスポンスの構文

HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "VersionArn": "string"
}

レスポンス要素

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

Status

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

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

Arn

ダッシュボードの ARN。

Type: 文字列

CreationStatus

ダッシュボード作成リクエストのステータス。

Type: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DashboardId

ダッシュボードの ID。

Type: 文字列

長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。

パターン: [\w\-]+

RequestId

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

Type: 文字列

VersionArn

作成された最初のバージョンのバージョン番号を含む、ダッシュボードの ARN。

Type: 文字列

エラー

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

ConflictException

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409

InternalFailureException

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

HTTP ステータスコード: 500

InvalidParameterValueException

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

HTTP ステータスコード: 400

ResourceExistsException

指定されたリソースは既に存在します。

HTTP ステータスコード: 409

ResourceNotFoundException

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

HTTP ステータスコード: 404

ThrottlingException

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

HTTP ステータスコード: 429

UnsupportedUserEditionException

このエラーは Amazon オペレーションションでオペレーションションしていることを示します。 QuickSightエディションにその操作のサポートが含まれていないサブスクリプション。アマゾンアマゾン QuickSight 現在、Standard Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。​

HTTP ステータスコード: 403

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

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS向け SDK JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3