table of contents - aws documentation...amazon quicksight リソースのアク セス許可...

Post on 21-Feb-2021

3 Views

Category:

Documents

0 Downloads

Preview:

Click to see full reader

TRANSCRIPT

Table of ContentsWelcome ........................................................................................................................................... 1概要 .................................................................................................................................................. 2用語と概念 ........................................................................................................................................ 3Amazon QuickSight API の使用 ............................................................................................................ 5

API リクエストを行う ................................................................................................................. 5前提知識 ............................................................................................................................ 5Amazon QuickSight の利用可能な API オペレーション ............................................................. 5

Amazon QuickSight の ARN ......................................................................................................... 7ARN 形式 .......................................................................................................................... 7Amazon QuickSight リソース ARN ........................................................................................ 9

アクセス許可 ............................................................................................................................ 10エラー ..................................................................................................................................... 10

共通のクライアントエラー ................................................................................................. 11クライアントエラー .......................................................................................................... 12サーバーエラー ................................................................................................................. 14

トピック別の API オペレーション ....................................................................................................... 15アクセス管理オペレーション ...................................................................................................... 15

QuickSight 名前空間API オペレーション .............................................................................. 15グループ操作 .................................................................................................................... 15ユーザー操作 .................................................................................................................... 16IAM ポリシー割り当てオペレーション .................................................................................. 16アセットおよびリソースのアクセス許可操作 ......................................................................... 16

設定を制御する操作 .................................................................................................................. 17グローバル設定のための QuickSight API オペレーション ........................................................ 17カスタマイズのための QuickSight API オペレーション ........................................................... 17QuickSight タグ API オペレーション ................................................................................... 17

オペレーションの埋め込み ......................................................................................................... 18資産管理業務 ............................................................................................................................ 18

QuickSight 分析 API オペレーション ................................................................................... 18QuickSight ダッシュボード API オペレーション .................................................................... 18QuickSight テンプレート API オペレーション ....................................................................... 19QuickSight テーマ API オペレーション ................................................................................ 19

データリソースのオペレーション ................................................................................................ 19データソースの QuickSight API オペレーション .................................................................... 20データセットの QuickSight API オペレーション .................................................................... 20SPICE データを更新するための QuickSight API オペレーション (SPICE 取り込み) ..................... 20

API Reference Index ......................................................................................................................... 21Actions .................................................................................................................................... 21

CancelIngestion ................................................................................................................ 24CreateAccountCustomization .............................................................................................. 27CreateAnalysis ................................................................................................................. 31CreateDashboard .............................................................................................................. 36CreateDataSet .................................................................................................................. 42CreateDataSource ............................................................................................................. 49CreateGroup .................................................................................................................... 57CreateGroupMembership .................................................................................................... 61CreateIAMPolicyAssignment ............................................................................................... 64CreateIngestion ................................................................................................................ 68CreateNamespace ............................................................................................................. 71CreateTemplate ................................................................................................................ 75CreateTemplateAlias ......................................................................................................... 80CreateTheme ................................................................................................................... 83CreateThemeAlias ............................................................................................................. 88DeleteAccountCustomization ............................................................................................... 91

i

DeleteAnalysis .................................................................................................................. 94DeleteDashboard .............................................................................................................. 97DeleteDataSet ................................................................................................................ 100DeleteDataSource ........................................................................................................... 103DeleteGroup ................................................................................................................... 106DeleteGroupMembership .................................................................................................. 109DeleteIAMPolicyAssignment .............................................................................................. 112DeleteNamespace ........................................................................................................... 115DeleteTemplate ............................................................................................................... 118DeleteTemplateAlias ........................................................................................................ 121DeleteTheme .................................................................................................................. 124DeleteThemeAlias ........................................................................................................... 127DeleteUser ..................................................................................................................... 130DeleteUserByPrincipalId ................................................................................................... 133DescribeAccountCustomization .......................................................................................... 136DescribeAccountSettings .................................................................................................. 140DescribeAnalysis ............................................................................................................. 143DescribeAnalysisPermissions ............................................................................................ 146DescribeDashboard ......................................................................................................... 149DescribeDashboardPermissions ......................................................................................... 152DescribeDataSet ............................................................................................................. 155DescribeDataSetPermissions ............................................................................................. 160DescribeDataSource ........................................................................................................ 163DescribeDataSourcePermissions ....................................................................................... 169DescribeGroup ................................................................................................................ 172DescribeIAMPolicyAssignment ........................................................................................... 175DescribeIngestion ............................................................................................................ 178DescribeNamespace ........................................................................................................ 181DescribeTemplate ............................................................................................................ 184DescribeTemplateAlias ..................................................................................................... 188DescribeTemplatePermissions ........................................................................................... 191DescribeTheme ............................................................................................................... 194DescribeThemeAlias ........................................................................................................ 198DescribeThemePermissions .............................................................................................. 201DescribeUser .................................................................................................................. 204GetDashboardEmbedUrl ................................................................................................... 207GetSessionEmbedUrl ....................................................................................................... 212ListAnalyses ................................................................................................................... 216ListDashboards ............................................................................................................... 219ListDashboardVersions ..................................................................................................... 222ListDataSets ................................................................................................................... 225ListDataSources .............................................................................................................. 228ListGroupMemberships ..................................................................................................... 234ListGroups ...................................................................................................................... 237ListIAMPolicyAssignments ................................................................................................ 240ListIAMPolicyAssignmentsForUser ..................................................................................... 243ListIngestions .................................................................................................................. 246ListNamespaces .............................................................................................................. 249ListTagsForResource ....................................................................................................... 252ListTemplateAliases ......................................................................................................... 254ListTemplates ................................................................................................................. 257ListTemplateVersions ....................................................................................................... 260ListThemeAliases ............................................................................................................ 263ListThemes ..................................................................................................................... 266ListThemeVersions .......................................................................................................... 269ListUserGroups ............................................................................................................... 272ListUsers ........................................................................................................................ 275

ii

RegisterUser .................................................................................................................. 278RestoreAnalysis .............................................................................................................. 284SearchAnalyses .............................................................................................................. 287SearchDashboards .......................................................................................................... 290TagResource .................................................................................................................. 293UntagResource ............................................................................................................... 296UpdateAccountCustomization ............................................................................................ 298UpdateAccountSettings .................................................................................................... 301UpdateAnalysis ............................................................................................................... 304UpdateAnalysisPermissions .............................................................................................. 308UpdateDashboard ............................................................................................................ 312UpdateDashboardPermissions ........................................................................................... 317UpdateDashboardPublishedVersion .................................................................................... 321UpdateDataSet ............................................................................................................... 324UpdateDataSetPermissions ............................................................................................... 331UpdateDataSource .......................................................................................................... 335UpdateDataSourcePermissions .......................................................................................... 342UpdateGroup .................................................................................................................. 345UpdateIAMPolicyAssignment ............................................................................................. 348UpdateTemplate .............................................................................................................. 352UpdateTemplateAlias ....................................................................................................... 356UpdateTemplatePermissions ............................................................................................. 359UpdateTheme ................................................................................................................. 363UpdateThemeAlias .......................................................................................................... 368UpdateThemePermissions ................................................................................................ 371UpdateUser .................................................................................................................... 375

データ型 ................................................................................................................................ 379AccountCustomization ...................................................................................................... 383AccountSettings .............................................................................................................. 384ActiveIAMPolicyAssignment .............................................................................................. 386AdHocFilteringOption ....................................................................................................... 387AmazonElasticsearchParameters ....................................................................................... 388Analysis ......................................................................................................................... 389AnalysisError .................................................................................................................. 391AnalysisSearchFilter ........................................................................................................ 392AnalysisSourceEntity ........................................................................................................ 393AnalysisSourceTemplate .................................................................................................. 394AnalysisSummary ............................................................................................................ 395AthenaParameters ........................................................................................................... 397AuroraParameters ........................................................................................................... 398AuroraPostgreSqlParameters ............................................................................................ 399AwsIotAnalyticsParameters ............................................................................................... 400BorderStyle .................................................................................................................... 401CalculatedColumn ........................................................................................................... 402CastColumnTypeOperation ............................................................................................... 403ColumnDescription .......................................................................................................... 404ColumnGroup ................................................................................................................. 405ColumnGroupColumnSchema ........................................................................................... 406ColumnGroupSchema ...................................................................................................... 407ColumnLevelPermissionRule ............................................................................................. 408ColumnSchema ............................................................................................................... 409ColumnTag ..................................................................................................................... 410CreateColumnsOperation .................................................................................................. 411CredentialPair ................................................................................................................. 412CustomSql ..................................................................................................................... 413Dashboard ..................................................................................................................... 414DashboardError ............................................................................................................... 416

iii

DashboardPublishOptions ................................................................................................. 417DashboardSearchFilter ..................................................................................................... 418DashboardSourceEntity .................................................................................................... 419DashboardSourceTemplate ............................................................................................... 420DashboardSummary ........................................................................................................ 421DashboardVersion ........................................................................................................... 423DashboardVersionSummary .............................................................................................. 425DataColorPalette ............................................................................................................. 427DataSet ......................................................................................................................... 428DataSetConfiguration ....................................................................................................... 431DataSetReference ........................................................................................................... 432DataSetSchema .............................................................................................................. 433DataSetSummary ............................................................................................................ 434DataSource .................................................................................................................... 436DataSourceCredentials ..................................................................................................... 439DataSourceErrorInfo ........................................................................................................ 440DataSourceParameters .................................................................................................... 441DateTimeParameter ......................................................................................................... 444DecimalParameter ........................................................................................................... 445ErrorInfo ........................................................................................................................ 446ExportToCSVOption ......................................................................................................... 447FieldFolder ..................................................................................................................... 448FilterOperation ................................................................................................................ 449GeoSpatialColumnGroup .................................................................................................. 450Group ............................................................................................................................ 451GroupMember ................................................................................................................. 452GutterStyle ..................................................................................................................... 453IAMPolicyAssignment ....................................................................................................... 454IAMPolicyAssignmentSummary .......................................................................................... 456Ingestion ........................................................................................................................ 457InputColumn ................................................................................................................... 459IntegerParameter ............................................................................................................. 460JiraParameters ................................................................................................................ 461JoinInstruction ................................................................................................................. 462JoinKeyProperties ............................................................................................................ 464LogicalTable ................................................................................................................... 465LogicalTableSource ......................................................................................................... 466ManifestFileLocation ........................................................................................................ 467MarginStyle .................................................................................................................... 468MariaDbParameters ......................................................................................................... 469MySqlParameters ............................................................................................................ 470NamespaceError ............................................................................................................. 471NamespaceInfoV2 ........................................................................................................... 472OracleParameters ............................................................................................................ 474OutputColumn ................................................................................................................. 475Parameters ..................................................................................................................... 476PhysicalTable ................................................................................................................. 477PostgreSqlParameters ...................................................................................................... 478PrestoParameters ............................................................................................................ 479ProjectOperation ............................................................................................................. 480QueueInfo ...................................................................................................................... 481RdsParameters ............................................................................................................... 482RedshiftParameters ......................................................................................................... 483RelationalTable ............................................................................................................... 485RenameColumnOperation ................................................................................................. 487ResourcePermission ........................................................................................................ 488RowInfo ......................................................................................................................... 489

iv

RowLevelPermissionDataSet ............................................................................................. 490S3Parameters ................................................................................................................. 492S3Source ....................................................................................................................... 493ServiceNowParameters .................................................................................................... 494Sheet ............................................................................................................................ 495SheetControlsOption ........................................................................................................ 496SheetStyle ...................................................................................................................... 497SnowflakeParameters ...................................................................................................... 498SparkParameters ............................................................................................................. 499SqlServerParameters ....................................................................................................... 500SslProperties .................................................................................................................. 501StringParameter .............................................................................................................. 502Tag ............................................................................................................................... 503TagColumnOperation ....................................................................................................... 504Template ........................................................................................................................ 505TemplateAlias ................................................................................................................. 507TemplateError ................................................................................................................. 508TemplateSourceAnalysis .................................................................................................. 509TemplateSourceEntity ...................................................................................................... 510TemplateSourceTemplate ................................................................................................. 511TemplateSummary .......................................................................................................... 512TemplateVersion ............................................................................................................. 514TemplateVersionSummary ................................................................................................ 516TeradataParameters ........................................................................................................ 518Theme ........................................................................................................................... 519ThemeAlias .................................................................................................................... 521ThemeConfiguration ......................................................................................................... 522ThemeError .................................................................................................................... 523ThemeSummary .............................................................................................................. 524ThemeVersion ................................................................................................................ 526ThemeVersionSummary ................................................................................................... 528TileLayoutStyle ............................................................................................................... 530TileStyle ......................................................................................................................... 531TransformOperation ......................................................................................................... 532TwitterParameters ........................................................................................................... 534UIColorPalette ................................................................................................................ 535UploadSettings ................................................................................................................ 538User .............................................................................................................................. 540VpcConnectionProperties .................................................................................................. 543

一般的なエラー ....................................................................................................................... 543共通パラメータ ....................................................................................................................... 545

AWS の用語集 ................................................................................................................................ 547.................................................................................................................................................. dxlviii

v

WelcomeAmazon QuickSight は、AWS クラウド向けの完全マネージド型のサーバーレスビジネスインテリジェンスサービスで、データと洞察を組織内のすべてのユーザーに簡単に拡張できます。この API リファレンスには、Amazon QuickSight を管理するために使用できるプログラミングインターフェイスのドキュメントが含まれます。

この文書は、2021年5月27日に最後に発行されました。

1

OverviewAmazon QuickSight API リファレンスでは、Amazon QuickSight でジョブを作成、管理するための各オペレーションとデータタイプの説明、構文、使用例が分かります。API オペレーションを使用して、AmazonQuickSight デプロイをプログラムで展開したり管理することができます。

AWS SDK の 1 つを使用して、使用しているプログラミング言語またはプラットフォームに合わせた APIオペレーションにアクセスすることもできます。詳細については、AWS SDK をご参照ください。

目的 関連資料

API リクエストの作成の詳細情報 API リクエストを行う (p. 5)

トピック別に整理された API オペレーションのリストを表示する

トピック別の Amazon QuickSight API オペレーション (p. 15)

API 操作、データ型、一般的なパラメータとエラーのアルファベット順のインデックスを参照してください。

API Reference Index (p. 21)

リソースレベルのアクセス許可の詳細情報

Amazon QuickSight リソースのアクセス許可 (p. 10)

Amazon QuickSight の詳細については、」Amazon QuickSight ユーザーガイド。

2

用語と概念このセクションでは、Amazon QuickSight の開発用語の一覧を提供します。

発信者 ID: — API リクエストを行う AWS Identity and Access Management (IAM) ユーザーの ID。発信者ID は、リクエストにアタッチされている署名を使用して Amazon QuickSight により決定されます。提供される SDK クライアントを使用することで、署名の生成、またはリクエストへの署名のアタッチを手動で実行する必要がなくなります。ただし、必要であれば手動で行うこともできます。

呼び出し元の ID: 発信者 ID に加えて (代替としてではなく)、発信者 ID に加えて (発信者 ID に加えて)、AssumeRoleAmazon QuickSight 発信者は、呼び出し元 ID により承認されます。これは、同じAmazon QuickSight サブスクリプションに属している複数のアカウントを明示的に追加することを避けるために行われます。

QuickSight ARN: — Amazon リソースネーム (ARN)。Amazon QuickSight リソースは、名前または ARNを使用して識別されます。たとえば、これらは MyGroup1 という名前のグループの ARN、User1 という名前のユーザー、ID が 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 となるダッシュボードです。

arn:aws:quicksight:us-east-1:111122223333:group/default/MyGroup1arn:aws:quicksight:us-east-1:111122223333:user/default/User1arn:aws:quicksight:us-west-2:111122223333:dashboard/1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89

次の例では、「MyTemplate」という名前のテンプレートと「MyDashboard」という名前のダッシュボードの ARN を示しています。

1. テンプレートのサンプル ARN

arn:aws:quicksight:us-east-1:111122223333:template/MyTemplate

2. テンプレートの特定のバージョンを参照する、テンプレートのサンプル ARN

arn:aws:quicksight:us-east-1:111122223333:template/MyTemplate/version/10

3. テンプレートエイリアスのサンプル ARN

arn:aws:quicksight:us-east-1:111122223333:template/MyTemplate/alias/STAGING

4. ダッシュボードのサンプル ARN

arn:aws:quicksight:us-east-1:111122223333:dashboard/MyDashboard

5. ダッシュボードの特定のバージョンを参照する、ダッシュボードのサンプル ARN

arn:aws:quicksight:us-east-1:111122223333:dashboard/MyDashboard/version/10

シナリオによっては、エンティティの名前、ID、ARN の指定が必要になる場合があります。名前がある場合は、一部の QuickSight API オペレーションを使用して ARN を取得できます。

QuickSight ダッシュボード: — 分析またはテンプレートから作成された QuickSight レポートを識別するエンティティです。QuickSight ダッシュボードは共有可能です。適切な権限で、スケジュールされた電子メールレポートを作成できます。-CreateDashboardおよびDescribeDashboardAPI 操作は、ダッシュボードエンティティに対して作用します。

3

QuickSight テンプレート: — 分析またはダッシュボードの作成に必要なメタデータをカプセル化するエンティティです。分析に関連付けられたデータセットをプレースホルダに置き換えることで、抽象化します。データセットプレースホルダーをソース分析およびテンプレートの作成に使用したのと同じスキーマに従うデータセットに置き換えることにより、テンプレートを使用してダッシュボードを作成できます。

QuickSight ユーザー: — これは、API 呼び出しによって処理される Amazon QuickSight ユーザー ID です。発信者 ID と同じではありませんが、Amazon QuickSight 内のユーザーにマッピングするユーザーである可能性があります。

4

API リクエストを行う

Amazon QuickSight API の使用Amazon QuickSight API の使用開始方法を以下に示します。

トピック• API リクエストを行う (p. 5)• Amazon QuickSight の Amazon リソースネーム (ARN) (p. 7)• Amazon QuickSight リソースのアクセス許可 (p. 10)• Amazon QuickSight API エラー (p. 10)

API リクエストを行うAmazon QuickSight 用の API と、任意のプログラミング言語で Amazon QuickSight にアクセスできるAWS SDK が用意されています。Amazon QuickSight を使用すると、AWS SDK を使用したデプロイの一部の側面を管理できます。

アカウントの Amazon QuickSight API 宛ての呼び出しをモニタリングするには、AWS CloudTrail を使用します。CloudTrail は、AWS マネジメントコンソール、コマンドラインツール、その他のサービスによって行われる呼び出しをモニタリングできます。詳細については、AWS CloudTrail ユーザーガイドを参照してください。

コンテンツ• 前提知識 (p. 5)• Amazon QuickSight の利用可能な API オペレーション (p. 5)

前提知識API を介して Amazon QuickSight にアクセスする場合、以下について理解しておく必要があります。

• JSON• ウェブサービス• HTTP リクエスト• JavaScript、Java、Python、C# などの 1 つ以上のプログラミング言語。

AWS にアクセスすることをお勧めしますリソースセンターのご利用開始にあたってを参照して、AWSSDK とツールキットが提供すべき内容を確認してください。

端末とお気に入りのテキストエディタを使用することもできますが、統合開発環境 (IDE) でより視覚的なUI エクスペリエンスが得られる利点もあります。IDE のリストは、AWS ご利用開始にあたってリソースセンター()IDE および IDE ツールキットセクションに追加します。このサイトには、お好みの IDE 用にダウンロードできる AWS ツールキットが用意されています。一部の IDE では、プログラミング言語の詳細を知るのに役立てることができるチュートリアルが用意されています。

Amazon QuickSight の利用可能な API オペレーションAmazon QuickSight API オペレーションは、以下を提供します

• ユーザーとグループの管理

5

Amazon QuickSight の利用可能な API オペレーション

• データ管理(データソース、データセット、テンプレート、SPICE 取り込み)• ダッシュボードと分析管理• テンプレートの管理• アクセス権限の管理• カスタマイズの管理

AWS は、HTTPS 経由でリクエストを送信する代わりに、言語固有の API オペレーションを使用してアプリケーションを構築するソフトウェア開発者向けのライブラリ、サンプルコード、チュートリアル、その他のリソースを提供します。これらのライブラリには、リクエストの暗号化署名、リクエストの再試行、エラーレスポンスの処理などのタスクを自動化する基本的な機能が用意されています。これらのライブラリを使用すると、簡単に開始できます。

AWS SDK のダウンロードの詳細については、「AWS SDK とツール」を参照してください。次のリンクは、利用可能な言語固有の API ドキュメントのサンプルです。

AWS Command Line Interface

• AWS CLI QuickSight コマンドリファレンス• AWS CLI ユーザーガイド• AWS CLI コマンドリファレンス

AWS SDK for .NET

• Quicksight• Amazon.クイックサイト.モデル

AWS SDK for C++

• AWS# QuickSight# QuickSight クライアントクラスリファレンス

AWS SDK for Go

• QuickSight

AWS SDK for Java

• com.amazonaws.services quicksight• com.amazonaws.services.quicksight.モデル

AWS SDK for JavaScript

• QuickSight

AWS SDK for PHP

• クイックサイトクライアント

AWS SDK for Python (Boto3)

• QuickSight

6

Amazon QuickSight の ARN

AWS SDK for Ruby

• AWS# QuickSight

Amazon QuickSight の Amazon リソースネーム(ARN)

Amazon リソースネーム (ARN) は、AWS リソースを一意に識別します。ARN は、IAM ポリシー、Amazon RDS (Amazon Relational Database Service RDS) タグ、API コールなど、すべての AWS全体でリソースを明確に識別します。Amazon QuickSight リソースの ARN を取得するには、Describe関連するリソースに対する操作。

このセクションでは、ARN の動作について学習できます。ここで説明する資料は、Amazon QuickSight 専用サンプルです。

トピック• ARN 形式 (p. 7)• Amazon QuickSight リソース ARN (p. 9)

ARN 形式ARN はコロンで区切られ、セグメント、コロン (:). ARN のセグメントで使用される特定のコンポーネントと値は、ARN がどの AWS サービスであるかによって異なります。次の例は、ARN の構築方法を示しています。

arn:partition:service:region:account-id:resource-idarn:partition:service:region:account-id:resource-type/resource-idarn:partition:service:region:account-id:resource-type:resource-id

これらの ARN には、次のセグメントが含まれます。

partition— リソースが置かれているパーティションです。標準の AWS リージョンの場合、パーティションはaws。他のパーティションにリソースがある場合、パーティションはです。AWS パパパパパパパパ。たとえば、中国 (北京) リージョンにあるリソースのパーティションは、aws-cnです。

service— AWS 製品を識別するサービス名前空間。例:quicksightAmazon QuickSight を識別します。s3Amazon S3 を識別し、iamIAM などを識別します。

region— リソースが置かれている AWS リージョン。一部のリソースの ARN は AWS リージョンを必要としないので、S3 の場合のようにこの要素は省略されます。Amazon QuickSight ARN には AWS リージョンが必要です。

account-id— リソースを所有する AWS アカウントの ID。ARN または API オペレーションでアカウント番号を使用する場合は、ハイフンを省略します(たとえば、123456789012)。一部のリソースの ARNはアカウント番号を必要としないので、この要素は省略されます。Amazon QuickSight ARN には、AWSアカウント番号が必要です。ただし、以下に示すように、アカウント番号と AWS リージョンは S3 バケット ARN から省略されます。

arn:aws:s3:::bucket_namearn:aws:s3:::bucket_name/key_name

resourceまたはresource-type— ARN のこの部分のコンテンツは、サービスによって異なります。リソース識別子は、リソースの名前または ID です (例:user/Bobまたはinstance/i-1234567890abcdef0) またはリソースパスです。たとえば、一部のリソース識別子には、親リ

7

ARN 形式

ソース (sub-resource-type/parent-resource/sub-resource) またはバージョンなどの修飾子(resource-type:resource-name:パパパ).

一部のリソース ARN には、パス、変数、ワイルドカードを含めることができます。

ワイルドカード文字 (*および?) を任意の ARN セグメント内に格納します。アスタリスク (*) は 0 個以上の文字の任意の組み合わせを表し、疑問符 (?) は任意の 1 文字を表します。各セグメントで複数の * または ? の文字を使用することができますが、ワイルドカードはセグメントをまたぐことができません。アクセス許可に ARN を使用している場合は、*ワイルドカードを使用して、必要な要素のみへのアクセスを制限します。パス、ワイルドカード、変数の使用例をいくつか以下に示します。

次の例では、S3 ARN を使用します。これは、IAM ポリシーで S3 にアクセス許可を付与する場合に使用できます。この S3 ARN は、パスとファイルが指定されていることを示します。

Note

用語キー名は、後のパスとファイルのように見えるものを記述するために使用されますbucketname/。バケットには、コンピュータのファイルシステムで使用されているようなフォルダ構造が実際には含まれていないため、これらはキー名と呼ばれます。代わりに、スラッシュ(/)は、バケットの編成をより直感的にするのに役立つ区切り文字です。この場合、バケット名はexamplebucketであり、キー名はdevelopers/design_info.doc。

arn:aws:s3:::examplebucket/my-data/sales-export-2019-q4.json

バケット内のすべてのオブジェクトを識別する場合は、次のようにワイルドカードを使用して、すべてのキー名(またはパスとファイル)が ARN に含まれていることを示します。

arn:aws:s3:::examplebucket/*

キー名の一部とワイルドカードを使用して、特定のパターンで始まるすべてのオブジェクトを識別できます。この場合、次に示すように、フォルダ名とワイルドカードに似ています。ただし、この ARN には、my-data。

arn:aws:s3:::examplebucket/my-data/*

ワイルドカードを追加することで、部分的な名前を指定できます。これは、で始まる任意のオブジェクトを識別しますmy-data/sales-export*。

arn:aws:s3:::examplebucket/my-data/sales-export*

この場合、このワイルドカードを使用してを指定すると、次のような名前のオブジェクトが含まれます。

• my-data/sales-export-1.xlsx

• my-data/sales-export-new.txt

• my-data/sales-export-2019/file1.txt

次に示すように、両方のタイプのワイルドカード(アスタリスクと疑問符)を組み合わせて使用することも、個別に使用することもできます。

arn:aws:s3:::examplebucket/my-data/sales-export-2019-q?.*

arn:aws:s3:::examplebucket/my-data/sales-export-20??-q?.*

また、ARN を将来的に保護する場合は、下の 2 桁にワイルドカードを使用するのではなく、年全体をワイルドカードで置き換えることができます。

8

Amazon QuickSight リソース ARN

arn:aws:s3:::examplebucket/my-data/sales-export-????-q?.*arn:aws:s3:::examplebucket/my-data/sales-export-*-q?.*

S3 ARN の詳細については、」ポリシーでのリソースの指定およびオブジェクトキーとメタデータ()Amazon Simple Storage Service 開発者ガイド

Amazon QuickSight リソース ARNAmazon QuickSight では、ユーザー、グループ、ダッシュボードのリソースタイプが定義されます。これらは、Amazon QuickSight API 呼び出しで、および IAM アクセス許可ステートメントの要素として使用されます。Amazon QuickSight (サービスプレフィックス:quicksight) のリソース、アクション、条件コンテキストキーの最新情報については、「」を参照してください。Amazon QuickSight のアクション、リソース、および条件キー()IAM ユーザーガイド

リソースタイプ ARN 形式 条件キー

ユーザー arn: $ {Partition}: quicksight: ${Region}: $ {Account}: user/${resourceId}

該当なし

グループ arn: $ {Partition}: quicksight: ${Region}: $ {Account}: group/${resourceId}

該当なし

ダッシュボード arn: $ {Partition}: quicksight:$ {Region}: $ {Account}:dashboard/$ {resourceId}

該当なし

リソース ARN は、リソースを説明するセグメントから構築されます。たとえば、分析のリソース ARNは、次のセグメントで構成されます。

arn:<partition>:quicksight:<aws-region>:<aws-account-id>:<resource-type>/<resource-id>

セグメントは次のように定義されます。

• partition— 例:awsまたはaws-cn。• aws-region— リソースを含む AWS リージョン。• aws-account-id— リソースを含む AWS アカウント。ハイフンは除外されます。• resource-type— リソースのタイプ。この例では、これはanalyses。ダッシュボードの場

合、dashboard。• resource-id— 特定のリソースの一意の識別子。

Amazon QuickSight コンソールを使用している場合、AWS リージョン、リソースタイプ、リソース ID はリソースの URL で識別されます。たとえば、これが ARN を必要とする分析の URL であるとします。

https://us-east-2.quicksight.aws.amazon.com/sn/analysis/4036e682-7de6-4c05-8a76-be51b9ec9b29

AWS リージョンus-east-2。resource-type はanalysis。この URL のリソース IDは4036e682-7de6-4c05-8a76-be51b9ec9b29。アカウント番号が111122223333の場合、この分析の ARN は次のようになります。

9

アクセス許可

arn:aws:quicksight:us-east-2:111122223333:analysis/4036e682-7de6-4c05-8a76-be51b9ec9b29

AWS アカウント番号を取得するには、システム管理者に問い合わせてください。

Amazon QuickSight リソースのアクセス許可必要なアクセス許可が明確でない場合は、電話をかけることができます。次に、クライアントは、不足しているアクセス許可が何であるかを知らせます。アスタリスク(*) を、明示的なリソースを指定するのではなく、アクセス許可ポリシーの [Resource] フィールドに入力します。ただし、各アクセス許可は可能な限り制限することをお勧めします。Amazon QuickSight ARN を使用して、ポリシーでリソースを指定したり除外することで、ユーザーアクセスを制限できます。Amazon QuickSight リソースの ARN を取得するには、Describe関連するリソースに対する操作。

Amazon QuickSight API オペレーションを呼び出す前に、quicksight:operation-nameIAM ID にアタッチされたポリシーにあるアクセス許可です。たとえば、list-users を呼び出すには、アクセス許可quicksight:ListUsers が必要です。すべてのオペレーションに同じパターンが適用されます。呼び出しを許可していない呼び出しを試みて、どのアクセス許可が不足しているかを発生したエラーで確認できます。各アクセス許可は可能な限り制限することを強くお勧めします。

一部のシナリオでは、IAM で条件を追加して、API へのアクセスをさらに制限することができます。たとえば、User1 を Group1 に追加すると、メインリソースは Group1 になります。特定のグループへのアクセスを許可または拒否できます。 または、Amazon QuickSight IAM キーを編集することもできますquicksight:UserNameをクリックして、特定のユーザーがそのグループに追加されるのを許可または禁止する条件を追加します。

詳細については、以下を参照してください。

• アクション、リソース、および条件キー• IAM JSON ポリシーエレメント

Amazon QuickSight アクションの最新リストについては、「」を参照してください。Amazon QuickSightで定義されるアクション()IAM ユーザーガイド。

Amazon QuickSight API エラーAmazon QuickSight には、2 種類のエラーコードがあります。

• クライアントエラー— これらのエラーは通常、クライアントが行ったことが原因で発生します。たとえば、リクエストで正しくないパラメータや無効なパラメータを指定したり、アクションやリソースを使用するアクセス許可を持たないユーザーに対してアクションやリソースを使用したりします。これらのエラーには 400 番台の HTTP レスポンスコードが伴います。

• サーバーエラー— これらのエラーは通常、AWS のサーバー側の問題が原因で発生します。これらのエラーには 500 番台の HTTP レスポンスコードが伴います。

コンテンツ• 共通のクライアントエラー (p. 11)• クライアントエラー (p. 12)• サーバーエラー (p. 14)

10

共通のクライアントエラー

共通のクライアントエラー以下に、すべてのアクションが返す共通のクライアントエラーのリストを示します。

エラーコード 説明

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

Blocked お客様のアカウントは現在ブロックされています。ご質問がありましたら、aws-verification@amazon.comまでお問い合わせください。

DryRunOperation ユーザーに必要なアクセス許可があるため、リクエストは成功したはずですが、DryRun パラメータが使用されました。

IdempotentParameterMismatch リクエストは、前の、しかし同一ではないリクエストと同じクライアントトークンを使用します。 リクエストが同一でない限り、異なるリクエストでクライアントトークンを再利用しないでください。

IncompleteSignature リクエストの署名が AWS 基準に適合しません。

InvalidAction 要求されたアクション、またはオペレーションは無効です。アクションが正しく入力されていることを確認します。

InvalidCharacter 指定された文字が無効です。

InvalidClientTokenId 指定された x.509 証明書、または AWS アクセスキーID が見つかりません。

InvalidPaginationToken 指定されたページ区切りトークンが無効か、または期限切れです。

InvalidParameter リクエストで指定されたパラメータが無効であるか、サポートされていないか、または使用できません。 返されたメッセージはエラー値の説明を提供します。

InvalidParameterCombination 誤ったパラメータの組み合わせ、または欠落しているパラメータを示します。

InvalidParameterValue リクエストで指定された値が無効であるか、サポートされていないか、または使用できません。 必ずフルID を使用してリソースを指定してください。返されたメッセージはエラー値の説明を提供します。

InvalidQueryParameter AWS クエリ文字列が正しい形式でないか、AWS 標準を順守していません。

MalformedQueryString クエリ文字列に構文エラーがあります。

MissingAction リクエストに、アクションまたは必須パラメータが含まれていません。

11

クライアントエラー

エラーコード 説明

MissingAuthenticationToken リクエストには、有効な(登録された)AWS アクセスキー ID、または X.509 証明書のどちらか一方が含まれている必要があります。

MissingParameter リクエストに、アクションまたは必須パラメータが含まれていません。リクエストに必要なすべてのパラメータを指定していることを確認してください。たとえば、リソース ID です。

OptInRequired 要求された製品を使用する権限がありません。使用しようとしているサービスに加入していることを確認してください。 AWS を初めてお使いの場合は、クレジットカード情報の確認中にアカウントがアクティブになるまでに時間がかかることがあります。

PendingVerification アカウントの検証を保留中です。確認プロセスが完了するまでは、このアカウントでリクエストを実行できない可能性があります。質問がある場合は、AWS サポートに連絡してください。

RequestExpired リクエストの日付スタンプまたはリクエストの有効期限 (署名付き URL の場合など) の 15 分以上後に、リクエストが到着しました。または、リクエストの日付スタンプが15分以上経過しています。一時的なセキュリティ認証情報を使用している場合、このエラーは認証情報の有効期限が切れている場合にも発生する可能性があります。 詳細については、「」を参照してください。一時的セキュリティ認証情報()IAM ユーザーガイド。

UnauthorizedOperation この操作を実行する権限がありません。IAM ポリシーを確認し、正しいアクセスキーを使用していることを確認します。

UnknownParameter 不明または認識されていないパラメータが指定されました このエラーの原因となる可能性があるリクエストには、スペルミスのパラメータ、または指定されたAPI バージョンではサポートされていないパラメータの指定が含まれます。

UnsupportedInstanceAttribute 指定された属性は変更できません。

UnsupportedOperation 指定されたリクエストにはサポートされていないオペレーションが含まれています。 返されたメッセージには、サポートされていないオペレーションの詳細が記載されています。

UnsupportedProtocol 使用したプロトコルはサポートされていません。

ValidationError 入力が、AWS のサービスで指定された制約を満たしていません。

クライアントエラーAmazon QuickSight API オペレーションに固有のクライアントエラーのリストを以下に示します。

12

クライアントエラー

エラーコード 説明

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

ドメインNotWhitelistedException 指定されたドメインは許可リストにありません。 埋め込みダッシュボードのすべてのドメインは、AmazonQuickSight 管理者が承認済みリストに追加する必要があります。

IdentityTypeNotSupportedException 指定されたアイデンティティタイプはサポートされていません。サポートされているアイデンティティタイプは次のとおりです。IAMとクイックサイトです。

InvalidNextTokenException NextToken の値は無効です。

InvalidParameterValueException 1 つ以上のパラメータに有効な値がありません。

PreconditionNotMetException 1 つ以上の前提条件が満たされていません。

QuickSightUserNotFoundException ユーザーが見つかりません。これは、DeleteUser、DescribeUser など、提供されたユーザー名に基づいてユーザーを見つける必要があるオペレーションで発生する可能性があります。

ResourceExistsException 指定されたリソースは存在しません

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

SessionLifetimeInMinutesInvalidException セッションの存続期間に指定された分数が無効です。 セッションの有効期間は 15 〜 600 分です。

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

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

クライアントエラーの一般的な原因リクエストの実行中にエラーが発生する可能性がある理由はいくつかあります。 これらのガイドラインに従うことで、いくつかのエラーを防止または簡単に解決できます。

• AWS アカウント ID と名前空間の指定— 関連する AWS アカウント ID は、各リクエストで提供される必要があります。名前空間を default に設定する必要があります。

• 最終的な一貫性を可能にする— 前のリクエストがまだシステムを介して伝搬されていないために、いくつかのエラーが発生します。

13

サーバーエラー

• 要求レート間のスリープ間隔を使用する— Amazon QuickSight API リクエストは、サービスのパフォーマンスを維持するために調整されます。リクエストが抑制されている場合は、エラーが発生します。

• リソースの完全な ID を使用する— リソースを指定するときは、ユーザー指定の名前や説明ではなく、必ずフル ID を使用してください。

• サービスを確認方法— 使用しようとしているすべてのサービスにサインアップしていることを確認します。どのサービスを登録しているかを確認するには、[自分のアカウントの セクションAWS ホームページ。

• アクセス許可の確認— リクエストを実行するために必要なアクセス許可があることを確認します。• VPC の確認— セキュリティグループなど、一部のリソースは仮想プライベートクラウド (VPC) 間で共

有できません。• 認証情報を確認する— リクエストを行うときにアクセスキーを指定し、認証情報を正しく入力している

ことを確認します。また、複数のアカウントがある場合は、特定のアカウントに対して正しい認証情報を使用していることを確認してください。提供された認証情報が正しくない場合は、のエラーが発生する可能性があります。Client.AuthFailure。

サーバーエラー以下に、サーバーから返される可能性があるエラーのリストを示します。

エラーコード 説明

BatchClientRequestTokensNotDistinctException– バッチクライアントリクエストトークンが一意ではありません。

EmptyBatchRequestException バッチリクエストが空です。

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

InternalServiceError サービスから内部エラーが発生しました。

InvalidBatchClientRequestTokenException このクライアントバッチリクエストの AWS リクエストトークンは無効です。

InvalidParameterException 1 つ以上のパラメータに無効な値が含まれています。

LimitExceededException 制限を超過しています。

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

TooManyEntriesInBatchRequestException このバッチリクエストの項目が多すぎます。

14

アクセス管理オペレーション

トピック別の Amazon QuickSightAPI オペレーション

このセクションを使用して、QuickSight API オペレーションをトピック別に検索します。

トピック• アクセスを制御するための QuickSight API オペレーション (p. 15)• QuickSight API による設定制御 (p. 17)• 埋め込み用の QuickSight API オペレーション (p. 18)• アセットを制御するQuickSight API オペレーション (p. 18)• データリソースを制御するための QuickSight API オペレーション (p. 19)

アクセスを制御するための QuickSight API オペレーション

このセクションの API 操作は、QuickSight ユーザー、QuickSight グループ、QuickSight 名前空間、およびQuickSight アセットに対する権限を制御します。

トピック• QuickSight 名前空間API オペレーション (p. 15)• QuickSight グループ API オペレーション (p. 15)• QuickSight ユーザー API オペレーション (p. 16)• IAM ポリシー割り当ての QuickSight API オペレーション (p. 16)• QuickSight API によるアセットおよびリソース権限のオペレーション (p. 16)

QuickSight 名前空間API オペレーションこのセクションの API 操作は、QuickSight 名前空間を制御します。

• CreateNamespace (p. 71)• DeleteNamespace (p. 115)• DescribeNamespace (p. 181)• ListNamespaces (p. 249)

QuickSight グループ API オペレーションこのセクションの API 操作は、QuickSight グループを制御します。

• CreateGroup (p. 57)• DescribeGroup (p. 172)• ListGroups (p. 237)

15

ユーザー操作

• UpdateGroup (p. 345)• DeleteGroup (p. 106)• GroupMember (p. 452)• CreateGroupMembership (p. 61)• DeleteGroupMembership (p. 109)• ListGroupMemberships (p. 234)

QuickSight ユーザー API オペレーションこのセクションの API 操作は、QuickSight ユーザーを制御します。

• RegisterUser (p. 278)• DescribeUser (p. 204)• ListUsers (p. 275)• ListUserGroups (p. 272)• DeleteUser (p. 130)• DeleteUserByPrincipalId (p. 133)• ListIAMPolicyAssignmentsForUser (p. 243)• UpdateUser (p. 375)

IAM ポリシー割り当ての QuickSight API オペレーションこのセクションの API オペレーションは、QuickSight での IAM ポリシーの割り当てを制御します。

• CreateIAMPolicyAssignment (p. 64)• UpdateIAMPolicyAssignment (p. 348)• ListIAMPolicyAssignments (p. 240)• ListIAMPolicyAssignmentsForUser (p. 243)• DescribeIAMPolicyAssignment (p. 175)• DeleteIAMPolicyAssignment (p. 112)

QuickSight API によるアセットおよびリソース権限のオペレーションこのセクションの API 操作は、QuickSight アセットおよびリソースに対する権限とアクセスを制御します。

リソースのアクセス許可

• DescribeAnalysisPermissions (p. 146)• UpdateAnalysisPermissions (p. 308)• DescribeDashboardPermissions (p. 152)• UpdateDashboardPermissions (p. 317)• DescribeDataSetPermissions (p. 160)• UpdateDataSetPermissions (p. 331)

16

設定を制御する操作

• DescribeDataSourcePermissions (p. 169)• UpdateDataSourcePermissions (p. 342)• DescribeTemplatePermissions (p. 191)• UpdateTemplatePermissions (p. 359)• DescribeThemePermissions (p. 201)• UpdateThemePermissions (p. 371)• カスタム UI 権限:RegisterUser (p. 278)およびUpdateUser (p. 375)• IAM ポリシーの割り当て:CreateIAMPolicyAssignment (p. 64)およ

びUpdateIAMPolicyAssignment (p. 348)

QuickSight API による設定制御このセクションの API 操作は、QuickSight の設定を制御します。

トピック• グローバル設定のための QuickSight API オペレーション (p. 17)• カスタマイズのための QuickSight API オペレーション (p. 17)• QuickSight タグ API オペレーション (p. 17)

グローバル設定のための QuickSight API オペレーションこのセクションの API 操作は、QuickSight サブスクリプションのグローバル設定を制御します。

• DescribeAccountSettings (p. 140)• UpdateAccountSettings (p. 301)

カスタマイズのための QuickSight API オペレーションこのセクションの API 操作は、QuickSight のカスタマイズを制御します。たとえば、デフォルトのテーマを設定してブランディングなどです。

• CreateAccountCustomization (p. 27)• DeleteAccountCustomization (p. 91)• DescribeAccountCustomization (p. 136)• UpdateAccountCustomization (p. 298)

QuickSight タグ API オペレーションこのセクションの API 操作は、QuickSight のタグを制御します。

Tags

• TagResource (p. 293)• ListTagsForResource (p. 252)• UntagResource (p. 296)

17

オペレーションの埋め込み

埋め込み用の QuickSight API オペレーションこのセクションの API 操作は、組み込みの QuickSight エクスペリエンス (埋め込みダッシュボードと埋め込みオーサリングコンソール) を制御します。

• GetDashboardEmbedUrl (p. 207)

ダッシュボードの埋め込み方法については、」を参照してください。Amazon QuickSight ダッシュボードの埋め込みまたはAmazon QuickSight ダッシュボード埋め込みチュートリアル。

• GetSessionEmbedUrl (p. 212)

アセットを制御するQuickSight API オペレーショントピック

• QuickSight 分析 API オペレーション (p. 18)• QuickSight ダッシュボード API オペレーション (p. 18)• QuickSight テンプレート API オペレーション (p. 19)• QuickSight テーマ API オペレーション (p. 19)

このセクションの API 操作は、QuickSight アセットを制御します。

QuickSight 分析 API オペレーションこのセクションの API 操作は、QuickSight 分析を制御します。

• CreateAnalysis (p. 31)• DescribeAnalysis (p. 143)• ListAnalyses (p. 216)• RestoreAnalysis (p. 284)• SearchAnalyses (p. 287)• UpdateAnalysis (p. 304)• DescribeAnalysisPermissions (p. 146)• UpdateAnalysisPermissions (p. 308)• DeleteAnalysis (p. 94)

QuickSight ダッシュボード API オペレーションこのセクションの API 操作は、QuickSight ダッシュボードを制御します。

• CreateDashboard (p. 36)• DescribeDashboard (p. 149)• ListDashboards (p. 219)• ListDashboardVersions (p. 222)• SearchDashboards (p. 290)• UpdateDashboard (p. 312)• DeleteDashboard (p. 97)• DescribeDashboardPermissions (p. 152)

18

QuickSight テンプレート API オペレーション

• UpdateDashboardPermissions (p. 317)• UpdateDashboardPublishedVersion (p. 321)

QuickSight テンプレート API オペレーションこのセクションの API 操作は、QuickSight テンプレートを制御します。

• CreateTemplate (p. 75)• DescribeTemplate (p. 184)• ListTemplates (p. 257)• ListTemplateVersions (p. 260)• UpdateTemplate (p. 352)• DeleteTemplate (p. 118)• DescribeTemplatePermissions (p. 191)• UpdateTemplatePermissions (p. 359)• CreateTemplateAlias (p. 80)• ListTemplateAliases (p. 254)• DescribeTemplateAlias (p. 188)• UpdateTemplateAlias (p. 356)• DeleteTemplateAlias (p. 121)

QuickSight テーマ API オペレーションこのセクションの API 操作は、QuickSight テーマを制御します。

• CreateTheme (p. 83)• DescribeTheme (p. 194)• DescribeThemePermissions (p. 201)• ListThemes (p. 266)• ListThemeVersions (p. 269)• UpdateTheme (p. 363)• UpdateThemePermissions (p. 371)• DeleteTheme (p. 124)• CreateThemeAlias (p. 88)• DescribeThemeAlias (p. 198)• ListThemeAliases (p. 263)• UpdateThemeAlias (p. 368)• DeleteThemeAlias (p. 127)

データリソースを制御するための QuickSight APIオペレーション

このセクションの API 操作は、QuickSight データリソースを制御します。

トピック

19

データソースの QuickSight API オペレーション

• データソースの QuickSight API オペレーション (p. 20)• データセットの QuickSight API オペレーション (p. 20)• SPICE データを更新するための QuickSight API オペレーション (SPICE 取り込み) (p. 20)

データソースの QuickSight API オペレーションこのセクションの API 操作は、QuickSight データソースを制御します。

• CreateDataSource (p. 49)• DescribeDataSource (p. 163)• ListDataSources (p. 228)• UpdateDataSource (p. 335)• DeleteDataSource (p. 103)• DescribeDataSourcePermissions (p. 169)• UpdateDataSetPermissions (p. 331)

データセットの QuickSight API オペレーションこのセクションの API 操作は、QuickSight データセットを制御します。

• CreateDataSet (p. 42)• DescribeDataSet (p. 155)• ListDataSets (p. 225)• UpdateDataSet (p. 324)• DeleteDataSet (p. 100)• DescribeDataSetPermissions (p. 160)• UpdateDataSetPermissions (p. 331)

SPICE データを更新するための QuickSight API オペレーション (SPICE 取り込み)このセクションの API 操作は、SPICE データの更新 (SPICE 取り込み) を制御します。

• CreateIngestion (p. 68)• CancelIngestion (p. 24)• DescribeIngestion (p. 178)• ListIngestions (p. 246)

20

Actions

API Reference Indexこのセクションには、 API リファレンスドキュメントが含まれています。

トピック• Actions (p. 21)• データ型 (p. 379)• 一般的なエラー (p. 543)• 共通パラメータ (p. 545)

Actions以下のアクションがサポートされています。

• CancelIngestion (p. 24)• CreateAccountCustomization (p. 27)• CreateAnalysis (p. 31)• CreateDashboard (p. 36)• CreateDataSet (p. 42)• CreateDataSource (p. 49)• CreateGroup (p. 57)• CreateGroupMembership (p. 61)• CreateIAMPolicyAssignment (p. 64)• CreateIngestion (p. 68)• CreateNamespace (p. 71)• CreateTemplate (p. 75)• CreateTemplateAlias (p. 80)• CreateTheme (p. 83)• CreateThemeAlias (p. 88)• DeleteAccountCustomization (p. 91)• DeleteAnalysis (p. 94)• DeleteDashboard (p. 97)• DeleteDataSet (p. 100)• DeleteDataSource (p. 103)• DeleteGroup (p. 106)• DeleteGroupMembership (p. 109)• DeleteIAMPolicyAssignment (p. 112)• DeleteNamespace (p. 115)• DeleteTemplate (p. 118)• DeleteTemplateAlias (p. 121)• DeleteTheme (p. 124)• DeleteThemeAlias (p. 127)• DeleteUser (p. 130)

21

Actions

• DeleteUserByPrincipalId (p. 133)• DescribeAccountCustomization (p. 136)• DescribeAccountSettings (p. 140)• DescribeAnalysis (p. 143)• DescribeAnalysisPermissions (p. 146)• DescribeDashboard (p. 149)• DescribeDashboardPermissions (p. 152)• DescribeDataSet (p. 155)• DescribeDataSetPermissions (p. 160)• DescribeDataSource (p. 163)• DescribeDataSourcePermissions (p. 169)• DescribeGroup (p. 172)• DescribeIAMPolicyAssignment (p. 175)• DescribeIngestion (p. 178)• DescribeNamespace (p. 181)• DescribeTemplate (p. 184)• DescribeTemplateAlias (p. 188)• DescribeTemplatePermissions (p. 191)• DescribeTheme (p. 194)• DescribeThemeAlias (p. 198)• DescribeThemePermissions (p. 201)• DescribeUser (p. 204)• GetDashboardEmbedUrl (p. 207)• GetSessionEmbedUrl (p. 212)• ListAnalyses (p. 216)• ListDashboards (p. 219)• ListDashboardVersions (p. 222)• ListDataSets (p. 225)• ListDataSources (p. 228)• ListGroupMemberships (p. 234)• ListGroups (p. 237)• ListIAMPolicyAssignments (p. 240)• ListIAMPolicyAssignmentsForUser (p. 243)• ListIngestions (p. 246)• ListNamespaces (p. 249)• ListTagsForResource (p. 252)• ListTemplateAliases (p. 254)• ListTemplates (p. 257)• ListTemplateVersions (p. 260)• ListThemeAliases (p. 263)• ListThemes (p. 266)• ListThemeVersions (p. 269)• ListUserGroups (p. 272)• ListUsers (p. 275)• RegisterUser (p. 278)• RestoreAnalysis (p. 284)

22

Actions

• SearchAnalyses (p. 287)• SearchDashboards (p. 290)• TagResource (p. 293)• UntagResource (p. 296)• UpdateAccountCustomization (p. 298)• UpdateAccountSettings (p. 301)• UpdateAnalysis (p. 304)• UpdateAnalysisPermissions (p. 308)• UpdateDashboard (p. 312)• UpdateDashboardPermissions (p. 317)• UpdateDashboardPublishedVersion (p. 321)• UpdateDataSet (p. 324)• UpdateDataSetPermissions (p. 331)• UpdateDataSource (p. 335)• UpdateDataSourcePermissions (p. 342)• UpdateGroup (p. 345)• UpdateIAMPolicyAssignment (p. 348)• UpdateTemplate (p. 352)• UpdateTemplateAlias (p. 356)• UpdateTemplatePermissions (p. 359)• UpdateTheme (p. 363)• UpdateThemeAlias (p. 368)• UpdateThemePermissions (p. 371)• UpdateUser (p. 375)

23

CancelIngestion

CancelIngestionSPICE への継続的なデータの取り込みをキャンセルします。

リクエストの構文

DELETE /accounts/AwsAccountId/data-sets/DataSetId/ingestions/IngestionId HTTP/1.1

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

AwsAccountId (p. 24)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいデータセット ID (p. 24)

取り込みで使用されるデータセットの ID。

: 必須 はい取り込み ID (p. 24)

取り込みの ID。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "IngestionId": "string", "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

24

CancelIngestion

ステータス (p. 24)

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

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

Arn (p. 24)

データ取り込みの Amazon リソースネーム (ARN)。

タイプ: 文字列取り込み ID (p. 24)

取り込みの ID。

タイプ: 文字列

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

パターン: ^[a-zA-Z0-9-_]+$RequestId (p. 24)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404

25

CancelIngestion

ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExample

この例では、キャンセルの 1 つの使用方法を示します。

リクエスト例

DELETE /accounts/*AwsAccountId*/data-sets/*DataSetID*/ingestions/*IngestionID* HTTP/1.1

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

26

CreateAccountCustomization

CreateAccountCustomization現在の AWS リージョンのAmazon QuickSight カスタマイズを作成します。現在のところ、カスタム既定のテーマを追加するには、CreateAccountCustomizationまたはUpdateAccountCustomizationAPI オペレーション。すべての新規ユーザーの QuickSight サンプルアセットとビデオを削除して QuickSight をさらにカスタマイズするには、QuickSight カスタマイズ()Amazon QuickSight ユーザーガイド

AWS アカウント用にカスタマイズを作成することも、名前空間を指定した場合は、代わりに QuickSight名前空間用にカスタマイズすることもできます。名前空間に適用されるカスタマイズは、常に AWSアカウントに適用されるカスタマイズを上書きします。どのカスタマイズが適用されるかを調べるには、DescribeAccountCustomizationAPI オペレーション。

使用する前にCreateAccountCustomizationAPI 操作を使用してテーマを名前空間のデフォルトとして追加する場合は、最初にテーマを名前空間と共有することを確認します。名前空間と共有しない場合、既定のテーマにした場合でも、テーマはユーザーには表示されません。テーマが共有されているかどうかを確認するには、使用して、現在のアクセス許可を表示します DescribeThemePermissions (p. 201)API オペレーション。テーマを共有するには、 UpdateThemePermissions (p. 371) API オペレーション。

リクエストの構文

POST /accounts/AwsAccountId/customizations?namespace=Namespace HTTP/1.1Content-type: application/json

{ "AccountCustomization": { "DefaultTheme": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ]}

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

AwsAccountId (p. 27)

QuickSight をカスタマイズする AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はい名前空間 (p. 27)

カスタマイズを追加する QuickSight 名前空間。

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

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

27

CreateAccountCustomization

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

アカウントのカスタマイズ (p. 27)

現在の AWS リージョンの追加する QuickSight のカスタマイズ。これらは、AWS アカウントとQuickSight 名前空間に追加できます。

たとえば、デフォルトのテーマを追加するには、AccountCustomizationを真夜中のテーマに変更します。"AccountCustomization": { "DefaultTheme":"arn:aws:quicksight::aws:theme/MIDNIGHT" }。 または、カスタムテーマを追加するには、"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }。

タイプ: AccountCustomization (p. 383) オブジェクト

: 必須 はいタグ (p. 27)

このリソースにアタッチするタグのリスト。

タイプ: 配列インデックス作成Tag (p. 503)objects

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

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AccountCustomization": { "DefaultTheme": "string" }, "Arn": "string", "AwsAccountId": "string", "Namespace": "string", "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 28)

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

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

アカウントのカスタマイズ (p. 28)

現在の AWS リージョンの追加する QuickSight のカスタマイズ。

タイプ: AccountCustomization (p. 383) オブジェクト

28

CreateAccountCustomization

Arn (p. 28)

この AWS アカウント用に作成したカスタマイズの Amazon リソースネーム (ARN)。

タイプ: 文字列AwsAccountId (p. 28)

QuickSight をカスタマイズする AWS アカウントの ID。

タイプ: 文字列

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$名前空間 (p. 28)

作成するカスタマイズに関連付けられた名前空間。

タイプ: 文字列

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

パターン: ^[a-zA-Z0-9._-]*$RequestId (p. 28)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

29

CreateAccountCustomization

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

30

CreateAnalysis

CreateAnalysisAmazon QuickSight で分析を作成します。

リクエストの構文

POST /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1Content-type: application/json

{ "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"}

31

CreateAnalysis

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

AnalysisId (p. 31)

作成する分析の ID。この ID は、分析の URL に表示されます。

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

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

: 必須 はいAwsAccountId (p. 31)

分析を作成する AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はい

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

名前 (p. 31)

作成する分析のわかりやすい名前です。この名前は、QuickSight コンソールで分析に表示されます。

タイプ: 文字列

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

: 必須 はいSourceEntity (p. 31)

作成する分析に使用するソースエンティティ。このメタデータ構造には、ソーステンプレートと 1 つ以上のデータセットを記述する詳細が含まれています。

タイプ: AnalysisSourceEntity (p. 393) オブジェクト

: 必須 はいパラメータ (p. 31)

使用するパラメーター名および値をオーバーライドします。解析には任意のパラメータタイプがあり、パラメータによっては複数の値を受け入れる場合があります。

タイプ: Parameters (p. 476) オブジェクト

: 必須 いいえアクセス許可 (p. 31)

分析のプリンシパルとリソースレベルのパーミッションを記述する構造体。「」Permissions構造体を使用して、Amazon リソースネーム (ARN) にリストされているプリンシパルごとに AWS Identityand Access Management (IAM) アクション情報のリストを入力します。

権限を指定しない場合は、Permissions。

32

CreateAnalysis

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

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

: 必須 いいえタグ (p. 31)

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

タイプ: 配列インデックス作成Tag (p. 503)objects

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

: 必須 いいえThemeArn (p. 31)

作成する分析に適用するテーマの ARN。QuickSight コンソールでテーマを表示するには、ユーザーがテーマにアクセスできることを確認します。

タイプ: 文字列

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "AnalysisId": "string", "Arn": "string", "CreationStatus": "string", "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 33)

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

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

AnalysisId (p. 33)

分析の ID。

タイプ: 文字列

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

パターン: [\w\-]+Arn (p. 33)

分析の ARN。

33

CreateAnalysis

タイプ: 文字列作成ステータス (p. 33)

分析の作成のステータス。

タイプ: 文字列

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

RequestId (p. 33)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

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

HTTP ステータスコード: 403

34

CreateDashboard

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

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

リクエストの構文POST /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1Content-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",

36

CreateDashboard

"DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThemeArn": "string", "VersionDescription": "string"}

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

AwsAccountId (p. 36)

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

長さの制約: 固定長 12。

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

: 必須 はいDashboardId (p. 36)

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

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

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

: 必須 はい

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

名前 (p. 36)

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

タイプ: 文字列

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

: 必須 はいSourceEntity (p. 36)

ダッシュボードの作成時にソースとして使用しているエンティティ。EclipseSourceEntityでは、ソースとして使用しているオブジェクトのタイプを指定します。ダッシュボードはテンプレートからのみ作成できます。そのため、SourceTemplateエンティティ。解析からダッシュボードを作成する

37

CreateDashboard

必要がある場合は、まず解析をテンプレートに変換し、CreateTemplate (p. 75)API オペレーション。を使用する場合SourceTemplateソーステンプレートの Amazon リソースネーム (ARN) を指定します。-SourceTemplateARN には、任意の AWS アカウントと QuickSight がサポートする AWSリージョンを含めることができます。

の使用DataSetReferences内のエンティティSourceTemplateをクリックして、元のプレースホルダにリストされているプレースホルダの置換データセットをリストします。各データセットのスキーマは、プレースホルダと一致する必要があります。

タイプ: DashboardSourceEntity (p. 419) オブジェクト

: 必須 はいDashboardPublishOptions (p. 36)

ダッシュボードの作成時にダッシュボードを公開するためのオプション:• AvailabilityStatusforAdHocFilteringOption-このステータスは、ENABLEDまた

はDISABLED。これを設定した場合DISABLEDに設定すると、QuickSight は公開ダッシュボードの左側のフィルターウィンドウを無効にします。このフィルターは、アドホック (ワンタイム) フィルターに使用できます。このオプションは次のとおりです。ENABLEDデフォルトはです。

• AvailabilityStatusforExportToCSVOption-このステータスは、ENABLEDまたはDISABLED。.CSV 形式にデータをエクスポートするビジュアルオプションは、DISABLED。このオプションは次のとおりです。ENABLEDデフォルトはです。

• VisibilityStateforSheetControlsOption-この可視性の状態は、COLLAPSEDまたはEXPANDED。このオプションは次のとおりです。COLLAPSEDデフォルトはです。

タイプ: DashboardPublishOptions (p. 417) オブジェクト

: 必須 いいえパラメータ (p. 36)

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

タイプ: Parameters (p. 476) オブジェクト

: 必須 いいえアクセス許可 (p. 36)

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

権限を指定しない場合は、権限一覧を省略します。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

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

: 必須 いいえタグ (p. 36)

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

タイプ: 配列インデックス作成Tag (p. 503)objects

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

: 必須 いいえ

38

CreateDashboard

ThemeArn (p. 36)

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

タイプ: 文字列

: 必須 いいえVersionDescription (p. 36)

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

タイプ: 文字列

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

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

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

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 39)

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

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

Arn (p. 39)

ダッシュボードの ARN。

タイプ: 文字列作成ステータス (p. 39)

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

タイプ: 文字列

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

DashboardId (p. 39)

ダッシュボードの ID。

39

CreateDashboard

タイプ: 文字列

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

パターン: [\w\-]+RequestId (p. 39)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列バージョンARN (p. 39)

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

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

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

HTTP ステータスコード: 403

40

CreateDataSet

CreateDataSetデータセットを作成します。

リクエストの構文

POST /accounts/AwsAccountId/data-sets HTTP/1.1Content-type: application/json

{ "ColumnGroups": [ { "GeoSpatialColumnGroup": { "Columns": [ "string" ], "CountryCode": "string", "Name": "string" } } ], "ColumnLevelPermissionRules": [ { "ColumnNames": [ "string" ], "Principals": [ "string" ] } ], "DataSetId": "string", "FieldFolders": { "string" : { "columns": [ "string" ], "description": "string" } }, "ImportMode": "string", "LogicalTableMap": { "string" : { "Alias": "string", "DataTransforms": [ { "CastColumnTypeOperation": { "ColumnName": "string", "Format": "string", "NewColumnType": "string" }, "CreateColumnsOperation": { "Columns": [ { "ColumnId": "string", "ColumnName": "string", "Expression": "string" } ] }, "FilterOperation": { "ConditionExpression": "string" }, "ProjectOperation": { "ProjectedColumns": [ "string" ] }, "RenameColumnOperation": { "ColumnName": "string", "NewColumnName": "string" }, "TagColumnOperation": {

42

CreateDataSet

"ColumnName": "string", "Tags": [ { "ColumnDescription": { "Text": "string" }, "ColumnGeographicRole": "string" } ] } } ], "Source": { "JoinInstruction": { "LeftJoinKeyProperties": { "UniqueKey": boolean }, "LeftOperand": "string", "OnClause": "string", "RightJoinKeyProperties": { "UniqueKey": boolean }, "RightOperand": "string", "Type": "string" }, "PhysicalTableId": "string" } } }, "Name": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "PhysicalTableMap": { "string" : { "CustomSql": { "Columns": [ { "Name": "string", "Type": "string" } ], "DataSourceArn": "string", "Name": "string", "SqlQuery": "string" }, "RelationalTable": { "Catalog": "string", "DataSourceArn": "string", "InputColumns": [ { "Name": "string", "Type": "string" } ], "Name": "string", "Schema": "string" }, "S3Source": { "DataSourceArn": "string", "InputColumns": [ { "Name": "string",

43

CreateDataSet

"Type": "string" } ], "UploadSettings": { "ContainsHeader": boolean, "Delimiter": "string", "Format": "string", "StartFromRow": number, "TextQualifier": "string" } } } }, "RowLevelPermissionDataSet": { "Arn": "string", "FormatVersion": "string", "Namespace": "string", "PermissionPolicy": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ]}

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

AwsAccountId (p. 42)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はい

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

データセット ID (p. 42)

作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列

: 必須 はいインポートモード (p. 42)

SPICE にデータをインポートするかどうかを示します。

タイプ: 文字列

有効な値: SPICE | DIRECT_QUERY

: 必須 はい

44

CreateDataSet

名前 (p. 42)

データセットの表示名。

タイプ: 文字列

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

: 必須 はい物理テーブルマップ (p. 42)

基になるデータソースで使用可能な物理テーブルを宣言します。

タイプ: 文字列PhysicalTable (p. 477)オブジェクトマップ

マップエントリ: 最大数は 32 項目です。

キーの長さ制限: 最小長は 1 です。 最大長は 64 です。

キーパターン:[0-9a-zA-Z-]*

: 必須 はい列グループ (p. 42)

特定の QuickSight 機能で連携する列のグループ化 現在、空間階層のみがサポートされます。

タイプ: 配列インデックス作成ColumnGroup (p. 405)objects

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

: 必須 いいえ列レベル権限ルール (p. 42)

1 つ以上の定義のセット。 ColumnLevelPermissionRule (p. 408) 。

タイプ: 配列インデックス作成ColumnLevelPermissionRule (p. 408)objects

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

: 必須 いいえフィールドフォルダ (p. 42)

データセットのフィールドとネストされたサブフォルダーを格納するフォルダー。

タイプ: 文字列FieldFolder (p. 448)オブジェクトマップ

キーの長さ制限: 最小長は 1 です。 最大長は 1000 です。

: 必須 いいえ論理テーブルマップ (p. 42)

物理テーブルからのデータの組み合わせと変換を設定します。

タイプ: 文字列LogicalTable (p. 465)オブジェクトマップ

マップエントリ: 最大数は 64 項目です。

キーの長さ制限: 最小長は 1 です。 最大長は 64 です。

キーパターン:[0-9a-zA-Z-]*

45

CreateDataSet

: 必須 いいえアクセス許可 (p. 42)

データセットに対するリソース権限のリスト。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

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

: 必須 いいえRowlelPermissionデータセット (p. 42)

作成するデータの行レベルのセキュリティ構成。

タイプ: RowLevelPermissionDataSet (p. 490) オブジェクト

: 必須 いいえタグ (p. 42)

データセットに割り当てられたリソースタグのキーと値のペアのマップを格納します。

タイプ: 配列インデックス作成Tag (p. 503)objects

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

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "DataSetId": "string", "IngestionArn": "string", "IngestionId": "string", "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 46)

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

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

Arn (p. 46)

データセットの Amazon リソースネーム (ARN)。

タイプ: 文字列データセット ID (p. 46)

作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

46

CreateDataSet

タイプ: 文字列インジェクションアーン (p. 46)

取り込みの ARN。インポートモードが SPICE の場合、データセットの作成の結果としてトリガーされます。

タイプ: 文字列取り込み ID (p. 46)

取り込みの ID。インポートモードが SPICE の場合、データセットの作成の結果としてトリガーされます。

タイプ: 文字列RequestId (p. 46)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

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

HTTP ステータスコード: 409

47

CreateDataSet

ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

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

HTTP ステータスコード: 403

ExamplesExample

この例では、CreateDataSet の 1 つの使用方法を示します。

リクエスト例

POST /accounts/{AwsAccountId}/data-sets HTTP/1.1Content-type: application/json

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

48

CreateDataSource

CreateDataSourceデータソースを作成します。

リクエストの構文

POST /accounts/AwsAccountId/data-sources HTTP/1.1Content-type: application/json

{ "Credentials": { "CopySourceArn": "string", "CredentialPair": { "AlternateDataSourceParameters": [ { "AmazonElasticsearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "string" }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": {

49

CreateDataSource

"Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } } ], "Password": "string", "Username": "string" } }, "DataSourceId": "string", "DataSourceParameters": { "AmazonElasticsearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": {

50

CreateDataSource

"DataSetName": "string" }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": { "Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string",

51

CreateDataSource

"Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } }, "Name": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "SslProperties": { "DisableSsl": boolean }, "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "VpcConnectionProperties": { "VpcConnectionArn": "string" }}

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

AwsAccountId (p. 49)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はい

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

データソース ID (p. 49)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列

: 必須 はい名前 (p. 49)

データソースの表示名。

タイプ: 文字列

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

52

CreateDataSource

: 必須 はいタイプ (p. 49)

データソースの型。現在、この操作でサポートされているタイプは次のとおりです。ATHENA,AURORA, AURORA_POSTGRESQL, AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL,PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA。 を使用するListDataSourcesすべてのデータソースのリストを返します。

AMAZON_ELASTICSEARCHは Amazon マネージド Elasticsearch サービス用です

タイプ: 文字列

有効な値: ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | ATHENA | AURORA |AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | GITHUB | JIRA | MARIADB | MYSQL |ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW |SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TWITTER | TIMESTREAM

: 必須 はい認証情報 (p. 49)

基になるソースへの接続に使用する QuickSight の資格情報。現在、ユーザー名とパスワードに基づく認証情報のみがサポートされています。

タイプ: DataSourceCredentials (p. 439) オブジェクト

: 必須 いいえデータソースパラメータ (p. 49)

基礎となるソースへの接続に QuickSight が使用するパラメータ。

タイプ: DataSourceParameters (p. 441) オブジェクト

: 必須 いいえアクセス許可 (p. 49)

データソース上のリソースアクセス許可のリスト。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

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

: 必須 いいえSSLプロパティ (p. 49)

QuickSight が基盤となるソースに接続するときに適用されるセキュアソケットレイヤー (SSL) プロパティ。

タイプ: SslProperties (p. 501) オブジェクト

: 必須 いいえタグ (p. 49)

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

タイプ: 配列インデックス作成Tag (p. 503)objects

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

53

CreateDataSource

: 必須 いいえvPC接続のプロパティ (p. 49)

このパラメータは、基になるソースに接続するときに QuickSight で VPC 接続を使用する場合にのみ使用します。

タイプ: VpcConnectionProperties (p. 543) オブジェクト

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "CreationStatus": "string", "DataSourceId": "string", "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 54)

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

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

Arn (p. 54)

データソースの Amazon リソースネーム (ARN)。

タイプ: 文字列作成ステータス (p. 54)

データソースの作成のステータス。

タイプ: 文字列

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

データソース ID (p. 54)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列RequestId (p. 54)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

54

CreateDataSource

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExampleこの例では、CreateDataSource の 1 つの使用方法を示しています。

リクエスト例

POST /accounts/{AwsAccountId}/data-sources HTTP/1.1 Content-type: application/json

55

CreateGroup

CreateGroupAmazon QuickSight グループを作成します。

権限リソースはarn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> 。

応答はグループオブジェクトです。

リクエストの構文POST /accounts/AwsAccountId/namespaces/Namespace/groups HTTP/1.1Content-type: application/json

{ "Description": "string", "GroupName": "string"}

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

AwsAccountId (p. 57)

グループが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はい名前空間 (p. 57)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はい

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

GroupName (p. 57)

作成するグループの名前。

タイプ: 文字列

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

パターン: [\u0020-\u00FF]+

: 必須 はい

57

CreateGroup

説明 (p. 57)

作成するグループの説明。

タイプ: 文字列

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

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "Group": { "Arn": "string", "Description": "string", "GroupName": "string", "PrincipalId": "string" }, "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 58)

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

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

グループ (p. 58)

グループの名前。

タイプ: Group (p. 451) オブジェクトRequestId (p. 58)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

58

CreateGroup

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python

59

CreateGroupMembership

CreateGroupMembershipAmazon QuickSight ユーザーを Amazon QuickSight グループに追加します。

リクエストの構文

PUT /accounts/AwsAccountId/namespaces/Namespace/groups/GroupName/members/MemberName HTTP/1.1

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

AwsAccountId (p. 61)

グループが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はいGroupName (p. 61)

ユーザーを追加するグループの名前です。

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

パターン: [\u0020-\u00FF]+

: 必須 はいメンバー名 (p. 61)

グループメンバーシップに追加するユーザーの名前。

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

パターン: [\u0020-\u00FF]+

: 必須 はい名前空間 (p. 61)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

61

CreateGroupMembership

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "GroupMember": { "Arn": "string", "MemberName": "string" }, "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 62)

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

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

GroupMember (p. 62)

グループメンバー。

タイプ: GroupMember (p. 452) オブジェクトRequestId (p. 62)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400

62

CreateGroupMembership

PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

63

CreateIAMPolicyAssignment

CreateIAMPolicyAssignmentAmazon リソースネーム (ARN) により識別される、指定された IAM ポリシーで割り当てを作成します。このポリシー割り当ては、Amazon QuickSight の指定されたグループまたはユーザーにアタッチされます。割り当て名は、AWS アカウントごとに一意です。他の名前空間のルールを上書きしないようにするには、一意の割り当て名を使用します。

リクエストの構文POST /accounts/AwsAccountId/namespaces/Namespace/iam-policy-assignments/ HTTP/1.1Content-type: application/json

{ "AssignmentName": "string", "AssignmentStatus": "string", "Identities": { "string" : [ "string" ] }, "PolicyArn": "string"}

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

AwsAccountId (p. 64)

QuickSight ユーザーまたはグループに IAM ポリシーを割り当てる AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はい名前空間 (p. 64)

割り当てを含む名前空間。

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

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

: 必須 はい

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

割り当て名 (p. 64)

割り当ての名前。ルールとも呼ばれます。AWS アカウント内で一意である必要があります。

タイプ: 文字列

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

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$

64

CreateIAMPolicyAssignment

: 必須 はいAssignmentStatus (p. 64)

割り当てのステータス。指定できる値は次のとおりです。• ENABLED-この割り当てで指定されているものは、データソースの作成時に使用されます。• DISABLED-この割り当ては、データソースの作成時に使用されません。• DRAFT-この割り当ては未完成のドラフトであり、データソースの作成時には使用されません。

タイプ: 文字列

有効な値: ENABLED | DRAFT | DISABLED

: 必須 はいID (p. 64)

ポリシーを割り当てる QuickSight ユーザー、グループ、またはその両方。

タイプ: 文字列から文字列の配列へのマッピング

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

パターン: [\u0020-\u00FF]+

: 必須 いいえPolicyArn (p. 64)

この割り当てで指定された QuickSight ユーザーとグループに適用する IAM ポリシーの ARN。

タイプ: 文字列

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AssignmentId": "string", "AssignmentName": "string", "AssignmentStatus": "string", "Identities": { "string" : [ "string" ] }, "PolicyArn": "string", "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 65)

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

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

65

CreateIAMPolicyAssignment

割り当てID (p. 65)

割り当ての ID です。

タイプ: 文字列割り当て名 (p. 65)

割り当ての名前。この名前は AWS アカウント内で一意でなければなりません。

タイプ: 文字列

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

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$AssignmentStatus (p. 65)

割り当てのステータス。指定できる値は次のとおりです。• ENABLED-この割り当てで指定されているものは、データソースの作成時に使用されます。• DISABLED-この割り当ては、データソースの作成時に使用されません。• DRAFT-この割り当ては未完成のドラフトであり、データソースの作成時には使用されません。

タイプ: 文字列

有効な値: ENABLED | DRAFT | DISABLEDID (p. 65)

IAM ポリシーが割り当てられている QuickSight ユーザー、グループ、またはその両方。

タイプ: 文字列から文字列の配列へのマッピング

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

パターン: [\u0020-\u00FF]+PolicyArn (p. 65)

この割り当てで指定された QuickSight ユーザーおよびグループに適用される IAM ポリシーの ARN。

タイプ: 文字列RequestId (p. 65)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401

66

CreateIAMPolicyAssignment

同時処理例外

リソースは、新しい更新を適用する前に完了する必要がある操作が実行中であることを示す状態ですでにあります。

HTTP ステータスコード: 500InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに、無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

67

CreateIngestion

CreateIngestionデータセットで新しい SPICE 取り込みを作成し、開始します

タグ付きデータセットを操作する取り込みは、アクセス制御で使用するために同じタグを自動的に継承します。例については、「」を参照してください。タグを使用して Amazon EC2 リソースへのアクセスを制御する IAM ポリシーを作成するにはどうすればよいですか?」を参照してください。AWS ナリッジセンターでご覧いただけます。タグはタグ付けされたデータセットには表示されますが、取り込みリソースには表示されません。

リクエストの構文

PUT /accounts/AwsAccountId/data-sets/DataSetId/ingestions/IngestionId HTTP/1.1

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

AwsAccountId (p. 68)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいデータセット ID (p. 68)

取り込みで使用されるデータセットの ID。

: 必須 はい取り込み ID (p. 68)

取り込みの ID。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "IngestionId": "string", "IngestionStatus": "string",

68

CreateIngestion

"RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 68)

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

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

Arn (p. 68)

データ取り込みの Amazon リソースネーム (ARN)。

タイプ: 文字列取り込み ID (p. 68)

取り込みの ID。

タイプ: 文字列

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

パターン: ^[a-zA-Z0-9-_]+$取り込みステータス (p. 68)

取り込みのステータス。

タイプ: 文字列

有効な値: INITIALIZED | QUEUED | RUNNING | FAILED | COMPLETED | CANCELLEDRequestId (p. 68)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500

69

CreateIngestion

InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExample

この例では、CreateingEstion の使用方法を 1 つ示します。

リクエスト例

PUT /accounts/*AwsAccountId*/data-sets/*DataSetID*/ingestions/*IngestionID* HTTP/1.1

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

70

CreateNamespace

CreateNamespace(エンタープライズ版のみ)Amazon QuickSight で使用する新しい名前空間を作成します。

名前空間を使用すると、その名前空間に登録されている QuickSight ユーザーとグループを分離できます。ネームスペースにアクセスするユーザーは、同じネームスペース内の他のユーザーまたはグループとのみアセットを共有できます。他の名前空間のユーザーやグループを表示することはできません。AWS アカウントが QuickSight にサブスクライブされた後に、名前空間を作成できます。名前空間は AWS アカウント内で一意でなければなりません。デフォルトでは、名前空間は、1 つの AWS アカウントにつき 100 に制限されます。制限を増やすには、AWS Support でチケットを作成します。

リクエストの構文POST /accounts/AwsAccountId HTTP/1.1Content-type: application/json

{ "IdentityStore": "string", "Namespace": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}

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

AwsAccountId (p. 71)

QuickSight 名前空間を作成する AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はい

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

アイデンティティーストア (p. 71)

ユーザー ID ディレクトリのタイプを指定します。現在、これは ID タイプがQUICKSIGHT。

タイプ: 文字列

有効な値: QUICKSIGHT

: 必須 はい名前空間 (p. 71)

新しい名前空間の説明に使用する名前です。

71

CreateNamespace

タイプ: 文字列

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

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

: 必須 はいタグ (p. 71)

作成中のネームスペースに関連付けるタグ。

タイプ: 配列インデックス作成Tag (p. 503)objects

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

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "CapacityRegion": "string", "CreationStatus": "string", "IdentityStore": "string", "Name": "string", "RequestId": "string"}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 72)

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

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

Arn (p. 72)

作成した QuickSight 名前空間の ARN。

タイプ: 文字列容量リージョン (p. 72)

新しい名前空間の無料の SPICE 容量に使用する AWS リージョン。これは、CreateNamespace を実行するリージョンに設定されます。

タイプ: 文字列作成ステータス (p. 72)

名前空間の作成のステータス。これは非同期プロセスです。ステータスがであるCREATED名前空間を使用する準備ができていることを意味します。エラーが発生した場合、プロセスがretryableまたはnon-retryable。再試行不可能なエラーの場合は、フォローアップタスクに関するエラーメッセージを参照してください。

72

CreateNamespace

タイプ: 文字列

有効な値: CREATED | CREATING | DELETING | RETRYABLE_FAILURE |NON_RETRYABLE_FAILURE

アイデンティティーストア (p. 72)

ユーザー ID ディレクトリのタイプを指定します。現在、これは ID タイプがQUICKSIGHT。

タイプ: 文字列

有効な値: QUICKSIGHT名前 (p. 72)

作成した新しいネームスペースの名前。

タイプ: 文字列

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

パターン: ^[a-zA-Z0-9._-]*$RequestId (p. 72)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409

73

CreateNamespace

PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

74

CreateTemplate

CreateTemplate既存の QuickSight 分析またはテンプレートからテンプレートを作成します。作成されたテンプレートを使用して、ダッシュボードを作成できます。

テンプレートは QuickSight のエンティティで、分析の作成に必要なメタデータをカプセル化し、ダッシュボードの作成に使用できます。テンプレートは、プレースホルダーを使用して分析に関連付けられたデータセットを置き換えることにより、抽象レイヤーを追加します。データセットプレースホルダーをソース分析およびテンプレートの作成に使用したのと同じスキーマに従うデータセットに置き換えることにより、テンプレートを使用してダッシュボードを作成できます。

リクエストの構文POST /accounts/AwsAccountId/templates/TemplateId HTTP/1.1Content-type: application/json

{ "Name": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "SourceEntity": { "SourceAnalysis": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] }, "SourceTemplate": { "Arn": "string" } }, "Tags": [ { "Key": "string", "Value": "string" } ], "VersionDescription": "string"}

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

AwsAccountId (p. 75)

グループが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はい

75

CreateTemplate

TemplateId (p. 75)

作成するテンプレートの ID。このテンプレートは、各 AWS アカウントの AWS リージョンごとに一意です。

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

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

: 必須 はい

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

SourceEntity (p. 75)

テンプレートの作成時にソースとして使用しているエンティティ。EclipseSourceEntityでは、ソースとして使用しているオブジェクトのタイプを指定します。SourceTemplateテンプレート(1)SourceAnalysis分析します。どちらの場合も Amazon リソースネーム (ARN) が必要です。を使用する場合SourceTemplateで、ソーステンプレートの ARN を指定します。を使用する場合SourceAnalysisで、ソース分析の ARN を指定します。-SourceTemplateARN には、任意のAWS アカウントと QuickSight がサポートする AWS リージョンを含めることができます。

の使用DataSetReferences内のエンティティSourceTemplateまたはSourceAnalysisをクリックして、元のプレースホルダにリストされているプレースホルダの置換データセットをリストします。各データセットのスキーマは、プレースホルダと一致する必要があります。

タイプ: TemplateSourceEntity (p. 510) オブジェクト

: 必須 はい名前 (p. 75)

テンプレートの表示名。

タイプ: 文字列

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

: 必須 いいえアクセス許可 (p. 75)

テンプレートに設定するリソース権限のリスト。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

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

: 必須 いいえタグ (p. 75)

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

タイプ: 配列インデックス作成Tag (p. 503)objects

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

: 必須 いいえ

76

CreateTemplate

VersionDescription (p. 75)

作成中の現在のテンプレートバージョンの説明。この API オペレーションは、テンプレートの最初のバージョンを作成します。毎回UpdateTemplateが呼び出されると、新しいバージョンが作成されます。テンプレートの各バージョンでは、バージョンの説明がVersionDescriptionfield。

タイプ: 文字列

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

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

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

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 77)

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

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

Arn (p. 77)

テンプレートの ARN。

タイプ: 文字列作成ステータス (p. 77)

テンプレートの作成ステータス。

タイプ: 文字列

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

RequestId (p. 77)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列TemplateId (p. 77)

テンプレートの ID。

タイプ: 文字列

77

CreateTemplate

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

パターン: [\w\-]+バージョンARN (p. 77)

テンプレートの ARN(最初のバージョンのバージョン情報を含む)。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

78

CreateTemplate

UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

79

CreateTemplateAlias

CreateTemplateAliasテンプレートのテンプレートエイリアスを作成します。

リクエストの構文POST /accounts/AwsAccountId/templates/TemplateId/aliases/AliasName HTTP/1.1Content-type: application/json

{ "TemplateVersionNumber": number}

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

AliasName (p. 80)

作成するテンプレートエイリアスに割り当てる名前。エイリアス名を先頭に$を使用することはできません で始まるエイリアス名$は、QuickSight によって予約されています。

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

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 はいAwsAccountId (p. 80)

エイリアスを作成するテンプレートを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいTemplateId (p. 80)

テンプレートの ID。

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

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

: 必須 はい

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

テンプレートバージョン番号 (p. 80)

テンプレートのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

80

CreateTemplateAlias

: 必須 はい

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "TemplateAlias": { "AliasName": "string", "Arn": "string", "TemplateVersionNumber": number }}

レスポンス要素アクションが成功した場合、サービスは HTTP レスポンスを返します。

ステータス (p. 81)

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

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

RequestId (p. 81)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列テンプレート・エイリアス (p. 81)

テンプレートのエイリアスに関する情報。

タイプ: TemplateAlias (p. 507) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500

81

CreateTemplateAlias

LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

82

CreateTheme

CreateThemeテーマを更新します。

テーマは、色とレイアウトの設定オプションのセットです。テーマは、分析とダッシュボードに適用されます。詳細については、「」を参照してください。Amazon QuickSight でのテーマの使用()AmazonQuickSight ユーザーガイド。

リクエストの構文POST /accounts/AwsAccountId/themes/ThemeId HTTP/1.1Content-type: application/json

{ "BaseThemeId": "string", "Configuration": { "DataColorPalette": { "Colors": [ "string" ], "EmptyFillColor": "string", "MinMaxGradient": [ "string" ] }, "Sheet": { "Tile": { "Border": { "Show": boolean } }, "TileLayout": { "Gutter": { "Show": boolean }, "Margin": { "Show": boolean } } }, "UIColorPalette": { "Accent": "string", "AccentForeground": "string", "Danger": "string", "DangerForeground": "string", "Dimension": "string", "DimensionForeground": "string", "Measure": "string", "MeasureForeground": "string", "PrimaryBackground": "string", "PrimaryForeground": "string", "SecondaryBackground": "string", "SecondaryForeground": "string", "Success": "string", "SuccessForeground": "string", "Warning": "string", "WarningForeground": "string" } }, "Name": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "Tags": [

83

CreateTheme

{ "Key": "string", "Value": "string" } ], "VersionDescription": "string"}

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

AwsAccountId (p. 83)

新しいテーマを保存する AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいThemeId (p. 83)

作成するテーマの ID。テーマ ID は、各 AWS アカウントの AWS リージョンごとに一意です。

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

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

: 必須 はい

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

BaseThemeId (p. 83)

カスタムテーマが継承するテーマの ID。すべてのテーマは、Amazon QuickSight で定義されている開始テーマの 1 つから継承されます。開始テーマのリストについては、ListThemesを選択するか、Themes (テーマ)を QuickSight 解析内から選択します。

タイプ: 文字列

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

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

: 必須 はい設定 (p. 83)

テーマ設定。テーマ表示プロパティが含まれます。

タイプ: ThemeConfiguration (p. 522) オブジェクト

: 必須 はい名前 (p. 83)

テーマの表示名。

タイプ: 文字列

84

CreateTheme

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

: 必須 はいアクセス許可 (p. 83)

新しいテーマに適用するリソースのアクセス許可の有効なグループ。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

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

: 必須 いいえタグ (p. 83)

リソースに追加するリソースタグのキーと値のペアのマップ。

タイプ: 配列インデックス作成Tag (p. 503)objects

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

: 必須 いいえVersionDescription (p. 83)

作成するテーマの最初のバージョンの説明。毎回UpdateThemeが呼び出されると、新しいバージョンが作成されます。テーマの各バージョンには、そのバージョンの説明がVersionDescriptionfield。

タイプ: 文字列

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

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

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

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 85)

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

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

Arn (p. 85)

テーマの Amazon リソースネーム (ARN)。

85

CreateTheme

タイプ: 文字列作成ステータス (p. 85)

テーマの作成ステータス。

タイプ: 文字列

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

RequestId (p. 85)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列ThemeId (p. 85)

テーマの ID です。

タイプ: 文字列

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

パターン: [\w\-]+バージョンARN (p. 85)

新しいテーマの Amazon リソースネーム (ARN)。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

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

86

CreateTheme

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

87

CreateThemeAlias

CreateThemeAliasテーマのテーマの別名を作成します。

リクエストの構文POST /accounts/AwsAccountId/themes/ThemeId/aliases/AliasName HTTP/1.1Content-type: application/json

{ "ThemeVersionNumber": number}

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

AliasName (p. 88)

作成するテーマ別名に付ける名前。エイリアス名は$。で始まるエイリアス名$Amazon QuickSight で予約されています。

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

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 はいAwsAccountId (p. 88)

新しいテーマエイリアスのテーマを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいThemeId (p. 88)

テーマ別名のID。

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

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

: 必須 はい

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

テーマEversionNumber (p. 88)

テーマのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

88

CreateThemeAlias

: 必須 はい

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "ThemeAlias": { "AliasName": "string", "Arn": "string", "ThemeVersionNumber": number }}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 89)

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

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

RequestId (p. 89)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列テーマエイリアス (p. 89)

テーマの別名に関する情報。

タイプ: ThemeAlias (p. 521) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400

89

CreateThemeAlias

LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

90

DeleteAccountCustomization

DeleteAccountCustomization指定された AWS アカウントと QuickSight 名前空間について、この AWS リージョン内のすべてのAmazon QuickSight カスタマイズを削除します。

リクエストの構文

DELETE /accounts/AwsAccountId/customizations?namespace=Namespace HTTP/1.1

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

AwsAccountId (p. 91)

この AWS リージョンで QuickSight カスタマイズを削除する AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はい名前空間 (p. 91)

カスタマイズを削除する元の QuickSight 名前空間。

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

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

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 91)

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

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

91

DeleteAccountCustomization

RequestId (p. 91)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript

92

DeleteAnalysis

DeleteAnalysisAmazon QuickSight から分析を削除します。オプションで、解析を復元できる回復ウィンドウを含めることができます。リカバリウィンドウの値を指定しない場合、オペレーションのデフォルトは 30 日です。QuickSight はDeletionTimeスタンプを、リカバリ・ウィンドウの終了を指定するレスポンスに挿入します。復旧期間の終了時に、QuickSight は解析を完全に削除します。

復旧期間が終了する前に、いつでもRestoreAnalysisAPI オペレーションを使用して、DeletionTimeスタンプし、解析の削除をキャンセルします。分析は、削除されるまでAPIに表示され続けるので、説明することはできますが、テンプレートを作成することはできません。

削除がスケジュールされている分析は、QuickSight コンソールではアクセスできません。コンソールでアクセスするには、復元します。分析を削除しても、公開したダッシュボードは削除されません。

リクエストの構文DELETE /accounts/AwsAccountId/analyses/AnalysisId?force-delete-without-recovery=ForceDeleteWithoutRecovery&recovery-window-in-days=RecoveryWindowInDays HTTP/1.1

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

AnalysisId (p. 94)

削除する分析の ID。

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

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

: 必須 はいAwsAccountId (p. 94)

分析を削除する AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はい強制削除without回復 (p. 94)

このオプションのデフォルトはです。NoForceDeleteWithoutRecovery。解析をすぐに削除するには、ForceDeleteWithoutRecoveryオプション。分析を削除した後、復元することはできません。

RecoveryWindowDays (p. 94)

QuickSight が分析を削除するまで待機する日数を指定する値。このパラメータは、ForceDeleteWithoutRecoveryオプションを同じ API 呼び出しで呼び出します。デフォルト値は 30 です。

有効範囲: 最小値は 7 です。最大値は 30 です。

リクエストボディリクエストボディにリクエストボディはありません。

94

DeleteAnalysis

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "AnalysisId": "string", "Arn": "string", "DeletionTime": number, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 95)

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

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

AnalysisId (p. 95)

削除された分析の ID。

タイプ: 文字列

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

パターン: [\w\-]+Arn (p. 95)

削除された分析の Amazon リソースネーム (ARN)

タイプ: 文字列削除時間 (p. 95)

分析が削除されるようにスケジュールされた日時。

タイプ: タイムスタンプRequestId (p. 95)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409

95

DeleteAnalysis

InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

96

DeleteDashboard

DeleteDashboardダッシュボードを削除します。

リクエストの構文DELETE /accounts/AwsAccountId/dashboards/DashboardId?version-number=VersionNumber HTTP/1.1

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

AwsAccountId (p. 97)

削除するダッシュボードを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいDashboardId (p. 97)

ダッシュボードの ID。

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

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

: 必須 はいVersionNumber (p. 97)

ダッシュボードのバージョン番号。バージョン番号プロパティを指定すると、指定したバージョンのダッシュボードのみが削除されます。

有効範囲: 最小値は 1 です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

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

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

97

DeleteDashboard

ステータス (p. 97)

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

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

Arn (p. 97)

リソースに適用する Secure Sockets Layer (SSL) プロパティ。

タイプ: 文字列DashboardId (p. 97)

ダッシュボードの ID。

タイプ: 文字列

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

パターン: [\w\-]+RequestId (p. 97)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard

98

DeleteDashboard

Edition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

99

DeleteDataSet

DeleteDataSetデータセットを削除します。

リクエストの構文DELETE /accounts/AwsAccountId/data-sets/DataSetId HTTP/1.1

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

AwsAccountId (p. 100)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいデータセット ID (p. 100)

作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "DataSetId": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 100)

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

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

Arn (p. 100)

データセットの Amazon リソースネーム (ARN)。

100

DeleteDataSet

タイプ: 文字列データセット ID (p. 100)

作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列RequestId (p. 100)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExample

この例では、DeleteDataSet の 1 つの使用方法を示します。

リクエスト例

DELETE /accounts/{AwsAccountId}/data-sets/{DataSetId} HTTP/1.1Content-type: application/json

101

DeleteDataSource

DeleteDataSourceデータソースを完全に削除します。この操作は、削除されたデータソースを参照するすべてのデータセットを破棄します。

リクエストの構文DELETE /accounts/AwsAccountId/data-sources/DataSourceId HTTP/1.1

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

AwsAccountId (p. 103)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいデータソース ID (p. 103)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "DataSourceId": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 103)

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

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

Arn (p. 103)

削除したデータソースの Amazon リソースネーム (ARN)。

103

DeleteDataSource

タイプ: 文字列データソース ID (p. 103)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列RequestId (p. 103)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExample

この例では、DeleteDataSource の 1 つの使用方法を示しています。

リクエスト例

DELETE /accounts/{AwsAccountId}/data-sources/{DataSourceId} HTTP/1.1Content-type: application/json

104

DeleteGroup

DeleteGroupAmazon QuickSight からユーザーグループを削除します。

リクエストの構文

DELETE /accounts/AwsAccountId/namespaces/Namespace/groups/GroupName HTTP/1.1

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

AwsAccountId (p. 106)

グループが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はいGroupName (p. 106)

削除するグループの名前。

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

パターン: [\u0020-\u00FF]+

: 必須 はい名前空間 (p. 106)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string"}

106

DeleteGroup

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 106)

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

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

RequestId (p. 106)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

107

DeleteGroupMembership

DeleteGroupMembershipユーザーをグループから削除します。これにより、そのユーザーは、そのグループのメンバーでなくなります。

リクエストの構文

DELETE /accounts/AwsAccountId/namespaces/Namespace/groups/GroupName/members/MemberName HTTP/1.1

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

AwsAccountId (p. 109)

グループが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はいGroupName (p. 109)

ユーザーを削除するグループの名前。

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

パターン: [\u0020-\u00FF]+

: 必須 はいメンバー名 (p. 109)

グループメンバーシップから削除するユーザーの名前。

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

パターン: [\u0020-\u00FF]+

: 必須 はい名前空間 (p. 109)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

109

DeleteGroupMembership

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 110)

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

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

RequestId (p. 110)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404

110

DeleteGroupMembership

ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

111

DeleteIAMPolicyAssignment

DeleteIAMPolicyAssignment既存の IAM ポリシー割り当てを削除します。

リクエストの構文

DELETE /accounts/AwsAccountId/namespace/Namespace/iam-policy-assignments/AssignmentName HTTP/1.1

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

割り当て名 (p. 112)

割り当ての名前。

長さ制約: 最小長は 1 です。

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$

: 必須 はいAwsAccountId (p. 112)

IAM ポリシー割り当てを削除する AWS アカウント ID。

長さ制約: 固定長 12。

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

: 必須 はい名前空間 (p. 112)

割り当てを含む名前空間。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "AssignmentName": "string", "RequestId": "string"}

112

DeleteIAMPolicyAssignment

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 112)

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

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

割り当て名 (p. 112)

割り当ての名前。

タイプ: 文字列

長さ制約: 最小長は 1 です。

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$RequestId (p. 112)

このオペレーションの AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401同時処理例外

リソースは、新しい更新を適用する前に完了する必要がある操作が実行中であることを示す状態ですでにあります。

HTTP ステータスコード: 500InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409

113

DeleteIAMPolicyAssignment

ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

114

DeleteNamespace

DeleteNamespace名前空間と、その名前空間に関連付けられているユーザーとグループを削除します。これは非同期プロセスです。ダッシュボード、分析、データセット、データソースなどのアセットは削除されません。これらのアセットを削除するには、関連するアセットの API オペレーションを使用します。

リクエストの構文DELETE /accounts/AwsAccountId/namespaces/Namespace HTTP/1.1

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

AwsAccountId (p. 115)

QuickSight 名前空間を削除する AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はい名前空間 (p. 115)

削除する名前空間。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 115)

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

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

115

DeleteNamespace

RequestId (p. 115)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

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

• AWS Command Line Interface• AWS SDK for .NET

116

DeleteTemplate

DeleteTemplateテンプレートを削除します。

リクエストの構文DELETE /accounts/AwsAccountId/templates/TemplateId?version-number=VersionNumber HTTP/1.1

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

AwsAccountId (p. 118)

削除するテンプレートを含む AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はいTemplateId (p. 118)

削除するテンプレートの ID。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

: 必須 はいVersionNumber (p. 118)

削除するテンプレートのバージョンを指定します。バージョン番号を指定しない場合、DeleteTemplateテンプレートのすべてのバージョンを削除します。

有効範囲: 最小値は 1 です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "RequestId": "string", "TemplateId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

118

DeleteTemplate

ステータス (p. 118)

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

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

Arn (p. 118)

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列RequestId (p. 118)

オペレーションの AWS リクエスト ID

タイプ: 文字列TemplateId (p. 118)

テンプレートの ID。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

119

DeleteTemplate

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

120

DeleteTemplateAlias

DeleteTemplateAlias指定されたテンプレートのエイリアスが指す項目を削除します。特定のエイリアスを指定する場合は、エイリアスが指すテンプレートのバージョンを削除します。

リクエストの構文DELETE /accounts/AwsAccountId/templates/TemplateId/aliases/AliasName HTTP/1.1

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

AliasName (p. 121)

テンプレートエイリアスの名前。特定のエイリアスを削除するには、エイリアスが指すバージョンを削除します。エイリアス名を指定するか、キーワード$LATEST()AliasNameパラメータ。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 はいAwsAccountId (p. 121)

削除する項目を含む AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はいTemplateId (p. 121)

指定したエイリアスの対象となるテンプレートの ID。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AliasName": "string", "Arn": "string", "RequestId": "string", "TemplateId": "string"

121

DeleteTemplateAlias

}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 121)

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

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

AliasName (p. 121)

テンプレートエイリアスの名前。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)Arn (p. 121)

削除するテンプレートの Amazon リソースネーム (ARN)。

タイプ: 文字列RequestId (p. 121)

オペレーションの AWS リクエスト ID

タイプ: 文字列TemplateId (p. 121)

削除に関連付けられたテンプレートの ID。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500ResourceNotFoundException

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

122

DeleteTemplateAlias

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

123

DeleteTheme

DeleteThemeテーマを削除します。

リクエストの構文

DELETE /accounts/AwsAccountId/themes/ThemeId?version-number=VersionNumber HTTP/1.1

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

AwsAccountId (p. 124)

削除するテーマを含む AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はいThemeId (p. 124)

削除するテーマの ID。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

: 必須 はいVersionNumber (p. 124)

削除するテーマのバージョン。

注意: バージョン番号を指定しない場合は、この呼び出しを使用してDeleteThemeテーマのすべてのバージョンを削除します。

有効範囲: 最小値は 1 です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "RequestId": "string", "ThemeId": "string"}

124

DeleteTheme

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 124)

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

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

Arn (p. 124)

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列RequestId (p. 124)

オペレーションの AWS リクエスト ID

タイプ: 文字列ThemeId (p. 124)

テーマの ID です。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400

125

DeleteTheme

ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

126

DeleteThemeAlias

DeleteThemeAlias指定したテーマのエイリアスが指すテーマのバージョンを削除します。特定のエイリアスを指定すると、エイリアスが指すテーマのバージョンを削除します。

リクエストの構文DELETE /accounts/AwsAccountId/themes/ThemeId/aliases/AliasName HTTP/1.1

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

AliasName (p. 127)

削除するテーマ別の一意の名前。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 はいAwsAccountId (p. 127)

削除するテーマのエイリアスを含む AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はいThemeId (p. 127)

指定したエイリアスが対象となっているテーマの ID。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AliasName": "string", "Arn": "string", "RequestId": "string", "ThemeId": "string"}

127

DeleteThemeAlias

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 127)

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

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

AliasName (p. 127)

テーマのエイリアスの名前。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)Arn (p. 127)

削除したエイリアスを使用するテーマリソースの Amazon リソースネーム (ARN)。

タイプ: 文字列RequestId (p. 127)

オペレーションの AWS リクエスト ID

タイプ: 文字列ThemeId (p. 127)

削除に関連付けられたテーマの ID。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400

128

DeleteThemeAlias

ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

129

DeleteUser

DeleteUser呼び出しをしている AWS Identity and Access Management (IAM) ユーザーまたはロールの ID に関連付けられている Amazon QuickSight ユーザーを削除します。この呼び出しの結果として、IAM ユーザーは削除されません。

リクエストの構文DELETE /accounts/AwsAccountId/namespaces/Namespace/users/UserName HTTP/1.1

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

AwsAccountId (p. 130)

ユーザーが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さ制約: 固定長 12。

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

: 必須 はい名前空間 (p. 130)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はいUserName (p. 130)

削除するユーザーの名前。

長さ制約: 最小長は 1 です。

パターン: [\u0020-\u00FF]+

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string"}

130

DeleteUser

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 130)

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

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

RequestId (p. 130)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

131

DeleteUser

HTTP ステータスコード: 429

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

132

DeleteUserByPrincipalId

DeleteUserByPrincipalIdプリンシパル ID で識別されたユーザーを削除します。

リクエストの構文DELETE /accounts/AwsAccountId/namespaces/Namespace/user-principals/PrincipalId HTTP/1.1

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

AwsAccountId (p. 133)

ユーザーが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さ制約: 固定長 12。

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

: 必須 はい名前空間 (p. 133)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はいPrincipalId (p. 133)

ユーザーのプリンシパル ID。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 133)

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

133

DeleteUserByPrincipalId

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

RequestId (p. 133)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

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

• AWS Command Line Interface

134

DescribeAccountCustomization

DescribeAccountCustomizationAWS リージョンで提供される AWS アカウントと Amazon QuickSight 名前空間に関連するカスタマイズについて説明します。QuickSight コンソールは、この API 操作をResolvedフラグが含まれます。

このコマンドの実行時に表示されるカスタマイズを決定するために、関連するエンティティの関係を視覚化するのに役立ちます。

• AWS Account-AWS アカウントは階層の最上位に存在します。すべての AWS リージョンと AWS サービスを利用できる可能性があります。QuickSight をサブスクライブするときは、ホームリージョンとして使用する AWS リージョンを 1 つ選択します。そこには、無料の SPICE 容量があります。サポートされているすべての AWS リージョンで QuickSight を使用できます。

• AWS Region-QuickSight に少なくとも 1 回サインインする各 AWS リージョンでは、QuickSight は同じサービスの個別のインスタンスとして機能します。ユーザーディレクトリがある場合、このディレクトリは us-east-1 (米国東部 (バージニア北部) に存在します。一般に、これらのユーザーは、名前空間に制限されていない限り、どの AWS リージョンでも QuickSight にアクセスできます。

別の AWS リージョンでコマンドを実行するには、リージョン設定を変更します。AWS CLI を使用する場合、次のいずれかのオプションを使用できます。• を使用するコマンドラインオプション。• を使用する名前を指定されたプロファイル。• Runaws configure[] にデフォルトの AWS リージョンを変更します。[Enter] を使用して、キーに対

して同じ設定をキー設定します。詳細については、「AWS CLI の設定」を参照してください。• Namespace-QuickSight 名前空間は、ユーザーとアセット(データソース、データセット、ダッシュ

ボードなど)を含むパーティションです。特定の名前空間にあるアセットにアクセスするには、ユーザーとグループも同じ名前空間の一部である必要があります。名前空間を共有するユーザーは、同じAWS アカウントと AWS リージョンに属していても、他の名前空間のユーザーやアセットから完全に隔離されます。

• Applied customizations-AWS リージョン内では、一連の QuickSight カスタマイズを AWS アカウントまたは名前空間に適用できます。名前空間に適用する設定は、AWS アカウントに適用する設定よりも優先されます。すべての設定は、単一の AWS リージョンに分離されます。他の AWS リージョンに適用するには、CreateAccountCustomizationコマンドを実行し、同じカスタマイズを適用するAWS リージョンを指定します。

リクエストの構文GET /accounts/AwsAccountId/customizations?namespace=Namespace&resolved=Resolved HTTP/1.1

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

AwsAccountId (p. 136)

QuickSight カスタマイズを記述する AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はい名前空間 (p. 136)

QuickSight のカスタマイズを記述する QuickSight 名前空間。

136

DescribeAccountCustomization

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

パターン: ^[a-zA-Z0-9._-]*$Resolved (解決済み) (p. 136)

-Resolvedフラグは他のパラメータと連携して、QuickSight カスタマイズのどのビューが返されるかを決定します。このフラグをコマンドに追加すると、QuickSight がコンソールに適用するカスタマイズを識別するのと同じビューを使用できます。このフラグを省略するか、no-resolvedを使用して、異なるレベルで構成されているカスタマイズを表示します。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AccountCustomization": { "DefaultTheme": "string" }, "Arn": "string", "AwsAccountId": "string", "Namespace": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 137)

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

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

アカウントのカスタマイズ (p. 137)

現在の AWS リージョンに存在する QuickSight のカスタマイズ。

タイプ: AccountCustomization (p. 383) オブジェクトArn (p. 137)

この AWS アカウントに関連付けられたカスタマイズの Amazon リソースネーム (ARN)。

タイプ: 文字列AwsAccountId (p. 137)

説明する AWS アカウントの ID。

タイプ: 文字列

長さ制約: 固定長 12。

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

137

DescribeAccountCustomization

名前空間 (p. 137)

説明している QuickSight 名前空間。

タイプ: 文字列

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

パターン: ^[a-zA-Z0-9._-]*$RequestId (p. 137)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

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

138

DescribeAccountSettings

DescribeAccountSettingsこの AWS アカウントで QuickSight サブスクリプションが最初に作成されたときに使用された設定について説明します。

リクエストの構文GET /accounts/AwsAccountId/settings HTTP/1.1

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

AwsAccountId (p. 140)

リストを作成する設定を含む AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AccountSettings": { "AccountName": "string", "DefaultNamespace": "string", "Edition": "string", "NotificationEmail": "string" }, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 140)

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

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

アカウント設定 (p. 140)

この AWS アカウントの QuickSight 設定。この情報には、サブスクライブした Amazon QuickSightのエディション(スタンダードまたはエンタープライズ)と、QuickSight サブスクリプションの通知

140

DescribeAccountSettings

メールが含まれます。QuickSight コンソールでは、QuickSight サブスクリプションは、技術的にはそれ自体がアカウントではありませんが、QuickSight の「アカウント」と呼ばれることがあります。代わりに、AWS アカウントの QuickSight サービスのサブスクリプションです。サブスクライブするエディションは、使用するすべての AWS リージョンの QuickSight に適用されます。

タイプ: AccountSettings (p. 384) オブジェクトRequestId (p. 140)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

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

• AWS Command Line Interface

141

DescribeAnalysis

DescribeAnalysis分析のメタデータのサマリーを提供します。

リクエストの構文GET /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1

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

AnalysisId (p. 143)

説明する分析の ID。ID は分析の URL の一部です。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

: 必須 はいAwsAccountId (p. 143)

分析を含む AWS アカウントの ID。分析対象の AWS アカウントを使用する必要があります。

長さ制約: 固定長 12。

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Analysis": { "AnalysisId": "string", "Arn": "string", "CreatedTime": number, "DataSetArns": [ "string" ], "Errors": [ { "Message": "string", "Type": "string" } ], "LastUpdatedTime": number, "Name": "string", "Sheets": [ { "Name": "string",

143

DescribeAnalysis

"SheetId": "string" } ], "Status": "string", "ThemeArn": "string" }, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 143)

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

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

分析 (p. 143)

説明する分析のサマリー情報を含むメタデータ構造。

タイプ: Analysis (p. 389) オブジェクトRequestId (p. 143)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404

144

DescribeAnalysis

ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

145

DescribeAnalysisPermissions

DescribeAnalysisPermissions分析の読み取りと書き込みのアクセス許可を提供します。

リクエストの構文GET /accounts/AwsAccountId/analyses/AnalysisId/permissions HTTP/1.1

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

AnalysisId (p. 146)

アクセス許可を説明する分析の ID。ID は分析 URL の一部です。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

: 必須 はいAwsAccountId (p. 146)

説明するアクセス許可を持つ分析を含む AWS アカウントの ID。分析対象の AWS アカウントを使用する必要があります。

長さ制約: 固定長 12。

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AnalysisArn": "string", "AnalysisId": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

146

DescribeAnalysisPermissions

ステータス (p. 146)

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

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

分析サーン (p. 146)

アクセス許可を記述する分析の Amazon リソースネーム (ARN)。

タイプ: 文字列AnalysisId (p. 146)

アクセス許可を説明する分析の ID。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+アクセス許可 (p. 146)

分析のプリンシパルとリソースレベルのパーミッションを記述する構造体。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 146)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

147

DescribeAnalysisPermissions

UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

148

DescribeDashboard

DescribeDashboardダッシュボードの概要を提供します。

リクエストの構文GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

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

AliasName (p. 149)

エイリアス名。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)AwsAccountId (p. 149)

説明するダッシュボードが含まれる AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はいDashboardId (p. 149)

ダッシュボードの ID。

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

: 必須 はいVersionNumber (p. 149)

ダッシュボードのバージョン番号。バージョン番号が渡されない場合、最新の公開済みダッシュボードバージョンが記述されます。

有効範囲: 最小値は 1 です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Dashboard": { "Arn": "string",

149

DescribeDashboard

"CreatedTime": number, "DashboardId": "string", "LastPublishedTime": number, "LastUpdatedTime": number, "Name": "string", "Version": { "Arn": "string", "CreatedTime": number, "DataSetArns": [ "string" ], "Description": "string", "Errors": [ { "Message": "string", "Type": "string" } ], "Sheets": [ { "Name": "string", "SheetId": "string" } ], "SourceEntityArn": "string", "Status": "string", "ThemeArn": "string", "VersionNumber": number } }, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 149)

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

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

ダッシュボード (p. 149)

ダッシュボードに関する情報。

タイプ: Dashboard (p. 414) オブジェクトRequestId (p. 149)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの

150

DescribeDashboard

利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

151

DescribeDashboardPermissions

DescribeDashboardPermissionsダッシュボードの読み取りと書き込みのアクセス許可を説明します。

リクエストの構文

GET /accounts/AwsAccountId/dashboards/DashboardId/permissions HTTP/1.1

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

AwsAccountId (p. 152)

アクセス許可を説明しているダッシュボードを含む AWS アカウントの ID。

長さ制約: 固定長 12。

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

: 必須 はいDashboardId (p. 152)

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

長さ制約: 最小長は 1 です。 最大長は 2048 です。

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "DashboardArn": "string", "DashboardId": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

152

DescribeDashboardPermissions

ステータス (p. 152)

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

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

DashboardArn (p. 152)

ダッシュボードの Amazon リソースネーム (ARN)。

タイプ: 文字列DashboardId (p. 152)

ダッシュボードの ID。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+アクセス許可 (p. 152)

ダッシュボードのアクセス許可を含む構造。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 152)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

153

DescribeDashboardPermissions

UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

154

DescribeDataSet

DescribeDataSetデータセットについて説明します。

リクエストの構文GET /accounts/AwsAccountId/data-sets/DataSetId HTTP/1.1

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

AwsAccountId (p. 155)

AWS アカウント ID。

長さ制約: 固定長 12。

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

: 必須 はいデータセット ID (p. 155)

作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "DataSet": { "Arn": "string", "ColumnGroups": [ { "GeoSpatialColumnGroup": { "Columns": [ "string" ], "CountryCode": "string", "Name": "string" } } ], "ColumnLevelPermissionRules": [ { "ColumnNames": [ "string" ], "Principals": [ "string" ] } ], "ConsumedSpiceCapacityInBytes": number, "CreatedTime": number, "DataSetId": "string", "FieldFolders": {

155

DescribeDataSet

"string" : { "columns": [ "string" ], "description": "string" } }, "ImportMode": "string", "LastUpdatedTime": number, "LogicalTableMap": { "string" : { "Alias": "string", "DataTransforms": [ { "CastColumnTypeOperation": { "ColumnName": "string", "Format": "string", "NewColumnType": "string" }, "CreateColumnsOperation": { "Columns": [ { "ColumnId": "string", "ColumnName": "string", "Expression": "string" } ] }, "FilterOperation": { "ConditionExpression": "string" }, "ProjectOperation": { "ProjectedColumns": [ "string" ] }, "RenameColumnOperation": { "ColumnName": "string", "NewColumnName": "string" }, "TagColumnOperation": { "ColumnName": "string", "Tags": [ { "ColumnDescription": { "Text": "string" }, "ColumnGeographicRole": "string" } ] } } ], "Source": { "JoinInstruction": { "LeftJoinKeyProperties": { "UniqueKey": boolean }, "LeftOperand": "string", "OnClause": "string", "RightJoinKeyProperties": { "UniqueKey": boolean }, "RightOperand": "string", "Type": "string" }, "PhysicalTableId": "string" } } },

156

DescribeDataSet

"Name": "string", "OutputColumns": [ { "Description": "string", "Name": "string", "Type": "string" } ], "PhysicalTableMap": { "string" : { "CustomSql": { "Columns": [ { "Name": "string", "Type": "string" } ], "DataSourceArn": "string", "Name": "string", "SqlQuery": "string" }, "RelationalTable": { "Catalog": "string", "DataSourceArn": "string", "InputColumns": [ { "Name": "string", "Type": "string" } ], "Name": "string", "Schema": "string" }, "S3Source": { "DataSourceArn": "string", "InputColumns": [ { "Name": "string", "Type": "string" } ], "UploadSettings": { "ContainsHeader": boolean, "Delimiter": "string", "Format": "string", "StartFromRow": number, "TextQualifier": "string" } } } }, "RowLevelPermissionDataSet": { "Arn": "string", "FormatVersion": "string", "Namespace": "string", "PermissionPolicy": "string" } }, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

157

DescribeDataSet

ステータス (p. 155)

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

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

DataSet (p. 155)

データセットに関する情報。

タイプ: DataSet (p. 428) オブジェクトRequestId (p. 155)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExample

この例では、DescribeDataSet の使用方法を示します。

158

DescribeDataSet

リクエスト例

GET /accounts/{AwsAccountId}/data-sets/{DataSetId} HTTP/1.1Content-type: application/json

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

159

DescribeDataSetPermissions

DescribeDataSetPermissionsデータセットに対する権限について説明します。

権限リソースはarn:aws:quicksight:region:aws-account-id:dataset/data-set-id。

リクエストの構文GET /accounts/AwsAccountId/data-sets/DataSetId/permissions HTTP/1.1

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

AwsAccountId (p. 160)

AWS アカウント ID。

長さ制約: 固定長 12。

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

: 必須 はいデータセット ID (p. 160)

作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "DataSetArn": "string", "DataSetId": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 160)

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

160

DescribeDataSetPermissions

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

DataSetArn (p. 160)

データセットの Amazon リソースネーム (ARN)。

タイプ: 文字列データセット ID (p. 160)

作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列アクセス許可 (p. 160)

データセットに対するリソース権限のリスト。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 160)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

161

DescribeDataSetPermissions

ExamplesExample

この例では、DescribeDataSetPermissions の使用方法を示します。

リクエスト例

GET /accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions HTTP/1.1Content-type: application/json

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

162

DescribeDataSource

DescribeDataSourceデータソースについて説明します。

リクエストの構文GET /accounts/AwsAccountId/data-sources/DataSourceId HTTP/1.1

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

AwsAccountId (p. 163)

AWS アカウント ID。

長さ制約: 固定長 12。

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

: 必須 はいデータソース ID (p. 163)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "DataSource": { "AlternateDataSourceParameters": [ { "AmazonElasticsearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": {

163

DescribeDataSource

"DataSetName": "string" }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": { "Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string",

164

DescribeDataSource

"Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } } ], "Arn": "string", "CreatedTime": number, "DataSourceId": "string", "DataSourceParameters": { "AmazonElasticsearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "string" }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": { "Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string",

165

DescribeDataSource

"Host": "string", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } }, "ErrorInfo": { "Message": "string", "Type": "string" }, "LastUpdatedTime": number, "Name": "string", "SslProperties": { "DisableSsl": boolean }, "Status": "string", "Type": "string", "VpcConnectionProperties": { "VpcConnectionArn": "string" } }, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 163)

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

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

166

DescribeDataSource

DataSource (p. 163)

データソースの情報。

タイプ: DataSource (p. 436) オブジェクトRequestId (p. 163)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript

167

DescribeDataSourcePermissions

DescribeDataSourcePermissionsデータソースのリソース権限について説明します。

リクエストの構文

GET /accounts/AwsAccountId/data-sources/DataSourceId/permissions HTTP/1.1

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

AwsAccountId (p. 169)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいデータソース ID (p. 169)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "DataSourceArn": "string", "DataSourceId": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 169)

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

169

DescribeDataSourcePermissions

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

DataSourceArn (p. 169)

データソースの Amazon リソースネーム (ARN)。

タイプ: 文字列データソース ID (p. 169)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列アクセス許可 (p. 169)

データソース上のリソースアクセス許可のリスト。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 169)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

170

DescribeDataSourcePermissions

ExamplesExample

この例では、DescribeDataSourcePermissions の使用方法を示します。

リクエスト例

GET /accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions HTTP/1.1Content-type: application/json

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

171

DescribeGroup

DescribeGroupAmazon QuickSight グループの説明と Amazon リソースネーム (ARN) を返します。

リクエストの構文GET /accounts/AwsAccountId/namespaces/Namespace/groups/GroupName HTTP/1.1

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

AwsAccountId (p. 172)

グループが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はいGroupName (p. 172)

説明するグループの名前。

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

パターン: [\u0020-\u00FF]+

: 必須 はい名前空間 (p. 172)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Group": { "Arn": "string", "Description": "string", "GroupName": "string", "PrincipalId": "string"

172

DescribeGroup

}, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 172)

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

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

グループ (p. 172)

グループの名前。

タイプ: Group (p. 451) オブジェクトRequestId (p. 172)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404

173

DescribeGroup

ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

174

DescribeIAMPolicyAssignment

DescribeIAMPolicyAssignment割り当て名によって指定される、既存の IAM ポリシー割り当てについて説明します。

リクエストの構文

GET /accounts/AwsAccountId/namespaces/Namespace/iam-policy-assignments/AssignmentName HTTP/1.1

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

割り当て名 (p. 175)

割り当ての名前。ルールとも呼ばれます。

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

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$

: 必須 はいAwsAccountId (p. 175)

説明する割り当てを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はい名前空間 (p. 175)

割り当てを含む名前空間。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "IAMPolicyAssignment": { "AssignmentId": "string", "AssignmentName": "string", "AssignmentStatus": "string",

175

DescribeIAMPolicyAssignment

"AwsAccountId": "string", "Identities": { "string" : [ "string" ] }, "PolicyArn": "string" }, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 175)

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

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

IAMPolicy割り当て (p. 175)

IAM ポリシーの割り当てを説明する情報。

タイプ: IAMPolicyAssignment (p. 454) オブジェクトRequestId (p. 175)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400

176

DescribeIAMPolicyAssignment

ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

177

DescribeIngestion

DescribeIngestionSPICE の取り込みについて説明します。

リクエストの構文GET /accounts/AwsAccountId/data-sets/DataSetId/ingestions/IngestionId HTTP/1.1

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

AwsAccountId (p. 178)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいデータセット ID (p. 178)

取り込みで使用されるデータセットの ID。

: 必須 はい取り込み ID (p. 178)

取り込みの ID。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Ingestion": { "Arn": "string", "CreatedTime": number, "ErrorInfo": { "Message": "string", "Type": "string" }, "IngestionId": "string", "IngestionSizeInBytes": number, "IngestionStatus": "string",

178

DescribeIngestion

"IngestionTimeInSeconds": number, "QueueInfo": { "QueuedIngestion": "string", "WaitingOnIngestion": "string" }, "RequestSource": "string", "RequestType": "string", "RowInfo": { "RowsDropped": number, "RowsIngested": number } }, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 178)

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

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

取り込み (p. 178)

取り込みに関する情報。

タイプ: Ingestion (p. 457) オブジェクトRequestId (p. 178)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400

179

DescribeIngestion

ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExample

この例では、DescribeingEstion の使用方法を 1 つ示します。

リクエスト例

GET /accounts/*AwsAccountId*/data-sets/*DataSetID*/ingestions/*IngestionID* HTTP/1.1

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

180

DescribeNamespace

DescribeNamespace現在のネームスペースを記述します。

リクエストの構文

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

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

AwsAccountId (p. 181)

示す QuickSight 名前空間を含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はい名前空間 (p. 181)

説明する必要がある名前空間。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

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

181

DescribeNamespace

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 181)

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

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

名前空間 (p. 181)

記述している名前空間に関する情報。応答には、名前空間 ARN、名前、AWS リージョン、作成ステータス、ID ストアが含まれます。DescribeNamespaceまた、作成されるプロセス中の名前空間に対しても機能します。不完全な名前空間の場合、この API 操作は、作成プロセスに関連付けられた名前空間のエラータイプとメッセージをリストします。

タイプ: NamespaceInfoV2 (p. 472) オブジェクトRequestId (p. 181)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503

182

DescribeNamespace

ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

183

DescribeTemplate

DescribeTemplateテンプレートのメタデータを説明します。

リクエストの構文

GET /accounts/AwsAccountId/templates/TemplateId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

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

AliasName (p. 184)

説明するテンプレートのエイリアス。特定のエイリアスに名前を付ける場合は、エイリアスが指すバージョンを記述します。テンプレートの最新バージョンを指定するには、キーワード$LATEST()AliasNameパラメータ。キーワード$PUBLISHEDはテンプレートには適用されません。

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

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)AwsAccountId (p. 184)

記述するテンプレートを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいTemplateId (p. 184)

テンプレートの ID。

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

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

: 必須 はいVersionNumber (p. 184)

(オプション) 説明するバージョンの番号。場合、VersionNumberパラメーター値が指定されていない場合は、テンプレートの最新バージョンについて説明します。

有効範囲: 最小値は 1 です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 Status

184

DescribeTemplate

Content-type: application/json

{ "RequestId": "string", "Template": { "Arn": "string", "CreatedTime": number, "LastUpdatedTime": number, "Name": "string", "TemplateId": "string", "Version": { "CreatedTime": number, "DataSetConfigurations": [ { "ColumnGroupSchemaList": [ { "ColumnGroupColumnSchemaList": [ { "Name": "string" } ], "Name": "string" } ], "DataSetSchema": { "ColumnSchemaList": [ { "DataType": "string", "GeographicRole": "string", "Name": "string" } ] }, "Placeholder": "string" } ], "Description": "string", "Errors": [ { "Message": "string", "Type": "string" } ], "Sheets": [ { "Name": "string", "SheetId": "string" } ], "SourceEntityArn": "string", "Status": "string", "ThemeArn": "string", "VersionNumber": number } }}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 184)

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

185

DescribeTemplate

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

RequestId (p. 184)

オペレーションの AWS リクエスト ID

タイプ: 文字列テンプレート (p. 184)

説明するオブジェクトのテンプレート構造。

タイプ: Template (p. 505) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard

186

DescribeTemplate

Edition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

187

DescribeTemplateAlias

DescribeTemplateAliasテンプレートのテンプレートエイリアスを説明します。

リクエストの構文GET /accounts/AwsAccountId/templates/TemplateId/aliases/AliasName HTTP/1.1

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

AliasName (p. 188)

説明するテンプレートのエイリアスの名前。特定のエイリアスに名前を付ける場合は、エイリアスが指すバージョンを記述します。テンプレートの最新バージョンを指定するには、キーワード$LATEST()AliasNameパラメータ。キーワード$PUBLISHEDはテンプレートには適用されません。

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

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 はいAwsAccountId (p. 188)

記述するテンプレートエイリアスを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいTemplateId (p. 188)

テンプレートの ID。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "TemplateAlias": { "AliasName": "string", "Arn": "string", "TemplateVersionNumber": number

188

DescribeTemplateAlias

}}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 188)

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

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

RequestId (p. 188)

オペレーションの AWS リクエスト ID

タイプ: 文字列テンプレート・エイリアス (p. 188)

テンプレートのエイリアスに関する情報。

タイプ: TemplateAlias (p. 507) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

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

HTTP ステータスコード: 500ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

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

HTTP ステータスコード: 403

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

189

DescribeTemplatePermissions

DescribeTemplatePermissionsテンプレートの読み取りと書き込みのアクセス許可を説明します。

リクエストの構文

GET /accounts/AwsAccountId/templates/TemplateId/permissions HTTP/1.1

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

AwsAccountId (p. 191)

記述するテンプレートを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいTemplateId (p. 191)

テンプレートの ID。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string", "TemplateArn": "string", "TemplateId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

191

DescribeTemplatePermissions

ステータス (p. 191)

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

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

アクセス許可 (p. 191)

テンプレートに設定するリソース権限のリスト。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 191)

オペレーションの AWS リクエスト ID

タイプ: 文字列TemplateArn (p. 191)

テンプレートの Amazon リソースネーム (ARN)。

タイプ: 文字列TemplateId (p. 191)

テンプレートの ID。

タイプ: 文字列

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

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

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404

192

DescribeTemplatePermissions

ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

193

DescribeTheme

DescribeThemeテーマについて説明します。

リクエストの構文

GET /accounts/AwsAccountId/themes/ThemeId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

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

AliasName (p. 194)

説明するテーマのエイリアス。特定のエイリアスに名前を付ける場合は、エイリアスが指すバージョンを記述します。テーマの最新バージョンを指定するには、キーワード$LATEST()AliasNameパラメータ。キーワード$PUBLISHEDはテーマには適用されません。

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

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)AwsAccountId (p. 194)

説明するテーマを含む AWS アカウントの ID。

パターン: ^(aws|[0-9]{12})$

: 必須 はいThemeId (p. 194)

テーマの ID です。

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

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

: 必須 はいVersionNumber (p. 194)

説明するバージョンのバージョン番号。場合、VersionNumberパラメーター値が指定されていない場合は、テーマの最新バージョンについて説明します。

有効範囲: 最小値は 1 です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 Status

194

DescribeTheme

Content-type: application/json

{ "RequestId": "string", "Theme": { "Arn": "string", "CreatedTime": number, "LastUpdatedTime": number, "Name": "string", "ThemeId": "string", "Type": "string", "Version": { "Arn": "string", "BaseThemeId": "string", "Configuration": { "DataColorPalette": { "Colors": [ "string" ], "EmptyFillColor": "string", "MinMaxGradient": [ "string" ] }, "Sheet": { "Tile": { "Border": { "Show": boolean } }, "TileLayout": { "Gutter": { "Show": boolean }, "Margin": { "Show": boolean } } }, "UIColorPalette": { "Accent": "string", "AccentForeground": "string", "Danger": "string", "DangerForeground": "string", "Dimension": "string", "DimensionForeground": "string", "Measure": "string", "MeasureForeground": "string", "PrimaryBackground": "string", "PrimaryForeground": "string", "SecondaryBackground": "string", "SecondaryForeground": "string", "Success": "string", "SuccessForeground": "string", "Warning": "string", "WarningForeground": "string" } }, "CreatedTime": number, "Description": "string", "Errors": [ { "Message": "string", "Type": "string" } ], "Status": "string", "VersionNumber": number } }

195

DescribeTheme

}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 194)

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

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

RequestId (p. 194)

オペレーションの AWS リクエスト ID

タイプ: 文字列テーマ (p. 194)

説明しているテーマに関する情報。

タイプ: Theme (p. 519) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404

196

DescribeTheme

ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

197

DescribeThemeAlias

DescribeThemeAliasテーマのエイリアスを説明します。

リクエストの構文GET /accounts/AwsAccountId/themes/ThemeId/aliases/AliasName HTTP/1.1

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

AliasName (p. 198)

説明するテーマ別名の名前。

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

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 はいAwsAccountId (p. 198)

説明するテーマのエイリアスを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいThemeId (p. 198)

テーマの ID です。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "ThemeAlias": { "AliasName": "string", "Arn": "string", "ThemeVersionNumber": number }

198

DescribeThemeAlias

}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 198)

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

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

RequestId (p. 198)

オペレーションの AWS リクエスト ID

タイプ: 文字列テーマエイリアス (p. 198)

テーマの別名に関する情報。

タイプ: ThemeAlias (p. 521) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

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

HTTP ステータスコード: 409InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard

199

DescribeThemeAlias

Edition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

200

DescribeThemePermissions

DescribeThemePermissionsテーマの読み取りと書き込みのアクセス許可を説明します。

リクエストの構文

GET /accounts/AwsAccountId/themes/ThemeId/permissions HTTP/1.1

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

AwsAccountId (p. 201)

説明するテーマを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいThemeId (p. 201)

アクセス許可を示すテーマの ID。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string", "ThemeArn": "string", "ThemeId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

201

DescribeThemePermissions

ステータス (p. 201)

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

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

アクセス許可 (p. 201)

テーマに設定されたリソース権限のリスト。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 201)

オペレーションの AWS リクエスト ID

タイプ: 文字列ThemeArn (p. 201)

テーマの Amazon リソースネーム (ARN)。

タイプ: 文字列ThemeId (p. 201)

テーマの ID です。

タイプ: 文字列

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

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

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

202

DescribeThemePermissions

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

203

DescribeUser

DescribeUserユーザー名が指定されている場合、ユーザーに関する情報を返します。

リクエストの構文GET /accounts/AwsAccountId/namespaces/Namespace/users/UserName HTTP/1.1

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

AwsAccountId (p. 204)

ユーザーがいる AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はい名前空間 (p. 204)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はいUserName (p. 204)

説明するユーザーの名前。

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

パターン: [\u0020-\u00FF]+

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "User": { "Active": boolean, "Arn": "string", "CustomPermissionsName": "string",

204

DescribeUser

"Email": "string", "ExternalLoginFederationProviderType": "string", "ExternalLoginFederationProviderUrl": "string", "ExternalLoginId": "string", "IdentityType": "string", "PrincipalId": "string", "Role": "string", "UserName": "string" }}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 204)

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

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

RequestId (p. 204)

オペレーションの AWS リクエスト ID

タイプ: 文字列ユーザー (p. 204)

ユーザー名。

タイプ: User (p. 540) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

205

DescribeUser

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

206

GetDashboardEmbedUrl

GetDashboardEmbedUrlAmazon QuickSight 読み取り専用ダッシュボードをウェブサーバーコードに埋め込むために使用できるセッション URL と認証コードを生成します。このコマンドを使用する前に、ダッシュボードとアクセス許可を構成していることを確認してください。

現在、はGetDashboardEmbedURLは、ユーザーのブラウザからではなく、サーバーからのみ使用できます。URL と認証コードの組み合わせには、次のルールが適用されます。

• これらは一緒に使用する必要があります。• これらは一度だけ使用できます。• このコマンドの実行後 5 分間有効です。• 得られたユーザーセッションは 10 時間有効です。

詳細については、「」を参照してください。埋め込まれたアナリティクス()Amazon QuickSight ユーザーガイド。

リクエストの構文GET /accounts/AwsAccountId/dashboards/DashboardId/embed-url?additional-dashboard-ids=AdditionalDashboardIds&creds-type=IdentityType&namespace=Namespace&reset-disabled=ResetDisabled&session-lifetime=SessionLifetimeInMinutes&state-persistence-enabled=StatePersistenceEnabled&undo-redo-disabled=UndoRedoDisabled&user-arn=UserArn HTTP/1.1

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

追加ダッシュボード (p. 207)

匿名ユーザーを含むセッションに追加する 1 つ以上のダッシュボード ID のリスト。-IdentityTypeパラメータはに設定する必要があります。ANONYMOUSが機能します。これは、他の ID タイプが QuickSight または IAM ユーザーとして認証されるためです。たとえば、」--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-typeANONYMOUS」の場合、セッションは 3 つのダッシュボードすべてにアクセスできます。

Array Membace 最小項目数は 1 項目です。最大数は 20 項目です。

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

パターン: [\w\-]+AwsAccountId (p. 207)

埋め込むダッシュボードを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいDashboardId (p. 207)

AWS Identity and Access Management (IAM) ポリシーにも追加されたダッシュボードの ID。

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

207

GetDashboardEmbedUrl

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

: 必須 はいIdentityType (p. 207)

ユーザーがサインインするために使用する認証方法。

有効な値: IAM | QUICKSIGHT | ANONYMOUS

: 必須 はい名前空間 (p. 207)

このリクエストのダッシュボード ID を含む QuickSight 名前空間。カスタム名前空間を使用していない場合は、これを」default「。

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

パターン: ^[a-zA-Z0-9._-]*$リセット無効 (p. 207)

埋め込みダッシュボードの [reset (リセット)] ボタンを削除。デフォルトは FALSE で、リセットボタンが有効になります。

セッションライフタイム (分) (p. 207)

セッションが有効な時間 (分) セッションの有効期間は 15 〜 600 分です。

有効範囲: 最小値は 15 です。最大値は 600 です。ステートパーシステンス有効 (p. 207)

埋め込みダッシュボードのユーザーセッションの状態の永続性を追加します。永続性は、シートとパラメータ設定に適用されます。これらは、ダッシュボードの表示中にダッシュボードのサブスクライバ(QuickSight リーダー)が選択する制御設定です。これは、に設定されます。TRUEに設定されている場合、サブスクライバが同じダッシュボード URL を再度開いたときの設定は同じになります。状態は、ブラウザのクッキーではなく、QuickSight に保存されます。これがFALSEに設定されている場合、ユーザーセッションの状態は永続化されません。デフォルト: FALSE。

元に戻す無効化 (p. 207)

埋め込みダッシュボードの [undo]/[redo] ボタンを削除 デフォルトは FALSE で、[元に戻す]/[やり直し]ボタンが有効になります。

ユーザーアーン (p. 207)

で使用する Amazon QuickSight ユーザーの Amazon リソースネーム (ARN)。QUICKSIGHTID のタイプ。これは、アカウントの Amazon QuickSight ユーザー (閲覧者、作成者、または管理者) で次のいずれかとして認証された場合に使用できます。• Active Directory (AD) ユーザーまたはグループメンバー• 招待された非フェデレーティッドユーザー• SAML、OpenID Connect、または IAM フェデレーションを使用したフェデレーションのシングルサ

インオンを通じて認証された IAM ユーザーおよび IAM ロールベースセッション。

3 番目のグループのユーザー (IAM ユーザーと IAM ロールベースのセッション) では、このパラメータは省略します。

リクエストボディリクエストボディにリクエストボディはありません。

208

GetDashboardEmbedUrl

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "EmbedUrl": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 209)

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

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

埋め込みURL (p. 209)

ダッシュボードを埋め込むためにサーバー側の Web ページに配置できる使い捨ての URL。この URLは 5 分間有効です。API オペレーションは、URL にauth_code値を 1 つだけ有効にし、10 時間有効なユーザーセッションへのサインオンを有効にします。

タイプ: 文字列RequestId (p. 209)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401DomainNotWhitelistedException

指定されたドメインが許可リストにありません。埋め込みダッシュボードのすべてのドメインは、Amazon QuickSight 管理者が承認済みリストに追加する必要があります。

HTTP ステータスコード: 403IdentityTypeNotSupportedException

指定されたアイデンティティタイプはサポートされていません。サポートされる ID タイプにはIAMおよびQUICKSIGHT。

209

GetDashboardEmbedUrl

HTTP ステータスコード: 403InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400QuickSightUserNotFoundException

指定された名前のユーザーが見つかりません。このエラーは、提供されたユーザー名に基づいてユーザーを見つける必要があるオペレーションで発生する可能性があります。DeleteUser,DescribeUserなどといった設定です。

HTTP ステータスコード: 404ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404SessionLifetimeInMinutesInvalidException

セッションの存続期間に指定された分数が無効です。セッションの有効期間は 15 〜 600 分です。

HTTP ステータスコード: 400ThrottlingException

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

HTTP ステータスコード: 429サポートされていない価格設定プラン例外

このエラーは、AWS アカウントに必要な料金プランなしで Amazon QuickSight に埋め込みオペレーションを呼び出していることを示します。匿名ユーザーに埋め込みを使用できるようにするには、QuickSight 管理者は QuickSight にキャパシティ価格を追加する必要があります。この操作は、[]の [] ダイアログQuickSight の管理ページで.

キャパシティ価格が追加されたら、GetDashboardEmbedUrl (p. 207)API オペレーション--identity-type ANONYMOUSオプション。

HTTP ステータスコード: 403UnsupportedUserEditionException

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

HTTP ステータスコード: 403

210

GetSessionEmbedUrl

GetSessionEmbedUrlAmazon QuickSight コンソールをウェブサーバーコードに埋め込むために使用できるセッション URL と認証コードを生成します。を使用するGetSessionEmbedUrlここで、ユーザーがデータソース、データセット、分析、およびダッシュボードを作成できるオーサリングポータルを提供します。組み込みのQuickSight コンソールにアクセスするユーザーは、作成者または管理者セキュリティコホートに属している必要があります。権限をこれらの機能の一部に制限する場合は、カスタム権限プロファイルをユーザーに追加し、 UpdateUser (p. 375) API オペレーション。を使用する RegisterUser (p. 278)API オペレーションを使用して、カスタム権限プロファイルがアタッチされた新しいユーザーを追加します。詳細については、次のセクションを参照してください。Amazon QuickSight ユーザーガイド:

• Amazon QuickSight コンソールの埋め込み• Amazon QuickSight コンソールへのアクセスをカスタマイズする

リクエストの構文

GET /accounts/AwsAccountId/session-embed-url?entry-point=EntryPoint&session-lifetime=SessionLifetimeInMinutes&user-arn=UserArn HTTP/1.1

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

AwsAccountId (p. 212)

QuickSight サブスクリプションに関連付けられた AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいEntryPoint (p. 212)

埋め込みセッションへのアクセスに使用する URL。エントリポイント URL は、次のパスに制限されます。• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId -ここで、としますDashboardIdは、ダッシュボードの QuickSightコンソールの URL からの実際の ID キーです。

• /analyses/AnalysisId -ここで、としますAnalysisIdは、分析の QuickSight コンソールのURL からの実際の ID キーです。

長さの制約: 最小長は 1 です。 最大長は 1000 です。セッションライフタイム (分) (p. 212)

セッションが有効な時間 (分) セッションの有効期間は 15 〜 600 分です。

有効範囲: 最小値は 15 です。最大値は 600 です。

212

GetSessionEmbedUrl

ユーザーアーン (p. 212)

で使用する Amazon QuickSight ユーザーの Amazon リソースネーム (ARN)。QUICKSIGHTID のタイプ。これは、アカウント内のAmazon QuickSight ユーザー (閲覧者、作成者、または管理者) に使用できます。以下のいずれかとして認証する必要があります。1. Active Directory (AD) ユーザーまたはグループメンバー2. 招待された非フェデレーティッドユーザー3. SAML、OpenID Connect、または IAM フェデレーションを使用したフェデレーションのシングル

サインオンを通じて認証された AWS Identity and Access Management (IAM) ユーザーおよび IAMロールベースセッション

3 番目のグループのユーザー、IAM ユーザーおよび IAM ロールベースのセッションでは、このパラメータは省略します。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "EmbedUrl": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 213)

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

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

埋め込みURL (p. 213)

QuickSight セッションを埋め込むために、サーバー側の Web ページに配置できる使い捨ての URL。この URL は 5 分間有効です。API オペレーションは、URL にauth_code値を 1 つだけ有効にし、10時間有効なユーザーセッションへのサインオンを有効にします。

タイプ: 文字列RequestId (p. 213)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

213

GetSessionEmbedUrl

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400QuickSightUserNotFoundException

指定された名前のユーザーが見つかりません。このエラーは、提供されたユーザー名に基づいてユーザーを見つける必要があるオペレーションで発生する可能性があります。DeleteUser,DescribeUserなどといった設定です。

HTTP ステータスコード: 404ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404SessionLifetimeInMinutesInvalidException

セッションの存続期間に指定された分数が無効です。セッションの有効期間は 15 〜 600 分です。

HTTP ステータスコード: 400ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

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

HTTP ステータスコード: 403

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

214

ListAnalyses

ListAnalyses指定された AWS アカウントに存在する Amazon QuickSight 分析を一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/analyses?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 216)

分析を含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 216)

返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 216)

後続のリクエストで使用できるページ分割トークン。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AnalysisSummaryList": [ { "AnalysisId": "string", "Arn": "string", "CreatedTime": number, "LastUpdatedTime": number, "Name": "string", "Status": "string" } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

216

ListAnalyses

ステータス (p. 216)

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

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

分析サマリーリスト (p. 216)

リストされている各分析を記述するメタデータ。

タイプ: 配列インデックス作成AnalysisSummary (p. 395)objects

Array Membace 最大数は 100 項目です。NextToken (p. 216)

後続のリクエストで使用できるページ分割トークン。

タイプ: 文字列RequestId (p. 216)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

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

HTTP ステータスコード: 403

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

217

ListDashboards

ListDashboardsAWS アカウントのダッシュボードを一覧表示します。

リクエストの構文

GET /accounts/AwsAccountId/dashboards?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 219)

出品するダッシュボードを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 219)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 219)

次の結果セットのトークン、または追加の結果がない場合は null です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "DashboardSummaryList": [ { "Arn": "string", "CreatedTime": number, "DashboardId": "string", "LastPublishedTime": number, "LastUpdatedTime": number, "Name": "string", "PublishedVersionNumber": number } ], "NextToken": "string", "RequestId": "string"}

219

ListDashboards

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 219)

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

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

ダッシュボードサマリーリスト (p. 219)

AWS アカウントのすべてのダッシュボードを含む構造。この構造体は、ダッシュボードに関する基本情報を提供します。

タイプ: 配列インデックス作成DashboardSummary (p. 421)objects

Array Membace 最大数は 100 項目です。NextToken (p. 219)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 219)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

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

HTTP ステータスコード: 403

220

ListDashboardVersions

ListDashboardVersionsQuickSight サブスクリプションのすべてのバージョンのダッシュボードを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/dashboards/DashboardId/versions?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 222)

バージョンを一覧表示するダッシュボードを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいDashboardId (p. 222)

ダッシュボードの ID。

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

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

: 必須 はいMaxResults (p. 222)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 222)

次の結果セットのトークン、または追加の結果がない場合は null です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "DashboardVersionSummaryList": [ { "Arn": "string", "CreatedTime": number, "Description": "string", "SourceEntityArn": "string",

222

ListDashboardVersions

"Status": "string", "VersionNumber": number } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 222)

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

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

ダッシュボードバージョン概要リスト (p. 222)

ダッシュボードの各バージョンの情報を含む構造体。

タイプ: 配列インデックス作成DashboardVersionSummary (p. 425)objects

Array Membace 最大数は 100 項目です。NextToken (p. 222)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 222)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

223

ListDashboardVersions

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

224

ListDataSets

ListDataSetsAWS リージョン内の現在の AWS アカウントに属するデータセットをすべて一覧表示します。

権限リソースはarn:aws:quicksight:region:aws-account-id:dataset/*。

リクエストの構文GET /accounts/AwsAccountId/data-sets?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 225)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 225)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 225)

次の結果セットのトークン、または追加の結果がない場合は null です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "DataSetSummaries": [ { "Arn": "string", "ColumnLevelPermissionRulesApplied": boolean, "CreatedTime": number, "DataSetId": "string", "ImportMode": "string", "LastUpdatedTime": number, "Name": "string", "RowLevelPermissionDataSet": { "Arn": "string", "FormatVersion": "string", "Namespace": "string", "PermissionPolicy": "string" }

225

ListDataSets

} ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 225)

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

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

DatasetSummaries (p. 225)

データセット要約のリスト。

タイプ: 配列インデックス作成DataSetSummary (p. 434)objectsNextToken (p. 225)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 225)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

226

ListDataSets

HTTP ステータスコード: 400ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExample

この例では、ListDatasets の 1 つの使用方法を示します。

リクエスト例

GET /accounts/{AwsAccountId}/data-sets?next-token={NextToken};max-results={MaxResults} HTTP/1.1Content-type: application/json

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

227

ListDataSources

ListDataSourcesこの AWS アカウントに属する現在の AWS リージョンのデータソースを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/data-sources?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 228)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 228)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 228)

次の結果セットのトークン、または追加の結果がない場合は null です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "DataSources": [ { "AlternateDataSourceParameters": [ { "AmazonElasticsearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": {

228

ListDataSources

"Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "string" }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": { "Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string",

229

ListDataSources

"Port": number }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } } ], "Arn": "string", "CreatedTime": number, "DataSourceId": "string", "DataSourceParameters": { "AmazonElasticsearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "string" }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": { "Database": "string",

230

ListDataSources

"InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } }, "ErrorInfo": { "Message": "string", "Type": "string" }, "LastUpdatedTime": number, "Name": "string", "SslProperties": { "DisableSsl": boolean }, "Status": "string", "Type": "string", "VpcConnectionProperties": { "VpcConnectionArn": "string" } } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

231

ListDataSources

ステータス (p. 228)

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

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

DataSources (p. 228)

データソースのリスト。

タイプ: 配列インデックス作成DataSource (p. 436)objectsNextToken (p. 228)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 228)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ThrottlingException

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

HTTP ステータスコード: 429

232

ListDataSources

ExamplesExample

この例では、ListDataSources の 1 つの使用方法を示します。

リクエスト例

GET /accounts/{AwsAccountId}/data-sources?next-token={NextToken};max-results={MaxResults} HTTP/1.1Content-type: application/json

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

233

ListGroupMemberships

ListGroupMembershipsグループのメンバーユーザーを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/namespaces/Namespace/groups/GroupName/members?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 234)

グループが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はいGroupName (p. 234)

メンバーシップリストを表示するグループの名前。

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

パターン: [\u0020-\u00FF]+

: 必須 はいMaxResults (p. 234)

このリクエストから返す結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。名前空間 (p. 234)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はいNextToken (p. 234)

後続のリクエストで使用できるページ分割トークン。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 Status

234

ListGroupMemberships

Content-type: application/json

{ "GroupMemberList": [ { "Arn": "string", "MemberName": "string" } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 234)

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

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

グループ・メンバー・リスト (p. 234)

グループのメンバーのリスト。

タイプ: 配列インデックス作成GroupMember (p. 452)objectsNextToken (p. 234)

後続のリクエストで使用できるページ分割トークン。

タイプ: 文字列RequestId (p. 234)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

235

ListGroupMemberships

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

236

ListGroups

ListGroupsAmazon QuickSight ですべてのユーザーグループを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/namespaces/Namespace/groups?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 237)

グループが属する AWS アカウントの ID。現在、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 237)

返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。名前空間 (p. 237)

名前空間。現在、これをに設定する必要があります。default。

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

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

: 必須 はいNextToken (p. 237)

後続のリクエストで使用できるページ分割トークン。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "GroupList": [ { "Arn": "string", "Description": "string", "GroupName": "string",

237

ListGroups

"PrincipalId": "string" } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 237)

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

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

グループリスト (p. 237)

グループのリスト。

タイプ: 配列インデックス作成Group (p. 451)objectsNextToken (p. 237)

後続のリクエストで使用できるページ分割トークン。

タイプ: 文字列RequestId (p. 237)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

238

ListGroups

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

239

ListIAMPolicyAssignments

ListIAMPolicyAssignments現在の Amazon QuickSight アカウントの IAM ポリシー割り当てを一覧表示します。

リクエストの構文

GET /accounts/AwsAccountId/namespaces/Namespace/iam-policy-assignments?max-results=MaxResults&next-token=NextToken HTTP/1.1Content-type: application/json

{ "AssignmentStatus": "string"}

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

AwsAccountId (p. 240)

これらの IAM ポリシー割り当てを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 240)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。名前空間 (p. 240)

割り当ての名前空間です。

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

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

: 必須 はいNextToken (p. 240)

次の結果セットのトークン、または追加の結果がない場合は null です。

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

AssignmentStatus (p. 240)

割り当てのステータス。

タイプ: 文字列

有効な値: ENABLED | DRAFT | DISABLED

240

ListIAMPolicyAssignments

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "IAMPolicyAssignments": [ { "AssignmentName": "string", "AssignmentStatus": "string" } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 241)

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

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

IAMPolicy割り当て (p. 241)

IAM ポリシーの割り当てを説明する情報。

タイプ: 配列インデックス作成IAMPolicyAssignmentSummary (p. 456)objectsNextToken (p. 241)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 241)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401

241

ListIAMPolicyAssignments

InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

242

ListIAMPolicyAssignmentsForUser

ListIAMPolicyAssignmentsForUser指定したユーザー、およびユーザーが属する 1 つまたは複数のグループに割り当てられた IAM ポリシーのAmazon リソースネーム(ARN)を含む、すべての IAM ポリシー割り当てを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/namespaces/Namespace/users/UserName/iam-policy-assignments?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 243)

割り当てを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 243)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。名前空間 (p. 243)

割り当ての名前空間。

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

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

: 必須 はいNextToken (p. 243)

次の結果セットのトークン、または追加の結果がない場合は null です。UserName (p. 243)

ユーザーの名前。

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

パターン: [\u0020-\u00FF]+

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 Status

243

ListIAMPolicyAssignmentsForUser

Content-type: application/json

{ "ActiveAssignments": [ { "AssignmentName": "string", "PolicyArn": "string" } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 243)

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

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

アクティブ・イーサインメント (p. 243)

このユーザーのアクティブな割り当て。

タイプ: 配列インデックス作成ActiveIAMPolicyAssignment (p. 386)objectsNextToken (p. 243)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 243)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401同時処理例外

リソースは、新しい更新を適用する前に完了する必要がある操作が実行中であることを示す状態ですでにあります。

HTTP ステータスコード: 500

244

ListIAMPolicyAssignmentsForUser

InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

245

ListIngestions

ListIngestionsデータセットの SPICE 取り込みの履歴を一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/data-sets/DataSetId/ingestions?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 246)

AWS アカウント ID。

長さの制約: 固定長 12。

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

: 必須 はいデータセット ID (p. 246)

取り込みで使用されるデータセットの ID。

: 必須 はいMaxResults (p. 246)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 246)

次の結果セットのトークン、または追加の結果がない場合は null です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Ingestions": [ { "Arn": "string", "CreatedTime": number, "ErrorInfo": { "Message": "string", "Type": "string" }, "IngestionId": "string", "IngestionSizeInBytes": number, "IngestionStatus": "string",

246

ListIngestions

"IngestionTimeInSeconds": number, "QueueInfo": { "QueuedIngestion": "string", "WaitingOnIngestion": "string" }, "RequestSource": "string", "RequestType": "string", "RowInfo": { "RowsDropped": number, "RowsIngested": number } } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 246)

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

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

取り込み (p. 246)

取り込みのリスト。

タイプ: 配列インデックス作成Ingestion (p. 457)objectsNextToken (p. 246)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 246)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

247

ListIngestions

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

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

HTTP ステータスコード: 409ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

ExamplesExample

この例では、ListingSitions の 1 つの使用方法を示します。

リクエスト例

GET /accounts/*AwsAccountId*/data-sets/*DataSetID*/ingestions?next-token=*NextToken*;max-results=*MaxResults*" HTTP/1.1

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

248

ListNamespaces

ListNamespaces指定した AWS アカウントの名前スペースを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/namespaces?max-results=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 249)

一覧表示する QuickSight 名前空間を含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 249)

返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 249)

後続のリクエストで使用できるページ分割トークン。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Namespaces": [ { "Arn": "string", "CapacityRegion": "string", "CreationStatus": "string", "IdentityStore": "string", "Name": "string", "NamespaceError": { "Message": "string", "Type": "string" } } ], "NextToken": "string", "RequestId": "string"}

249

ListNamespaces

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 249)

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

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

名前空間 (p. 249)

この AWS アカウントの名前空間に関する情報。応答には、名前空間 ARN、名前、AWS リージョン、通知メールアドレス、作成ステータス、ID ストアが含まれます。

タイプ: 配列インデックス作成NamespaceInfoV2 (p. 472)objectsNextToken (p. 249)

後続のリクエストで使用できるページ分割トークン。

タイプ: 文字列RequestId (p. 249)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

250

ListNamespaces

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ResourceUnavailableException

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

HTTP ステータスコード: 503ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

251

ListTagsForResource

ListTagsForResourceリソースに割り当てられたタグをリスト表示します。

リクエストの構文GET /resources/ResourceArn/tags HTTP/1.1

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

ResourceArn (p. 252)

タグのリストを作成するリソースの Amazon リソースネーム (ARN)。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 252)

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

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

RequestId (p. 252)

オペレーションの AWS リクエスト ID

タイプ: 文字列タグ (p. 252)

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

252

ListTagsForResource

タイプ: 配列インデックス作成Tag (p. 503)objects

Array Membace 最小項目数は 1 項目です。最大数は 200 項目です。

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

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

HTTP ステータスコード: 401InternalFailureException

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

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

253

ListTemplateAliases

ListTemplateAliasesテンプレートのすべてのエイリアスを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/templates/TemplateId/aliases?max-result=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 254)

出品するテンプレートエイリアスを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 254)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 254)

次の結果セットのトークン、または追加の結果がない場合は null です。TemplateId (p. 254)

テンプレートの ID。

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

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

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "NextToken": "string", "RequestId": "string", "TemplateAliasList": [ { "AliasName": "string", "Arn": "string",

254

ListTemplateAliases

"TemplateVersionNumber": number } ]}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 254)

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

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

NextToken (p. 254)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 254)

オペレーションの AWS リクエスト ID

タイプ: 文字列テンプレートエイリアスリスト (p. 254)

テンプレートのエイリアスのリストを含む構造体。

タイプ: 配列インデックス作成TemplateAlias (p. 507)objects

Array Membace 最大数は 100 項目です。

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

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

HTTP ステータスコード: 429

255

ListTemplateAliases

UnsupportedUserEditionException

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

HTTP ステータスコード: 403

ExamplesExample

この例では、ListTemplateAliases の使用方法を示します。

リクエスト例

GET /accounts/AwsAccountId/templates/TemplateId/aliases?max-result=MaxResults&next-token=NextToken HTTP/1.1

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

256

ListTemplates

ListTemplates現在の Amazon QuickSight アカウントのすべてのテンプレートを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/templates?max-result=MaxResults&next-token=NextToken HTTP/1.1

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

AwsAccountId (p. 257)

出品するテンプレートを含む AWS アカウントの ID。

長さの制約: 固定長 12。

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

: 必須 はいMaxResults (p. 257)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 257)

次の結果セットのトークン、または追加の結果がない場合は null です。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "NextToken": "string", "RequestId": "string", "TemplateSummaryList": [ { "Arn": "string", "CreatedTime": number, "LastUpdatedTime": number, "LatestVersionNumber": number, "Name": "string", "TemplateId": "string" } ]}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

257

ListTemplates

ステータス (p. 257)

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

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

NextToken (p. 257)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 257)

オペレーションの AWS リクエスト ID

タイプ: 文字列テンプレート概要リスト (p. 257)

リスト内のテンプレートに関する情報を含む構造体。

タイプ: 配列インデックス作成TemplateSummary (p. 512)objects

Array Membace 最大数は 100 項目です。

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

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

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

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

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard

258

ListTemplates

Edition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

259

ListTemplateVersions

ListTemplateVersions現在の Amazon QuickSight アカウントのすべてのバージョンを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/templates/TemplateId/versions?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 260)

出品するテンプレートを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいMaxResults (p. 260)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 260)

次の結果セットのトークン、または追加の結果がない場合は null です。TemplateId (p. 260)

テンプレートの ID。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "NextToken": "string", "RequestId": "string", "TemplateVersionSummaryList": [ { "Arn": "string", "CreatedTime": number,

260

ListTemplateVersions

"Description": "string", "Status": "string", "VersionNumber": number } ]}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 260)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

NextToken (p. 260)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 260)

オペレーションの AWS リクエスト ID

タイプ: 文字列テンプレートバージョン概要リスト (p. 260)

指定されたテンプレートのすべてのバージョンのリストを含む構造体。

タイプ: 配列インデックス作成TemplateVersionSummary (p. 516)objects

Array Membace 最大数は 100 項目です。

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

261

ListTemplateVersions

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

262

ListThemeAliases

ListThemeAliasesテーマのすべてのエイリアスを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/themes/ThemeId/aliases?max-result=MaxResults&next-token=NextToken HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 263)

出品するテーマのエイリアスを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいMaxResults (p. 263)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 263)

次の結果セットのトークン、または追加の結果がない場合は null です。ThemeId (p. 263)

テーマの ID です。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "NextToken": "string", "RequestId": "string", "ThemeAliasList": [ { "AliasName": "string", "Arn": "string",

263

ListThemeAliases

"ThemeVersionNumber": number } ]}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 263)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

NextToken (p. 263)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 263)

オペレーションの AWS リクエスト ID

タイプ: 文字列テーマ別リスト (p. 263)

テーマのエイリアスのリストを含む構造体。

タイプ: 配列インデックス作成ThemeAlias (p. 521)objects

Array Membace 最大数は 100 項目です。

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400

264

ListThemeAliases

ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。

HTTP ステータスコード: 403

ExamplesExample

この例では、ListThemeAliases の使用方法を示します。

リクエスト例

GET /accounts/AwsAccountId/themes/ThemeId/aliases?max-result=MaxResults&next-token=NextToken& HTTP/1.1

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

265

ListThemes

ListThemes現在の AWS アカウントのすべてのテーマを一覧表示します。

リクエストの構文

GET /accounts/AwsAccountId/themes?max-results=MaxResults&next-token=NextToken&type=Type HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 266)

出品するテーマを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいMaxResults (p. 266)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 266)

次の結果セットのトークン、または追加の結果がない場合は null です。タイプ (p. 266)

一覧表示するテーマの種類を指定します。有効なオプションは以下のとおりです。• ALL (default)-すべての既存のテーマを表示します。• CUSTOM-Amazon QuickSight を使用しているユーザーが作成したテーマのみを表示します。• QUICKSIGHT-QuickSight によって定義された開始テーマのみを表示します。

有効な値: QUICKSIGHT | CUSTOM | ALL

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "NextToken": "string", "RequestId": "string", "ThemeSummaryList": [ { "Arn": "string",

266

ListThemes

"CreatedTime": number, "LastUpdatedTime": number, "LatestVersionNumber": number, "Name": "string", "ThemeId": "string" } ]}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 266)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

NextToken (p. 266)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 266)

オペレーションの AWS リクエスト ID

タイプ: 文字列テーマ一覧 (p. 266)

リスト内のテーマに関する情報。

タイプ: 配列インデックス作成ThemeSummary (p. 524)objects

Array Membace 最大数は 100 項目です。

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

267

ListThemes

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

268

ListThemeVersions

ListThemeVersions現在の AWS アカウントのテーマのすべてのバージョンを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/themes/ThemeId/versions?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 269)

出品するテーマを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいMaxResults (p. 269)

リクエストごとに返される結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。NextToken (p. 269)

次の結果セットのトークン、または追加の結果がない場合は null です。ThemeId (p. 269)

テーマの ID です。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "NextToken": "string", "RequestId": "string", "ThemeVersionSummaryList": [ { "Arn": "string", "CreatedTime": number,

269

ListThemeVersions

"Description": "string", "Status": "string", "VersionNumber": number } ]}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 269)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

NextToken (p. 269)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 269)

オペレーションの AWS リクエスト ID

タイプ: 文字列テーマ概要リスト (p. 269)

指定されたテーマのすべてのバージョンのリストを含む構造体。

タイプ: 配列インデックス作成ThemeVersionSummary (p. 528)objects

Array Membace 最大数は 100 項目です。

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400

270

ListThemeVersions

InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

271

ListUserGroups

ListUserGroupsAmazon QuickSight ユーザーがメンバーである Amazon QuickSight グループを一覧表示します。

リクエストの構文GET /accounts/AwsAccountId/namespaces/Namespace/users/UserName/groups?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 272)

ユーザーがいる AWS アカウント ID。現時点では、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいMaxResults (p. 272)

このリクエストから返す結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。名前空間 (p. 272)

名前空間。現在、これをに設定する必要があります。default。

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 はいNextToken (p. 272)

後続のリクエストで使用できるページ分割トークン。UserName (p. 272)

グループメンバーシップを一覧表示する Amazon QuickSight ユーザー名。

長さの制約: 最小長は 1 です。

パターン: [\u0020-\u00FF]+

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 Status

272

ListUserGroups

Content-type: application/json

{ "GroupList": [ { "Arn": "string", "Description": "string", "GroupName": "string", "PrincipalId": "string" } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 272)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

グループリスト (p. 272)

ユーザーがメンバーになっているグループのリスト。

タイプ: 配列インデックス作成Group (p. 451)objectsNextToken (p. 272)

後続のリクエストで使用できるページ分割トークン。

タイプ: 文字列RequestId (p. 272)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500

273

ListUserGroups

InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ResourceUnavailableException

このリソースは現在使用できません。

HTTP ステータスコード: 503ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

274

ListUsers

ListUsersこのアカウントに属するすべての Amazon QuickSight ユーザーのリストを返します。

リクエストの構文

GET /accounts/AwsAccountId/namespaces/Namespace/users?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 275)

ユーザーがいる AWS アカウントの ID。現時点では、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいMaxResults (p. 275)

このリクエストから返す結果の最大数。

有効範囲: 最小値は 1 です。最大値は 100 です。名前空間 (p. 275)

名前空間。現在、これをに設定する必要があります。default。

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 はいNextToken (p. 275)

後続のリクエストで使用できるページ分割トークン。

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "NextToken": "string", "RequestId": "string", "UserList": [ {

275

ListUsers

"Active": boolean, "Arn": "string", "CustomPermissionsName": "string", "Email": "string", "ExternalLoginFederationProviderType": "string", "ExternalLoginFederationProviderUrl": "string", "ExternalLoginId": "string", "IdentityType": "string", "PrincipalId": "string", "Role": "string", "UserName": "string" } ]}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 275)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

NextToken (p. 275)

後続のリクエストで使用できるページ分割トークン。

タイプ: 文字列RequestId (p. 275)

オペレーションの AWS リクエスト ID

タイプ: 文字列ユーザーリスト (p. 275)

ユーザーのリストです。

タイプ: 配列インデックス作成User (p. 540)objects

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500

276

ListUsers

InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ResourceUnavailableException

このリソースは現在使用できません。

HTTP ステータスコード: 503ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

277

RegisterUser

RegisterUserAmazon QuickSight ユーザーを作成します。そのユーザーの ID は、リクエストで指定された AWSIdentity and Access Management (IAM) のアイデンティティまたはロールに関連付けられます。

リクエストの構文POST /accounts/AwsAccountId/namespaces/Namespace/users HTTP/1.1Content-type: application/json

{ "CustomFederationProviderUrl": "string", "CustomPermissionsName": "string", "Email": "string", "ExternalLoginFederationProviderType": "string", "ExternalLoginId": "string", "IamArn": "string", "IdentityType": "string", "SessionName": "string", "UserName": "string", "UserRole": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 278)

ユーザーがいる AWS アカウントの ID。現時点では、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい名前空間 (p. 278)

名前空間。現在、これをに設定する必要があります。default。

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

メール (p. 278)

登録するユーザーの E メールアドレス。

タイプ: 文字列

: 必須 はい

278

RegisterUser

IdentityType (p. 278)

Amazon QuickSight は、ユーザーの ID を管理するためのいくつかの方法をサポートしています。このパラメータには、次の 2 つの値を指定できます。• IAM: ID が既存の IAM ユーザーまたはロールにマップされるユーザー。• QUICKSIGHT: ID が Amazon QuickSight によって内部的に所有および管理されているユーザー。

タイプ: 文字列

有効な値: IAM | QUICKSIGHT

: 必須 はいUserRole (p. 278)

ユーザーの Amazon QuickSight ロール。ユーザーロールは次のいずれかを指定できます。• READERダッシュボードに対する読み取り専用アクセス権を持つユーザー。• AUTHOR: データソース、データセット、分析、およびダッシュボードを作成できるユーザー。• ADMIN: Amazon QuickSight の設定を管理できる著者であるユーザー。• RESTRICTED_READER: このロールは現在使用できません。• RESTRICTED_AUTHOR: このロールは現在使用できません。

タイプ: 文字列

有効な値: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

: 必須 はいカスタムフェデレーションプロバイダー URL (p. 278)

関連付けられた AWS ID およびアクセス管理(IAM)ロールを使用して QuickSight にフェデレーションできるように ID を提供するカスタム OpenID Connect (OIDC) プロバイダーの URL。このパラメーターは、ExternalLoginFederationProviderTypeパラメータの設定CUSTOM_OIDC。

タイプ: 文字列

: 必須 いいえカスタム権限名 (p. 278)

(Enterprise エディションのみ)このユーザーに割り当てるカスタム権限プロファイルの名前。カスタマイズされたアクセス許可を使用すると、次の操作でアクセスを制限することで、ユーザーのアクセスを制御できます。• データソースの作成と更新• データセットの作成と更新• E メールレポートの作成と更新• メールレポートのサブスクライブ

既存のユーザーにカスタム権限を追加するには、 UpdateUser (p. 375) 代わりに、とします。

カスタムアクセス許可のセットには、これらの制限の任意の組み合わせが含まれます。現時点では、QuickSight コンソールを使用して、カスタム権限セットのプロファイル名を作成する必要があります。次に、を使用します。RegisterUserAPI 操作を使用して、名前付きアクセス許可セットをQuickSight ユーザーに割り当てることができます。

QuickSight カスタムアクセス許可は、IAM ポリシーを通じて適用されます。したがって、QuickSightユーザーを QuickSight のデフォルトのセキュリティコホート (管理者、作成者、リーダー) のいずれかに割り当てることによって通常付与される権限を上書きします。

279

RegisterUser

この機能は、シングルサインオン (SSO) 用の SAML 2.0 ベースのフェデレーションを使用するQuickSight Enterprise エディションサブスクリプションでのみ使用できます。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

パターン: ^[a-zA-Z0-9+=,.@_-]+$

: 必須 いいえ外部ログインフェデレーションプロバイダータイプ (p. 278)

サポートされている外部ログインプロバイダーのタイプ。ID を提供し、関連付けられた AWS Identityand Access Management(IAM)ロールを使用して Amazon QuickSight にフェデレートできるようにします。サポートされる外部ログインプロバイダーのタイプは、次のいずれかになります。• COGNITOAmazon Cognito の例 プロバイダの URL は cognito-identity.amazonaws.com です。選択

するときCOGNITOプロバイダのタイプを使用する場合は、外部プロバイダーがカスタムの場合にのみ必要な「CustomFederationProviderURL」パラメータを使用しないでください。

• CUSTOM_OIDC: OpenID Connect (OIDC) プロバイダー。選択するときCUSTOM_OIDCタイプを使用する場合は、CustomFederationProviderUrlパラメーターを使用して、カスタム OIDC プロバイダー URL を指定します。

タイプ: 文字列

: 必須 いいえ外部LoginID (p. 278)

外部ログインプロバイダー内のユーザーのアイデンティティ ID。

タイプ: 文字列

: 必須 いいえIAMARN (p. 278)

Amazon QuickSight に登録する IAM ユーザーまたはロールの ARN。

タイプ: 文字列

: 必須 いいえセッション名 (p. 278)

このパラメータを使用する必要があるのは、引き受けた IAM ロールを使用して 1 人以上のユーザーを登録する場合のみです。IAM ユーザーや Amazon QuickSight ユーザーを登録する場合など、他のシナリオではセッション名を指定する必要はありません。各ユーザーのセッション名が異なる場合は、同じ IAM ロールを使用して複数のユーザーを登録できます。IAM ロールを引き受ける方法の詳細については、「」を参照してください。 assume-role ()AWS CLI リファレンス

タイプ: 文字列

長さの制約: 最小長は 2 です。 最大長は 64 です。

パターン: [\w+=.@-]*

: 必須 いいえUserName (p. 278)

登録するユーザーに対して作成する Amazon QuickSight ユーザー名。

タイプ: 文字列

長さの制約: 最小長は 1 です。

280

RegisterUser

パターン: [\u0020-\u00FF]+

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "User": { "Active": boolean, "Arn": "string", "CustomPermissionsName": "string", "Email": "string", "ExternalLoginFederationProviderType": "string", "ExternalLoginFederationProviderUrl": "string", "ExternalLoginId": "string", "IdentityType": "string", "PrincipalId": "string", "Role": "string", "UserName": "string" }, "UserInvitationUrl": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 281)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId (p. 281)

オペレーションの AWS リクエスト ID

タイプ: 文字列ユーザー (p. 281)

ユーザーのユーザー名。

タイプ: User (p. 540) オブジェクトユーザー招待URL (p. 281)

ユーザーが登録を完了し、パスワードを入力するためにアクセスする URL。これは、ID タイプがQUICKSIGHT。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

281

RegisterUser

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceExistsException

指定されたリソースは、既に存在しています。

HTTP ステータスコード: 409ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ResourceUnavailableException

このリソースは現在使用できません。

HTTP ステータスコード: 503ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++

282

RestoreAnalysis

RestoreAnalysis分析を復元します。

リクエストの構文POST /accounts/AwsAccountId/restore/analyses/AnalysisId HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AnalysisId (p. 284)

復元する分析の ID。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はいAwsAccountId (p. 284)

分析を含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AnalysisId": "string", "Arn": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 284)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

284

RestoreAnalysis

AnalysisId (p. 284)

復元する分析の ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+Arn (p. 284)

復元する分析の Amazon リソースネーム (ARN)。

タイプ: 文字列RequestId (p. 284)

オペレーションの AWS リクエスト ID

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。

HTTP ステータスコード: 403

285

SearchAnalyses

SearchAnalysesフィルタで指定したユーザに属する解析を検索します。

リクエストの構文POST /accounts/AwsAccountId/search/analyses HTTP/1.1Content-type: application/json

{ "Filters": [ { "Name": "string", "Operator": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 287)

検索する分析を含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

フィルター (p. 287)

検索に適用する検索フィルターの構造。

タイプ: 配列インデックス作成AnalysisSearchFilter (p. 392)objects

Array Membace 固定項目数は 1 です。

: 必須 はいMaxResults (p. 287)

返される結果の最大数。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 100 です。

: 必須 いいえNextToken (p. 287)

後続のリクエストで使用できるページ分割トークン。

287

SearchAnalyses

タイプ: 文字列

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "AnalysisSummaryList": [ { "AnalysisId": "string", "Arn": "string", "CreatedTime": number, "LastUpdatedTime": number, "Name": "string", "Status": "string" } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 288)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

分析サマリーリスト (p. 288)

検索した分析を記述するメタデータ。

タイプ: 配列インデックス作成AnalysisSummary (p. 395)objects

Array Membace 最大数は 100 項目です。NextToken (p. 288)

後続のリクエストで使用できるページ分割トークン。

タイプ: 文字列RequestId (p. 288)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

288

SearchAnalyses

InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

289

SearchDashboards

SearchDashboardsユーザーに属するダッシュボードを検索します。

リクエストの構文

POST /accounts/AwsAccountId/search/dashboards HTTP/1.1Content-type: application/json

{ "Filters": [ { "Name": "string", "Operator": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 290)

検索するダッシュボードを持つユーザーを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

フィルター (p. 290)

検索に適用するフィルタ。現在、ユーザー名でのみ検索することができます。たとえば、"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals","Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

タイプ: 配列インデックス作成DashboardSearchFilter (p. 418)objects

Array Membace 固定項目数は 1 です。

: 必須 はいMaxResults (p. 290)

リクエストごとに返される結果の最大数。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 100 です。

290

SearchDashboards

: 必須 いいえNextToken (p. 290)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "DashboardSummaryList": [ { "Arn": "string", "CreatedTime": number, "DashboardId": "string", "LastPublishedTime": number, "LastUpdatedTime": number, "Name": "string", "PublishedVersionNumber": number } ], "NextToken": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 291)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

ダッシュボードサマリーリスト (p. 291)

で指定したユーザーが所有するダッシュボードのリストFiltersリクエストを更新します。

タイプ: 配列インデックス作成DashboardSummary (p. 421)objects

Array Membace 最大数は 100 項目です。NextToken (p. 291)

次の結果セットのトークン、または追加の結果がない場合は null です。

タイプ: 文字列RequestId (p. 291)

この操作の AWS リクエスト ID。

タイプ: 文字列

291

SearchDashboards

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidNextTokenException

NextToken の値は無効です。

HTTP ステータスコード: 400InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

292

TagResource

TagResource指定された QuickSight リソースに 1 つ以上のタグ (キーと値のペア) を割り当てます。

タグを使用すると、リソースの整理や分類に役立ちます。また、特定のタグ値を含むリソースのみにアクセスする、またはリソースを変更する許可をユーザーに付与することで、タグを使用してユーザーアクセス許可を制限することもできます。「」TagResourceオペレーションを、すでにタグを持つリソースに置き換えます。リソースに新しいタグキーを指定すると、このタグはリソースに関連付けられたタグのリストに追加されます。リソースにすでに関連付けられているタグキーを指定した場合、指定した新しいタグ値によって、そのタグの以前の値が置き換えられます。

1 つのリソースには、最大 50 個のタグを関連付けることができます。QuickSight は、データセット、データソース、ダッシュボード、およびテンプレートのタグ付けをサポートしています。

QuickSight のタグ付けは、他の AWS サービスのタグ付けと同様に機能します。ただし、次の点が異なります。

• タグを使用して QuickSight の AWS コストを追跡することはできません。この制限は、QuickSight のコストが、タグ付け可能なリソースではない、ユーザーと SPICE の容量に基づいているためです。

• QuickSight は現在、AWS Resource Groups タグエディタをサポートしていません。

リクエストの構文POST /resources/ResourceArn/tags HTTP/1.1Content-type: application/json

{ "Tags": [ { "Key": "string", "Value": "string" } ]}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

ResourceArn (p. 293)

タグを付けるリソースの Amazon リソースネーム (ARN)。

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

タグ (p. 293)

リソースに割り当てられたリソースタグのキーと値のペアのマップが含まれます。

タイプ: 配列インデックス作成Tag (p. 503)objects

Array Membace 最小項目数は 1 項目です。最大数は 200 項目です。

293

TagResource

: 必須 はい

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 294)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId (p. 294)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409

294

TagResource

ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

295

UntagResource

UntagResourceリソースからタグを削除します。

リクエストの構文DELETE /resources/ResourceArn/tags?keys=TagKeys HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

ResourceArn (p. 296)

タグを解除するリソースの Amazon リソースネーム (ARN)。

: 必須 はいTagKeys (p. 296)

リソースに割り当てられたリソースタグのキーと値のペアのキー。

Array Membace 最小項目数は 1 項目です。最大数は 200 項目です。

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 296)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId (p. 296)

この操作の AWS リクエスト ID。

タイプ: 文字列

296

UntagResource

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

297

UpdateAccountCustomization

UpdateAccountCustomization現在の AWS リージョンのカスタマイズを Amazon QuickSight を更新します。現在、使用できるカスタマイズはテーマのみです。

AWS アカウント用にカスタマイズを使用することも、名前空間を指定した場合は、代わりに QuickSight名前空間用にカスタマイズすることもできます。名前空間に適用されるカスタマイズは、AWS アカウントに適用されるカスタマイズよりも優先されます。どのカスタマイズが適用されるかを調べるには、DescribeAccountCustomizationAPI オペレーション。

リクエストの構文PUT /accounts/AwsAccountId/customizations?namespace=Namespace HTTP/1.1Content-type: application/json

{ "AccountCustomization": { "DefaultTheme": "string" }}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 298)

QuickSight カスタマイズを更新する AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい名前空間 (p. 298)

QuickSight カスタマイズを更新する名前空間。

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

アカウントのカスタマイズ (p. 298)

現在の AWS リージョンの更新する QuickSight のカスタマイズ。

タイプ: AccountCustomization (p. 383) オブジェクト

: 必須 はい

レスポンスの構文HTTP/1.1 Status

298

UpdateAccountCustomization

Content-type: application/json

{ "AccountCustomization": { "DefaultTheme": "string" }, "Arn": "string", "AwsAccountId": "string", "Namespace": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 298)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

アカウントのカスタマイズ (p. 298)

現在の AWS リージョンの更新する QuickSight のカスタマイズ。

タイプ: AccountCustomization (p. 383) オブジェクトArn (p. 298)

この AWS アカウントの更新されたカスタマイズの Amazon リソースネーム (ARN)。

タイプ: 文字列AwsAccountId (p. 298)

QuickSight カスタマイズを更新する AWS アカウントの ID。

タイプ: 文字列

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$名前空間 (p. 298)

更新するカスタマイズに関連付けられている名前空間。

タイプ: 文字列

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$RequestId (p. 298)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

299

UpdateAccountCustomization

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ResourceUnavailableException

このリソースは現在使用できません。

HTTP ステータスコード: 503ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

300

UpdateAccountSettings

UpdateAccountSettingsAWS アカウントの Amazon QuickSight 設定を更新します。

リクエストの構文PUT /accounts/AwsAccountId/settings HTTP/1.1Content-type: application/json

{ "DefaultNamespace": "string", "NotificationEmail": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 301)

一覧表示する QuickSight 設定を含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

既定の名前空間 (p. 301)

この AWS アカウントのデフォルトの名前空間。現在、デフォルトはdefault。QuickSight に初めて登録された AWS Identity and Access Management (IAM) ユーザーは、デフォルトの名前空間に関連付けられるメールを送信します。

タイプ: 文字列

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 はい通知 E メール (p. 301)

AWS アカウントまたは QuickSight サブスクリプションに関する通知を QuickSight に送信するメールアドレス。

タイプ: 文字列

: 必須 いいえ

レスポンスの構文HTTP/1.1 Status

301

UpdateAccountSettings

Content-type: application/json

{ "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 301)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId (p. 301)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ResourceUnavailableException

このリソースは現在使用できません。

HTTP ステータスコード: 503ThrottlingException

アクセスが調整済みです。

302

UpdateAnalysis

UpdateAnalysisAmazon QuickSight で分析を更新します。

リクエストの構文PUT /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1Content-type: application/json

{ "Name": "string", "Parameters": { "DateTimeParameters": [ { "Name": "string", "Values": [ number ] } ], "DecimalParameters": [ { "Name": "string", "Values": [ number ] } ], "IntegerParameters": [ { "Name": "string", "Values": [ number ] } ], "StringParameters": [ { "Name": "string", "Values": [ "string" ] } ] }, "SourceEntity": { "SourceTemplate": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "ThemeArn": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AnalysisId (p. 304)

更新する分析の ID。この ID は、分析の URL に表示されます。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

304

UpdateAnalysis

: 必須 はいAwsAccountId (p. 304)

更新する分析を含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

名前 (p. 304)

更新する分析のわかりやすい名前です。この名前は、QuickSight コンソールで分析に表示されます。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 はいSourceEntity (p. 304)

更新する分析に使用するソースエンティティ。このメタデータ構造には、ソーステンプレートと 1 つ以上のデータセットを記述する詳細が含まれています。

タイプ: AnalysisSourceEntity (p. 393) オブジェクト

: 必須 はいパラメータ (p. 304)

使用するパラメーター名および値をオーバーライドします。解析には任意のパラメータタイプがあり、パラメータによっては複数の値を受け入れる場合があります。

タイプ: Parameters (p. 476) オブジェクト

: 必須 いいえThemeArn (p. 304)

作成する分析に適用するテーマの Amazon リソースネーム (ARN)。QuickSight コンソールでテーマを表示するには、ユーザーがテーマにアクセスできることを確認します。

タイプ: 文字列

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "AnalysisId": "string", "Arn": "string", "RequestId": "string",

305

UpdateAnalysis

"UpdateStatus": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 305)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

AnalysisId (p. 305)

分析の ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+Arn (p. 305)

更新する分析の ARN。

タイプ: 文字列RequestId (p. 305)

この操作の AWS リクエスト ID。

タイプ: 文字列更新ステータス (p. 305)

解析に対して行われた最後の更新の更新ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

306

UpdateAnalysis

HTTP ステータスコード: 400ResourceExistsException

指定されたリソースは既に存在します。

HTTP ステータスコード: 409ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

307

UpdateAnalysisPermissions

UpdateAnalysisPermissions分析の読み取りと書き込みのアクセス許可を更新します。

リクエストの構文

PUT /accounts/AwsAccountId/analyses/AnalysisId/permissions HTTP/1.1Content-type: application/json

{ "GrantPermissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RevokePermissions": [ { "Actions": [ "string" ], "Principal": "string" } ]}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AnalysisId (p. 308)

アクセス許可を更新する分析の ID。ID は分析 URL の一部です。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はいAwsAccountId (p. 308)

アクセス許可を更新する分析を含む AWS アカウントの ID。分析対象の AWS アカウントを使用する必要があります。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

権限の許可 (p. 308)

追加する権限と追加するプリンシパルを記述する構造体。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

308

UpdateAnalysisPermissions

Array Membace 最大数は 100 項目です。

: 必須 いいえ権限の取り消し (p. 308)

削除するアクセス許可と、それらを削除するプリンシパルを記述する構造体。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最大数は 100 項目です。

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "AnalysisArn": "string", "AnalysisId": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 309)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

分析サーン (p. 309)

更新した分析の Amazon リソースネーム (ARN)。

タイプ: 文字列AnalysisId (p. 309)

アクセス許可を更新した分析の ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+アクセス許可 (p. 309)

分析のプリンシパルとリソースレベルのパーミッションを記述する構造体。

309

UpdateAnalysisPermissions

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 309)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。

HTTP ステータスコード: 403

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go

310

UpdateDashboard

UpdateDashboardAWS アカウントのダッシュボードを更新します。

リクエストの構文

PUT /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1Content-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" ] } ] }, "SourceEntity": { "SourceTemplate": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "ThemeArn": "string", "VersionDescription": "string"}

312

UpdateDashboard

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 312)

更新するダッシュボードが含まれる AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいDashboardId (p. 312)

ダッシュボードの ID。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

名前 (p. 312)

ダッシュボードの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 はいSourceEntity (p. 312)

ダッシュボードを更新するときにソースとして使用しているエンティティ。EclipseSourceEntityでは、ソースとして使用しているオブジェクトのタイプを指定します。ダッシュボードはテンプレートからのみ更新できるため、SourceTemplateエンティティ。解析からダッシュボードを更新する必要がある場合は、まず解析をテンプレートに変換し、CreateTemplate (p. 75)API オペレーション。を使用する場合SourceTemplateで、ソーステンプレートの Amazon リソースネーム (ARN) を指定します。-SourceTemplateARN には、任意の AWS アカウントと QuickSight がサポートする AWS リージョンを含めることができます。

の使用DataSetReferences内のエンティティSourceTemplateをクリックして、元のプレースホルダにリストされているプレースホルダの置換データセットをリストします。各データセットのスキーマは、プレースホルダと一致する必要があります。

タイプ: DashboardSourceEntity (p. 419) オブジェクト

: 必須 はいDashboardPublishOptions (p. 312)

ダッシュボードの作成時にダッシュボードを公開するためのオプション:• AvailabilityStatusforAdHocFilteringOption-このステータスは、ENABLEDまた

はDISABLED。これをDISABLEDに設定すると、QuickSight は公開ダッシュボードの左側のフィル

313

UpdateDashboard

ターウィンドウを無効にします。このフィルターは、アドホック (ワンタイム) フィルターに使用できます。このオプションは次のとおりです。ENABLEDデフォルトはです。

• AvailabilityStatusforExportToCSVOption-このステータスは、ENABLEDまたはDISABLED。.CSV 形式にデータをエクスポートするビジュアルオプションは、DISABLED。このオプションは次のとおりです。ENABLEDデフォルトはです。

• VisibilityStateforSheetControlsOption-この可視性の状態は、COLLAPSEDまたはEXPANDED。このオプションは次のとおりです。COLLAPSEDデフォルトはです。

タイプ: DashboardPublishOptions (p. 417) オブジェクト

: 必須 いいえパラメータ (p. 312)

ダッシュボードのパラメータを含む構造。これらは、ダッシュボードのパラメータオーバーライドです。ダッシュボードには任意のタイプのパラメータを持つことができ、一部のパラメータは複数の値を受け入れる場合があります。

タイプ: Parameters (p. 476) オブジェクト

: 必須 いいえThemeArn (p. 312)

このダッシュボードに使用されているテーマの Amazon リソースネーム (ARN)。このフィールドに値を追加すると、エンティティに元々関連付けられていた値が上書きされます。テーマ ARN は、ダッシュボードを作成するのと同じ AWS アカウントに存在する必要があります。

タイプ: 文字列

: 必須 いいえVersionDescription (p. 312)

作成するダッシュボードの最初のバージョンの説明。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえ

レスポンスの構文HTTP/1.1 200Content-type: application/json

{ "Arn": "string", "CreationStatus": "string", "DashboardId": "string", "RequestId": "string", "Status": number, "VersionArn": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

314

UpdateDashboard

Arn (p. 314)

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列作成ステータス (p. 314)

リクエストの作成ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DashboardId (p. 314)

ダッシュボードの ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+RequestId (p. 314)

この操作の AWS リクエスト ID。

タイプ: 文字列ステータス (p. 314)

リクエストの HTTP ステータス。

タイプ: 整数バージョンARN (p. 314)

バージョン番号を含む、ダッシュボードの ARN。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400

315

UpdateDashboard

LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

316

UpdateDashboardPermissions

UpdateDashboardPermissionsダッシュボードの読み取りと書き込みのアクセス許可を更新します。

リクエストの構文PUT /accounts/AwsAccountId/dashboards/DashboardId/permissions HTTP/1.1Content-type: application/json

{ "GrantPermissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RevokePermissions": [ { "Actions": [ "string" ], "Principal": "string" } ]}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 317)

アクセス許可を更新するダッシュボードを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいDashboardId (p. 317)

ダッシュボードの ID。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

権限の許可 (p. 317)

このリソースに対して付与するアクセス許可です。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最大数は 100 項目です。

317

UpdateDashboardPermissions

: 必須 いいえ権限の取り消し (p. 317)

このリソースから取り消すアクセス許可。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

Array Membace 最大数は 100 項目です。

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "DashboardArn": "string", "DashboardId": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 318)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

DashboardArn (p. 318)

ダッシュボードの Amazon リソースネーム (ARN)。

タイプ: 文字列DashboardId (p. 318)

ダッシュボードの ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+アクセス許可 (p. 318)

ダッシュボードの権限に関する情報。

タイプ: 配列インデックス作成ResourcePermission (p. 488)objects

318

UpdateDashboardPermissions

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 318)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise 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 バージョン 2

319

UpdateDashboardPublishedVersion

UpdateDashboardPublishedVersionダッシュボードの発行済みバージョンを更新します。

リクエストの構文PUT /accounts/AwsAccountId/dashboards/DashboardId/versions/VersionNumber HTTP/1.1

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 321)

更新するダッシュボードが含まれる AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいDashboardId (p. 321)

ダッシュボードの ID。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はいVersionNumber (p. 321)

ダッシュボードのバージョン番号。

有効範囲: 最小値は 1 です。

: 必須 はい

リクエストボディリクエストボディにリクエストボディはありません。

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "DashboardArn": "string", "DashboardId": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

321

UpdateDashboardPublishedVersion

ステータス (p. 321)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

DashboardArn (p. 321)

ダッシュボードの Amazon リソースネーム (ARN)。

タイプ: 文字列DashboardId (p. 321)

ダッシュボードの ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+RequestId (p. 321)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard

322

UpdateDashboardPublishedVersion

Edition と Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

323

UpdateDataSet

UpdateDataSetデータセットを更新します。

リクエストの構文

PUT /accounts/AwsAccountId/data-sets/DataSetId HTTP/1.1Content-type: application/json

{ "ColumnGroups": [ { "GeoSpatialColumnGroup": { "Columns": [ "string" ], "CountryCode": "string", "Name": "string" } } ], "ColumnLevelPermissionRules": [ { "ColumnNames": [ "string" ], "Principals": [ "string" ] } ], "FieldFolders": { "string" : { "columns": [ "string" ], "description": "string" } }, "ImportMode": "string", "LogicalTableMap": { "string" : { "Alias": "string", "DataTransforms": [ { "CastColumnTypeOperation": { "ColumnName": "string", "Format": "string", "NewColumnType": "string" }, "CreateColumnsOperation": { "Columns": [ { "ColumnId": "string", "ColumnName": "string", "Expression": "string" } ] }, "FilterOperation": { "ConditionExpression": "string" }, "ProjectOperation": { "ProjectedColumns": [ "string" ] }, "RenameColumnOperation": { "ColumnName": "string", "NewColumnName": "string" }, "TagColumnOperation": { "ColumnName": "string",

324

UpdateDataSet

"Tags": [ { "ColumnDescription": { "Text": "string" }, "ColumnGeographicRole": "string" } ] } } ], "Source": { "JoinInstruction": { "LeftJoinKeyProperties": { "UniqueKey": boolean }, "LeftOperand": "string", "OnClause": "string", "RightJoinKeyProperties": { "UniqueKey": boolean }, "RightOperand": "string", "Type": "string" }, "PhysicalTableId": "string" } } }, "Name": "string", "PhysicalTableMap": { "string" : { "CustomSql": { "Columns": [ { "Name": "string", "Type": "string" } ], "DataSourceArn": "string", "Name": "string", "SqlQuery": "string" }, "RelationalTable": { "Catalog": "string", "DataSourceArn": "string", "InputColumns": [ { "Name": "string", "Type": "string" } ], "Name": "string", "Schema": "string" }, "S3Source": { "DataSourceArn": "string", "InputColumns": [ { "Name": "string", "Type": "string" } ], "UploadSettings": { "ContainsHeader": boolean, "Delimiter": "string", "Format": "string",

325

UpdateDataSet

"StartFromRow": number, "TextQualifier": "string" } } } }, "RowLevelPermissionDataSet": { "Arn": "string", "FormatVersion": "string", "Namespace": "string", "PermissionPolicy": "string" }}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 324)

AWS アカウント ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいデータセット ID (p. 324)

更新するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

インポートモード (p. 324)

データを SPICE にインポートするかどうかを示します。

タイプ: 文字列

有効な値: SPICE | DIRECT_QUERY

: 必須 はい名前 (p. 324)

データセットの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい物理テーブルマップ (p. 324)

基になるデータソースで使用可能な物理テーブルを宣言します。

タイプ: 文字列PhysicalTable (p. 477)オブジェクトマップ

326

UpdateDataSet

マップエントリ: 最大数は 32 項目です。

キーの長さ制限: 最小長は 1 です。 最大長は 64 です。

キーパターン:[0-9a-zA-Z-]*

: 必須 はい列グループ (p. 324)

特定の QuickSight 機能で連携する列のグループ化 現在、空間階層のみがサポートされます。

タイプ: では必須ColumnGroup (p. 405)objects

Array Membace 最小項目数は 1 項目です。最大数は 8 項目です。

: 必須 いいえ列レベル権限ルール (p. 324)

1 つ以上の定義のセット ColumnLevelPermissionRule (p. 408) 。

タイプ: では必須ColumnLevelPermissionRule (p. 408)objects

Array Membace 最小項目数は 1 項目です。

: 必須 いいえフィールドフォルダ (p. 324)

データセットのフィールドとネストされたサブフォルダーを格納するフォルダー。

タイプ: 文字列FieldFolder (p. 448)オブジェクトマップ

キーの長さ制限: 最小長は 1 です。 最大長は 1000 です。

: 必須 いいえ論理テーブルマップ (p. 324)

物理テーブルからのデータの組み合わせと変換を設定します。

タイプ: 文字列LogicalTable (p. 465)オブジェクトマップ

マップエントリ: 最大数は 64 項目です。

キーの長さ制限: 最小長は 1 です。 最大長は 64 です。

キーパターン:[0-9a-zA-Z-]*

: 必須 いいえRowlelPermissionデータセット (p. 324)

作成するデータの行レベルのセキュリティ構成。

タイプ: RowLevelPermissionDataSet (p. 490) オブジェクト

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

327

UpdateDataSet

{ "Arn": "string", "DataSetId": "string", "IngestionArn": "string", "IngestionId": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 327)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

Arn (p. 327)

データセットの Amazon リソースネーム (ARN)。

タイプ: 文字列データセット ID (p. 327)

作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列インジェクションアーン (p. 327)

取り込みの ARN。インポートモードが SPICE の場合、データセットの作成の結果としてトリガーされます。

タイプ: 文字列取り込み ID (p. 327)

取り込みの ID。インポートモードが SPICE の場合、データセットの作成の結果としてトリガーされます。

タイプ: 文字列RequestId (p. 327)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

328

UpdateDataSet

HTTP ステータスコード: 401コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれていない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、StandardEdition と Enterprise Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。

HTTP ステータスコード: 403

ExamplesExample

この例では、UpdateDataSet の 1 つの使用方法を示します。

リクエスト例

POST /accounts/{AwsAccountId}/data-sets/{DataSetId} HTTP/1.1Content-type: application/json

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

329

UpdateDataSetPermissions

UpdateDataSetPermissionsデータセットの権限を更新します。

権限リソースはarn:aws:quicksight:region:aws-account-id:dataset/data-set-id。

リクエストの構文POST /accounts/AwsAccountId/data-sets/DataSetId/permissions HTTP/1.1Content-type: application/json

{ "GrantPermissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RevokePermissions": [ { "Actions": [ "string" ], "Principal": "string" } ]}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 331)

AWS アカウント ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいデータセット ID (p. 331)

アクセス許可を更新するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

権限の許可 (p. 331)

データセットに付与するリソースアクセス許可。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。

: 必須 いいえ

331

UpdateDataSetPermissions

権限の取り消し (p. 331)

データセットから取り消すリソースアクセス許可。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "DataSetArn": "string", "DataSetId": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 332)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

DataSetArn (p. 332)

データセットの Amazon リソースネーム (ARN)。

タイプ: 文字列データセット ID (p. 332)

アクセス許可を更新するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列RequestId (p. 332)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの

332

UpdateDataSetPermissions

利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

ExamplesExample

この例では、UpdateDataSetPermissions の 1 つの使用方法を示します。

リクエスト例

POST /accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions HTTP/1.1Content-type: application/json

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python

333

UpdateDataSetPermissions

• AWS SDK for Ruby v3

334

UpdateDataSource

UpdateDataSourceデータソースを更新します。

リクエストの構文

PUT /accounts/AwsAccountId/data-sources/DataSourceId HTTP/1.1Content-type: application/json

{ "Credentials": { "CopySourceArn": "string", "CredentialPair": { "AlternateDataSourceParameters": [ { "AmazonElasticsearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "string" }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": {

335

UpdateDataSource

"Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } } ], "Password": "string", "Username": "string" } }, "DataSourceParameters": { "AmazonElasticsearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "string"

336

UpdateDataSource

}, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": { "Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number

337

UpdateDataSource

}, "TwitterParameters": { "MaxRows": number, "Query": "string" } }, "Name": "string", "SslProperties": { "DisableSsl": boolean }, "VpcConnectionProperties": { "VpcConnectionArn": "string" }}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 335)

AWS アカウント ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいデータソース ID (p. 335)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

名前 (p. 335)

データソースの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい認証情報 (p. 335)

基になるソースに接続するために QuickSight が使用する資格情報。現在、ユーザー名とパスワードに基づく認証情報のみがサポートされています。

タイプ: DataSourceCredentials (p. 439) オブジェクト

: 必須 いいえデータソースパラメータ (p. 335)

基礎となるソースへの接続に QuickSight が使用するパラメータ。

338

UpdateDataSource

タイプ: DataSourceParameters (p. 441) オブジェクト

: 必須 いいえSSLプロパティ (p. 335)

QuickSight が基盤となるソースに接続するときに適用されるセキュアソケットレイヤー (SSL) プロパティ。

タイプ: SslProperties (p. 501) オブジェクト

: 必須 いいえvPC接続のプロパティ (p. 335)

このパラメータは、基になるソースに接続するときに QuickSight で VPC 接続を使用する場合にのみ使用します。

タイプ: VpcConnectionProperties (p. 543) オブジェクト

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "DataSourceId": "string", "RequestId": "string", "UpdateStatus": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 339)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

Arn (p. 339)

データソースの Amazon リソースネーム (ARN)。

タイプ: 文字列データソース ID (p. 339)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列RequestId (p. 339)

この操作の AWS リクエスト ID。

タイプ: 文字列

339

UpdateDataSource

更新ステータス (p. 339)

データソースの最終更新の更新ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

ExamplesExample

この例では、UpdateDataSource の 1 つの使用方法を示します。

リクエスト例

PUT /accounts/{AwsAccountId}/data-sources/{DataSourceId} HTTP/1.1

340

UpdateDataSourcePermissions

UpdateDataSourcePermissionsデータソースに対する権限を更新します。

リクエストの構文POST /accounts/AwsAccountId/data-sources/DataSourceId/permissions HTTP/1.1Content-type: application/json

{ "GrantPermissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RevokePermissions": [ { "Actions": [ "string" ], "Principal": "string" } ]}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 342)

AWS アカウント ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいデータソース ID (p. 342)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

権限の許可 (p. 342)

データソースに付与するリソース権限のリスト。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。

: 必須 いいえ権限の取り消し (p. 342)

データソースで取り消すリソース権限のリスト。

342

UpdateDataSourcePermissions

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "DataSourceArn": "string", "DataSourceId": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 343)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

DataSourceArn (p. 343)

データソースの Amazon リソースネーム (ARN)。

タイプ: 文字列データソース ID (p. 343)

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列RequestId (p. 343)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401

343

UpdateDataSourcePermissions

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

ExamplesExample

この例では、UpdateDataSourcePermissions の使用方法を 1 つ示します。

リクエスト例

POST /accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions HTTP/1.1Content-type: application/json

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

344

UpdateGroup

UpdateGroupグループの説明を変更します。

リクエストの構文PUT /accounts/AwsAccountId/namespaces/Namespace/groups/GroupName HTTP/1.1Content-type: application/json

{ "Description": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 345)

グループが属する AWS アカウントの ID。現時点では、Amazon QuickSight アカウントを含む AWSアカウントの ID を使用します。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいGroupName (p. 345)

更新するグループの名前。

長さの制約: 最小長は 1 です。

パターン: [\u0020-\u00FF]+

: 必須 はい名前空間 (p. 345)

名前空間。現在、これをに設定する必要があります。default。

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

説明 (p. 345)

更新するグループの説明。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 512 です。

345

UpdateGroup

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "Group": { "Arn": "string", "Description": "string", "GroupName": "string", "PrincipalId": "string" }, "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 346)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

グループ (p. 346)

グループの名前。

タイプ: Group (p. 451) オブジェクトRequestId (p. 346)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500

346

UpdateGroup

InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ResourceUnavailableException

このリソースは現在使用できません。

HTTP ステータスコード: 503ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

347

UpdateIAMPolicyAssignment

UpdateIAMPolicyAssignment既存の IAM ポリシー割り当てを更新します。この操作は、リクエストで指定されたオプションのパラメーター (1 つまたは複数) のみを更新します。これにより、に含まれるすべてのユーザーが上書きされます。Identities。

リクエストの構文

PUT /accounts/AwsAccountId/namespaces/Namespace/iam-policy-assignments/AssignmentName HTTP/1.1Content-type: application/json

{ "AssignmentStatus": "string", "Identities": { "string" : [ "string" ] }, "PolicyArn": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

割り当て名 (p. 348)

割り当ての名前。ルールとも呼ばれます。この名前は AWS アカウント内で一意でなければなりません。

長さの制約: 最小長は 1 です。

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$

: 必須 はいAwsAccountId (p. 348)

IAM ポリシー割り当てを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい名前空間 (p. 348)

割り当ての名前空間です。

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

348

UpdateIAMPolicyAssignment

AssignmentStatus (p. 348)

割り当てのステータス。指定できる値は次のとおりです。• ENABLED-この割り当てで指定されているものは、データソースの作成時に使用されます。• DISABLED-この割り当ては、データソースの作成時に使用されません。• DRAFT-この割り当ては未完成のドラフトであり、データソースの作成時には使用されません。

タイプ: 文字列

有効な値: ENABLED | DRAFT | DISABLED

: 必須 いいえID (p. 348)

ポリシーを割り当てる QuickSight ユーザー、グループ、またはその両方。

タイプ: 文字列から文字列の配列へのマッピング

長さの制約: 最小長は 1 です。

パターン: [\u0020-\u00FF]+

: 必須 いいえPolicyArn (p. 348)

この割り当てで指定された QuickSight ユーザーとグループに適用する IAM ポリシーの ARN。

タイプ: 文字列

: 必須 いいえ

レスポンスの構文

HTTP/1.1 StatusContent-type: application/json

{ "AssignmentId": "string", "AssignmentName": "string", "AssignmentStatus": "string", "Identities": { "string" : [ "string" ] }, "PolicyArn": "string", "RequestId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 349)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

349

UpdateIAMPolicyAssignment

割り当てID (p. 349)

割り当ての ID です。

タイプ: 文字列割り当て名 (p. 349)

割り当てまたはルールの名前。

タイプ: 文字列

長さの制約: 最小長は 1 です。

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$AssignmentStatus (p. 349)

割り当てのステータス。指定できる値は次のとおりです。• ENABLED-この割り当てで指定されているものは、データソースの作成時に使用されます。• DISABLED-この割り当ては、データソースの作成時に使用されません。• DRAFT-この割り当ては未完成のドラフトであり、データソースの作成時には使用されません。

タイプ: 文字列

有効な値: ENABLED | DRAFT | DISABLEDID (p. 349)

IAM ポリシーが割り当てられている QuickSight ユーザー、グループ、またはその両方。

タイプ: 文字列から文字列の配列へのマッピング

長さの制約: 最小長は 1 です。

パターン: [\u0020-\u00FF]+PolicyArn (p. 349)

この割り当てで指定された QuickSight ユーザーとグループに適用される IAM ポリシーの ARN。

タイプ: 文字列RequestId (p. 349)

この操作の AWS リクエスト ID。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401

350

UpdateIAMPolicyAssignment

同時処理例外

リソースは、新しい更新を適用する前に完了する必要がある操作が実行中であることを示す状態ですでにあります。

HTTP ステータスコード: 500InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceExistsException

指定されたリソースは既に存在します。

HTTP ステータスコード: 409ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

351

UpdateTemplate

UpdateTemplate既存の Amazon QuickSight 分析または別のテンプレートからテンプレートを更新します。

リクエストの構文PUT /accounts/AwsAccountId/templates/TemplateId HTTP/1.1Content-type: application/json

{ "Name": "string", "SourceEntity": { "SourceAnalysis": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] }, "SourceTemplate": { "Arn": "string" } }, "VersionDescription": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 352)

更新するテンプレートを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいTemplateId (p. 352)

テンプレートの ID。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

SourceEntity (p. 352)

テンプレートを更新するときにソースとして使用しているエンティティ。EclipseSourceEntityでは、ソースとして使用しているオブジェクトのタイプを指定します。SourceTemplateテンプレート

352

UpdateTemplate

(テンプレート)SourceAnalysis分析を実行します。どちらの場合も Amazon リソースネーム (ARN)が必要です。を使用する場合SourceTemplateで、ソーステンプレートの ARN を指定します。を使用する場合SourceAnalysisで、ソース分析の ARN を指定します。-SourceTemplateARN には、任意の AWS アカウントと QuickSight がサポートする AWS リージョンを含めることができます。

の使用DataSetReferences内のエンティティSourceTemplateまたはSourceAnalysisをクリックして、元のプレースホルダにリストされているプレースホルダの置換データセットをリストします。各データセットのスキーマは、プレースホルダと一致する必要があります。

タイプ: TemplateSourceEntity (p. 510) オブジェクト

: 必須 はい名前 (p. 352)

テンプレートの名前。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえVersionDescription (p. 352)

更新する現在のテンプレートバージョンの説明。電話するたびにUpdateTemplateを選択した場合は、新しいバージョンのテンプレートを作成します。テンプレートの各バージョンでは、バージョンの説明がVersionDescriptionfield。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "CreationStatus": "string", "RequestId": "string", "TemplateId": "string", "VersionArn": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 353)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

Arn (p. 353)

テンプレートの Amazon リソースネーム (ARN)。

353

UpdateTemplate

タイプ: 文字列作成ステータス (p. 353)

テンプレートの作成ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

RequestId (p. 353)

この操作の AWS リクエスト ID。

タイプ: 文字列TemplateId (p. 353)

テンプレートの ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+バージョンARN (p. 353)

テンプレートの ARN(最初のバージョンのバージョン情報を含む)。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

指定されたリソースは既に存在します。

HTTP ステータスコード: 409

354

UpdateTemplate

ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard Editionと Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

355

UpdateTemplateAlias

UpdateTemplateAliasテンプレートのテンプレートエイリアスを更新します。

リクエストの構文

PUT /accounts/AwsAccountId/templates/TemplateId/aliases/AliasName HTTP/1.1Content-type: application/json

{ "TemplateVersionNumber": number}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AliasName (p. 356)

更新するテンプレートのエイリアス。特定のエイリアスに名前を付けると、エイリアスが指すバージョンを更新します。テンプレートの最新バージョンを指定するには、キーワード$LATEST()AliasNameパラメータ。キーワード$PUBLISHEDはテンプレートには適用されません。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 はいAwsAccountId (p. 356)

更新するテンプレートエイリアスを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいTemplateId (p. 356)

テンプレートの ID。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

テンプレートバージョン番号 (p. 356)

テンプレートのバージョン番号。

タイプ: Long

356

UpdateTemplateAlias

有効範囲: 最小値は 1 です。

: 必須 はい

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "TemplateAlias": { "AliasName": "string", "Arn": "string", "TemplateVersionNumber": number }}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 357)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId (p. 357)

この操作の AWS リクエスト ID。

タイプ: 文字列テンプレート・エイリアス (p. 357)

テンプレートのエイリアス。

タイプ: TemplateAlias (p. 507) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

357

UpdateTemplateAlias

HTTP ステータスコード: 500ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard Editionと Enterprise 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 バージョン 2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

358

UpdateTemplatePermissions

UpdateTemplatePermissionsテンプレートのリソースに対するアクセス許可を更新します。

リクエストの構文PUT /accounts/AwsAccountId/templates/TemplateId/permissions HTTP/1.1Content-type: application/json

{ "GrantPermissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RevokePermissions": [ { "Actions": [ "string" ], "Principal": "string" } ]}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 359)

テンプレートを含む AWS アカウントの ID。

長さの制約: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいTemplateId (p. 359)

テンプレートの ID。

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

権限の許可 (p. 359)

テンプレートで付与されるリソース権限のリスト。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最大数は 100 項目です。

359

UpdateTemplatePermissions

: 必須 いいえ権限の取り消し (p. 359)

テンプレートから取り消されるリソース権限のリスト。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最大数は 100 項目です。

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string", "TemplateArn": "string", "TemplateId": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 360)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

アクセス許可 (p. 360)

テンプレートに設定するリソース権限のリスト。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 360)

この操作の AWS リクエスト ID。

タイプ: 文字列TemplateArn (p. 360)

テンプレートの Amazon リソースネーム (ARN)。

タイプ: 文字列TemplateId (p. 360)

テンプレートの ID。

360

UpdateTemplatePermissions

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard Editionと Enterprise 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 バージョン 2• AWS SDK for JavaScript

361

UpdateTheme

UpdateThemeテーマを更新します。

リクエストの構文PUT /accounts/AwsAccountId/themes/ThemeId HTTP/1.1Content-type: application/json

{ "BaseThemeId": "string", "Configuration": { "DataColorPalette": { "Colors": [ "string" ], "EmptyFillColor": "string", "MinMaxGradient": [ "string" ] }, "Sheet": { "Tile": { "Border": { "Show": boolean } }, "TileLayout": { "Gutter": { "Show": boolean }, "Margin": { "Show": boolean } } }, "UIColorPalette": { "Accent": "string", "AccentForeground": "string", "Danger": "string", "DangerForeground": "string", "Dimension": "string", "DimensionForeground": "string", "Measure": "string", "MeasureForeground": "string", "PrimaryBackground": "string", "PrimaryForeground": "string", "SecondaryBackground": "string", "SecondaryForeground": "string", "Success": "string", "SuccessForeground": "string", "Warning": "string", "WarningForeground": "string" } }, "Name": "string", "VersionDescription": "string"}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 363)

更新するテーマを含む AWS アカウントの ID。

363

UpdateTheme

長さの制限: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいThemeId (p. 363)

テーマの ID です。

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

BaseThemeId (p. 363)

カスタムテーマが継承するテーマ ID。すべてのテーマは、最初は既定の QuickSight テーマから継承されます。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい設定 (p. 363)

テーマ設定。テーマ表示プロパティが含まれます。

タイプ: ThemeConfiguration (p. 522) オブジェクト

: 必須 いいえ名前 (p. 363)

テーマの名前。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえVersionDescription (p. 363)

あなたが更新しているテーマバージョンの説明あなたが呼び出すたびにUpdateThemeで、テーマの新しいバージョンを作成します。テーマの各バージョンは、VersionDescription。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえ

364

UpdateTheme

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Arn": "string", "CreationStatus": "string", "RequestId": "string", "ThemeId": "string", "VersionArn": "string"}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 365)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

Arn (p. 365)

テーマの Amazon リソースネーム (ARN)。

タイプ: 文字列作成ステータス (p. 365)

テーマの作成ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

RequestId (p. 365)

この操作の AWS リクエスト ID。

タイプ: 文字列ThemeId (p. 365)

テーマの ID です。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+バージョンARN (p. 365)

テーマの新しいバージョンのAmazon リソースネーム (ARN)。

タイプ: 文字列

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

365

UpdateTheme

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409ResourceExistsException

指定されたリソースは既に存在します。

HTTP ステータスコード: 409ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard Editionと Enterprise Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。

HTTP ステータスコード: 403

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go

366

UpdateThemeAlias

UpdateThemeAliasテーマのエイリアスを更新します。

リクエストの構文

PUT /accounts/AwsAccountId/themes/ThemeId/aliases/AliasName HTTP/1.1Content-type: application/json

{ "ThemeVersionNumber": number}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AliasName (p. 368)

更新するテーマのエイリアスの名前。

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 はいAwsAccountId (p. 368)

更新するテーマエイリアスを含む AWS アカウントの ID。

長さの制限: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいThemeId (p. 368)

テーマの ID です。

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

テーマEversionNumber (p. 368)

エイリアスが参照するテーマのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

368

UpdateThemeAlias

: 必須 はい

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "ThemeAlias": { "AliasName": "string", "Arn": "string", "ThemeVersionNumber": number }}

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 369)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId (p. 369)

この操作の AWS リクエスト ID。

タイプ: 文字列テーマエイリアス (p. 369)

テーマの別名に関する情報。

タイプ: ThemeAlias (p. 521) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

コンフリクトセプション

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400

369

UpdateThemeAlias

ResourceExistsException

指定されたリソースは既に存在します。

HTTP ステータスコード: 409ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard Editionと Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

370

UpdateThemePermissions

UpdateThemePermissionsテーマに対するリソースに対するアクセス許可を更新します。パーミッションは、パーミッションを付与または取り消すアクションに適用されます (例:"quicksight:DescribeTheme"。

テーマのアクセス許可は、グループ分けで適用されます。有効なグループ分けには、ユーザー、所有者、または権限なしの 3 つのレベルがあります。

• ユーザー• "quicksight:DescribeTheme"

• "quicksight:DescribeThemeAlias"

• "quicksight:ListThemeAliases"

• "quicksight:ListThemeVersions"

• 所有者• "quicksight:DescribeTheme"

• "quicksight:DescribeThemeAlias"

• "quicksight:ListThemeAliases"

• "quicksight:ListThemeVersions"

• "quicksight:DeleteTheme"

• "quicksight:UpdateTheme"

• "quicksight:CreateThemeAlias"

• "quicksight:DeleteThemeAlias"

• "quicksight:UpdateThemeAlias"

• "quicksight:UpdateThemePermissions"

• "quicksight:DescribeThemePermissions"

• 権限を指定しない場合は、権限一覧を省略します。

リクエストの構文

PUT /accounts/AwsAccountId/themes/ThemeId/permissions HTTP/1.1Content-type: application/json

{ "GrantPermissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RevokePermissions": [ { "Actions": [ "string" ], "Principal": "string" } ]}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

371

UpdateThemePermissions

AwsAccountId (p. 371)

テーマを含む AWS アカウントの ID。

長さの制限: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はいThemeId (p. 371)

テーマの ID です。

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

権限の許可 (p. 371)

テーマに付与されるリソース権限のリスト。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最大数は 100 項目です。

: 必須 いいえ権限の取り消し (p. 371)

テーマから取り消されるリソース権限のリスト。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最大数は 100 項目です。

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string", "ThemeArn": "string", "ThemeId": "string"}

372

UpdateThemePermissions

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 372)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

アクセス許可 (p. 372)

結果のテーマに対するリソース権限のリスト。

タイプ: では必須ResourcePermission (p. 488)objects

Array Membace 最小項目数は 1 項目です。最大数は 64 項目です。RequestId (p. 372)

この操作の AWS リクエスト ID。

タイプ: 文字列ThemeArn (p. 372)

テーマの Amazon リソースネーム (ARN)。

タイプ: 文字列ThemeId (p. 372)

テーマの ID です。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

373

UpdateThemePermissions

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429UnsupportedUserEditionException

エディションにそのオペレーションのサポートが含まれない Amazon QuickSight サブスクリプションでオペレーションを呼び出していることを示します。Amazon QuickSight には現在、Standard Editionと Enterprise 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

374

UpdateUser

UpdateUserAmazon QuickSight ユーザーを更新します。

リクエストの構文

PUT /accounts/AwsAccountId/namespaces/Namespace/users/UserName HTTP/1.1Content-type: application/json

{ "CustomFederationProviderUrl": "string", "CustomPermissionsName": "string", "Email": "string", "ExternalLoginFederationProviderType": "string", "ExternalLoginId": "string", "Role": "string", "UnapplyCustomPermissions": boolean}

URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。

AwsAccountId (p. 375)

ユーザーがいる AWS アカウントの ID。現時点では、Amazon QuickSight アカウントを含む AWS アカウントの ID を使用します。

長さの制限: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 はい名前空間 (p. 375)

名前空間。現在、これをに設定する必要があります。default。

長さの制限: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 はいUserName (p. 375)

更新する Amazon QuickSight ユーザー名。

長さの制限: 最小長は 1 です。

パターン: [\u0020-\u00FF]+

: 必須 はい

リクエストボディリクエストは以下のデータを JSON 形式で受け入れます。

375

UpdateUser

メール (p. 375)

更新するユーザーの E メールアドレス。

タイプ: 文字列

: 必須 はいロール (p. 375)

ユーザーの Amazon QuickSight ロール。ロールには、次のいずれかのデフォルトセキュリティコホートを指定できます。• READERダッシュボードに対する読み取り専用アクセス権を持つユーザー。• AUTHOR: データソース、データセット、分析、およびダッシュボードを作成できるユーザー。• ADMIN: Amazon QuickSight の設定を管理できる著者であるユーザー。

QuickSight ロールの名前は、権限を扱うコンソール画面を除き、ユーザーには表示されません。

タイプ: 文字列

有効な値: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

: 必須 はいカスタムフェデレーションプロバイダー URL (p. 375)

関連付けられた AWS ID およびアクセス管理(IAM)ロールを使用して QuickSight にフェデレーションできるように ID を提供するカスタム OpenID Connect (OIDC) プロバイダーの URL。このパラメーターは、ExternalLoginFederationProviderTypeパラメータはCUSTOM_OIDC。

タイプ: 文字列

: 必須 いいえカスタム権限名 (p. 375)

(Enterprise エディションのみ)このユーザーに割り当てるカスタム権限プロファイルの名前。カスタマイズされたアクセス許可を使用すると、次の操作でアクセスを制限することで、ユーザーのアクセスを制御できます。• データソースの作成と更新• データセットの作成と更新• E メールレポートの作成と更新• メールレポートのサブスクライブ

カスタムアクセス許可のセットには、これらの制限の任意の組み合わせが含まれます。現時点では、QuickSight コンソールを使用して、カスタム権限セットのプロファイル名を作成する必要があります。次に、RegisterUserAPI 操作を使用して、名前付きアクセス許可セットを QuickSight ユーザーに割り当てることができます。

QuickSight カスタムアクセス許可は、IAM ポリシーを通じて適用されます。したがって、QuickSightユーザーを QuickSight のデフォルトのセキュリティコホート (管理者、作成者、リーダー) のいずれかに割り当てることによって通常付与される権限を上書きします。

この機能は、シングルサインオン (SSO) 用の SAML 2.0 ベースのフェデレーションを使用するQuickSight Enterprise エディションサブスクリプションでのみ使用できます。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 64 です。

376

UpdateUser

パターン: ^[a-zA-Z0-9+=,.@_-]+$

: 必須 いいえ外部ログインフェデレーションプロバイダータイプ (p. 375)

関連付けられている AWS Identity and Access Management (IAM) ロールを使用して QuickSight にフェデレーションするための ID を提供する、サポートされている外部ログインプロバイダーのタイプ。サポートされる外部ログインプロバイダーのタイプは、次のいずれかになります。• COGNITOAmazon Cognito プロバイダの URL は cognito-identity.amazonaws.com です。選択すると

き、COGNITOプロバイダのタイプを使用する場合は、外部プロバイダーがカスタムの場合にのみ必要な「CustomFederationProviderURL」パラメータを使用しないでください。

• CUSTOM_OIDC: OpenID Connect (OIDC) プロバイダー。選択するときCUSTOM_OIDCタイプを使用する場合は、CustomFederationProviderUrlパラメーターを使用して、カスタム OIDC プロバイダー URL を指定します。

• NONE: これにより、以前に保存したユーザーの外部ログイン情報がすべてクリアされます。を使用する DescribeUser (p. 204) API を使用して、外部ログイン情報を確認します。

タイプ: 文字列

: 必須 いいえ外部LoginID (p. 375)

外部ログインプロバイダー内のユーザーのアイデンティティ ID。

タイプ: 文字列

: 必須 いいえ非適用のカスタム権限 (p. 375)

このユーザーからすべてのカスタム権限を削除することを示すために使用するフラグ。このパラメータを使用すると、ユーザーはカスタム権限プロファイルが適用される前の状態にリセットされます。このパラメータのデフォルトは NULL で、他の値は受け付けません。

タイプ: ブール値

: 必須 いいえ

レスポンスの構文HTTP/1.1 StatusContent-type: application/json

{ "RequestId": "string", "User": { "Active": boolean, "Arn": "string", "CustomPermissionsName": "string", "Email": "string", "ExternalLoginFederationProviderType": "string", "ExternalLoginFederationProviderUrl": "string", "ExternalLoginId": "string", "IdentityType": "string", "PrincipalId": "string", "Role": "string", "UserName": "string" }}

377

UpdateUser

レスポンス要素アクションが成功すると、サービスは HTTP レスポンスを返します。

ステータス (p. 377)

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId (p. 377)

この操作の AWS リクエスト ID。

タイプ: 文字列ユーザー (p. 377)

Amazon QuickSight ユーザーです。

タイプ: User (p. 540) オブジェクト

Errorsすべてのアクションに共通のエラーについては、「一般的なエラー (p. 543)」を参照してください。

AccessDeniedException

このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。お使いのアカウントが Amazon QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500InvalidParameterValueException

1 つまたは複数のパラメータに無効な値があります。

HTTP ステータスコード: 400PreconditionNotMetException

1 つ以上の前提条件が満たされていません。

HTTP ステータスコード: 400ResourceNotFoundException

1 つ以上のリソースが見つかりませんでした。

HTTP ステータスコード: 404ResourceUnavailableException

このリソースは現在使用できません。

378

データ型

HTTP ステータスコード: 503ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

以下の資料も参照してください。言語固有の 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 for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby v3

データ型以下のデータ型がサポートされています。

• AccountCustomization (p. 383)• AccountSettings (p. 384)• ActiveIAMPolicyAssignment (p. 386)• AdHocFilteringOption (p. 387)• AmazonElasticsearchParameters (p. 388)• Analysis (p. 389)• AnalysisError (p. 391)• AnalysisSearchFilter (p. 392)• AnalysisSourceEntity (p. 393)• AnalysisSourceTemplate (p. 394)• AnalysisSummary (p. 395)• AthenaParameters (p. 397)• AuroraParameters (p. 398)• AuroraPostgreSqlParameters (p. 399)• AwsIotAnalyticsParameters (p. 400)• BorderStyle (p. 401)• CalculatedColumn (p. 402)• CastColumnTypeOperation (p. 403)• ColumnDescription (p. 404)• ColumnGroup (p. 405)• ColumnGroupColumnSchema (p. 406)

379

データ型

• ColumnGroupSchema (p. 407)• ColumnLevelPermissionRule (p. 408)• ColumnSchema (p. 409)• ColumnTag (p. 410)• CreateColumnsOperation (p. 411)• CredentialPair (p. 412)• CustomSql (p. 413)• Dashboard (p. 414)• DashboardError (p. 416)• DashboardPublishOptions (p. 417)• DashboardSearchFilter (p. 418)• DashboardSourceEntity (p. 419)• DashboardSourceTemplate (p. 420)• DashboardSummary (p. 421)• DashboardVersion (p. 423)• DashboardVersionSummary (p. 425)• DataColorPalette (p. 427)• DataSet (p. 428)• DataSetConfiguration (p. 431)• DataSetReference (p. 432)• DataSetSchema (p. 433)• DataSetSummary (p. 434)• DataSource (p. 436)• DataSourceCredentials (p. 439)• DataSourceErrorInfo (p. 440)• DataSourceParameters (p. 441)• DateTimeParameter (p. 444)• DecimalParameter (p. 445)• ErrorInfo (p. 446)• ExportToCSVOption (p. 447)• FieldFolder (p. 448)• FilterOperation (p. 449)• GeoSpatialColumnGroup (p. 450)• Group (p. 451)• GroupMember (p. 452)• GutterStyle (p. 453)• IAMPolicyAssignment (p. 454)• IAMPolicyAssignmentSummary (p. 456)• Ingestion (p. 457)• InputColumn (p. 459)• IntegerParameter (p. 460)• JiraParameters (p. 461)• JoinInstruction (p. 462)• JoinKeyProperties (p. 464)• LogicalTable (p. 465)• LogicalTableSource (p. 466)

380

データ型

• ManifestFileLocation (p. 467)• MarginStyle (p. 468)• MariaDbParameters (p. 469)• MySqlParameters (p. 470)• NamespaceError (p. 471)• NamespaceInfoV2 (p. 472)• OracleParameters (p. 474)• OutputColumn (p. 475)• Parameters (p. 476)• PhysicalTable (p. 477)• PostgreSqlParameters (p. 478)• PrestoParameters (p. 479)• ProjectOperation (p. 480)• QueueInfo (p. 481)• RdsParameters (p. 482)• RedshiftParameters (p. 483)• RelationalTable (p. 485)• RenameColumnOperation (p. 487)• ResourcePermission (p. 488)• RowInfo (p. 489)• RowLevelPermissionDataSet (p. 490)• S3Parameters (p. 492)• S3Source (p. 493)• ServiceNowParameters (p. 494)• Sheet (p. 495)• SheetControlsOption (p. 496)• SheetStyle (p. 497)• SnowflakeParameters (p. 498)• SparkParameters (p. 499)• SqlServerParameters (p. 500)• SslProperties (p. 501)• StringParameter (p. 502)• Tag (p. 503)• TagColumnOperation (p. 504)• Template (p. 505)• TemplateAlias (p. 507)• TemplateError (p. 508)• TemplateSourceAnalysis (p. 509)• TemplateSourceEntity (p. 510)• TemplateSourceTemplate (p. 511)• TemplateSummary (p. 512)• TemplateVersion (p. 514)• TemplateVersionSummary (p. 516)• TeradataParameters (p. 518)• Theme (p. 519)• ThemeAlias (p. 521)

381

データ型

• ThemeConfiguration (p. 522)• ThemeError (p. 523)• ThemeSummary (p. 524)• ThemeVersion (p. 526)• ThemeVersionSummary (p. 528)• TileLayoutStyle (p. 530)• TileStyle (p. 531)• TransformOperation (p. 532)• TwitterParameters (p. 534)• UIColorPalette (p. 535)• UploadSettings (p. 538)• User (p. 540)• VpcConnectionProperties (p. 543)

382

AccountCustomization

AccountCustomization特定の AWS リージョン内の AWS アカウントまたは QuickSight 名前空間に関連付けられた AmazonQuickSight のカスタマイズ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

既定のテーマ

この QuickSight サブスクリプションの既定のテーマ。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

383

AccountSettings

AccountSettingsご使用の AWS アカウントに関連付けられている QuickSight 設定。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AccountName

AWS アカウントの QuickSight サブスクリプションに入力した「アカウント名」。この名前は、QuickSight にサインアップするときに作成します。これはすべての AWS で一意であり、ユーザーがサインインしたときにコンソールにのみ表示されます。

タイプ: 文字列

: 必須 いいえ既定の名前空間

ご使用の AWS アカウントのデフォルトの QuickSight 名前空間。

タイプ: 文字列

長さ制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 いいえエディション

現在購読している QuickSight のエディション: エンタープライズエディションまたはスタンダードエディション

タイプ: 文字列

有効な値: STANDARD | ENTERPRISE

: 必須 いいえ通知 E メール

QuickSight サブスクリプションのメイン通知メール。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

384

AccountSettings

385

ActiveIAMPolicyAssignment

ActiveIAMPolicyAssignmentアクティブな AWS Identity and Access Management (IAM) ポリシー割り当て。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

割り当て名

IAM ポリシー割り当ての名前。

タイプ: 文字列

長さ制約: 最小長は 1 です。

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$

: 必須 いいえPolicyArn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

386

AdHocFilteringOption

AdHocFilteringOptionアドホック (ワンタイム) フィルタリングオプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AvailabilityStatus

アベイラビリティーステータス。

タイプ: 文字列

有効な値: ENABLED | DISABLED

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

387

AmazonElasticsearchParameters

AmazonElasticsearchParametersAmazon Elasticsearch Service パラメータ

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

分野

Amazon Elasticsearch Service ドメイン。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 64 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

388

Analysis

AnalysisAmazon QuickSight での分析のメタデータ構造

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AnalysisId

分析の ID。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえArn

分析の Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

解析が作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえDataSetArns

分析のデータセットの ARN。

タイプ: 文字列の配列

Array Members 最大数は 100 項目です。

: 必須 いいえエラー

分析に関連するエラー。

タイプ: 配列インデックス作成AnalysisError (p. 391)objects

Array Members 最小項目数は 1 です。

: 必須 いいえLastUpdatedTime

分析が最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえ

389

Analysis

名前

分析のわかりやすい名前。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえシート

各シートの一意の識別子と名前を持つ、関連するシートのリスト。

タイプ: 配列インデックス作成Sheet (p. 495)objects

Array Members 最大数は 20 項目です。

: 必須 いいえステータス

分析に関連するステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

: 必須 いいえThemeArn

分析のテーマの ARN。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

390

AnalysisError

AnalysisError分析のメタデータエラー構造。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

メッセージ

分析エラーに関連付けられたメッセージ。

タイプ: 文字列

パターン: .*\S.*

: 必須 いいえタイプ

分析エラーのタイプ。

タイプ: 文字列

有効な値: ACCESS_DENIED | SOURCE_NOT_FOUND | DATA_SET_NOT_FOUND |INTERNAL_FAILURE | PARAMETER_VALUE_INCOMPATIBLE | PARAMETER_TYPE_INVALID |PARAMETER_NOT_FOUND | COLUMN_TYPE_MISMATCH | COLUMN_GEOGRAPHIC_ROLE_MISMATCH| COLUMN_REPLACEMENT_MISSING

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

391

AnalysisSearchFilter

AnalysisSearchFilter1 つまたは複数の解析を検索するときに適用するフィルタ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

名前

フィルターとして使用する値の名前 (など)。"Name": "QUICKSIGHT_USER"。

タイプ: 文字列

有効な値: QUICKSIGHT_USER

: 必須 いいえ演算子

フィルターとして使用する比較演算子 (など)。"Operator": "StringEquals"。

タイプ: 文字列

有効な値: StringEquals

: 必須 いいえ値

名前付きアイテムの値。この場合はQUICKSIGHT_USERなど、フィルタとして使用する"Value"。例:「"arn:aws:quicksight:us-east-1:1:user/default/UserName1"」。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

392

AnalysisSourceEntity

AnalysisSourceEntity分析のソースエンティティ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

SourceTemplate

分析のソースエンティティのソーステンプレート。

タイプ: AnalysisSourceTemplate (p. 394) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

393

AnalysisSourceTemplate

AnalysisSourceTemplate分析のソーステンプレート。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

分析のソーステンプレートの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 はいDataSetReferences

分析のソーステンプレートのデータセットリファレンス。

タイプ: 配列インデックス作成DataSetReference (p. 432)objects

Array Members 最小項目数は 1 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

394

AnalysisSummary

AnalysisSummary分析を説明するサマリーメタデータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AnalysisId

分析の ID。この ID は URL に表示されます。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえArn

分析用の Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

解析が作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえLastUpdatedTime

分析が最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえ名前

分析の名前。この名前は、QuickSight コンソールに表示されます。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえステータス

分析の最新の既知のステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

395

AnalysisSummary

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

396

AthenaParameters

AthenaParametersAmazon Athena パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

WorkGroup

Amazon Athena が使用するワークグループ。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 128 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

397

AuroraParameters

AuroraParametersAmazon Aurora パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

398

AuroraPostgreSqlParameters

AuroraPostgreSqlParametersPostgreSQL 互換性パラメータを持つ Amazon Aurora。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

399

AwsIotAnalyticsParameters

AwsIotAnalyticsParametersAWS IoT Analytics パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データセット名

データセット名。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

400

BorderStyle

BorderStyleビジュアルのタイルの境界線の表示オプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Show

ビジュアルの境界線の表示を有効にするオプション。

タイプ: ブール値

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

401

CalculatedColumn

CalculatedColumnデータセットの計算列。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

列ID

集計列を識別する一意の ID。データセットの更新中に、計算列の列 ID が既存の計算列の列 ID と一致する場合、Amazon QuickSight は既存の計算列を保持します。

タイプ: 文字列

長さ制約: 最小長は 1 です。 最大長は 64 です。

: 必須 はいColumnName

列名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい式

計算列を定義する式。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 4096 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

402

CastColumnTypeOperation

CastColumnTypeOperation列を別の型にキャストする変換操作。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ColumnName

列名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい新しい列タイプ

新しい列データ型。

タイプ: 文字列

有効な値: STRING | INTEGER | DECIMAL | DATETIME

: 必須 はい形式

列を文字列から datetime 型にキャストする場合、Amazon QuickSight でサポートされている形式で文字列を指定して、ソースデータ形式を指定できます。

タイプ: 文字列

長さの制約: 最大長は 32 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

403

ColumnDescription

ColumnDescription列の説明を含むメタデータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

テキスト

列の説明のテキストです。

タイプ: 文字列

長さの制約: 最小長は 0 です。最大長は 500 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

404

ColumnGroup

ColumnGroup特定の Amazon QuickSight 機能で連携する列のグループ化 これはバリアント型の構造です。この構造体が有効であるためには、属性の 1 つだけが null 以外の値になります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

空間列グループ

階層を示す空間列グループ。

タイプ: GeoSpatialColumnGroup (p. 450) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

405

ColumnGroupColumnSchema

ColumnGroupColumnSchema列の名前、データタイプ、地理的ロールを説明する構造体。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

名前

列グループの列スキーマの名前。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

406

ColumnGroupSchema

ColumnGroupSchema列グループスキーマ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ColumnGroupColumnSchemaList

列グループ列のスキーマのリストを含む構造体。

タイプ: 配列インデックス作成ColumnGroupColumnSchema (p. 406)objects

Array Members 最大数は 500 項目です。

: 必須 いいえ名前

列グループスキーマの名前。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

407

ColumnLevelPermissionRule

ColumnLevelPermissionRule1 つ以上の制限された列へのアクセスを許可するために定義されたルール。各データセットは複数のルールを持つことができます。制限付き列を作成するには、その列を 1 つ以上のルールに追加します。各ルールには、少なくとも 1 つの列と 1 つのユーザーまたはグループが含まれている必要があります。制限された列を表示するには、ユーザーまたはグループをその列のルールに追加する必要があります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ColumnNames

列名の配列。

タイプ: 文字列の配列

Array Members 最小項目数は 1 です。

: 必須 いいえプリンシパル

QuickSight ユーザーまたはグループの Amazon リソースネーム (ARN) 配列。

タイプ: 文字列の配列

Array Members 最小項目数は 1 です。最大数は 100 項目です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

408

ColumnSchema

ColumnSchema列スキーマ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

DataType

列スキーマのデータタイプ。

タイプ: 文字列

: 必須 いいえGeographicRole

列スキーマの地理的ロール。

タイプ: 文字列

: 必須 いいえ名前

列スキーマの名前。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

409

ColumnTag

ColumnTag内の列のタグTagColumnOperation (p. 504)構造。これはバリアント型の構造です。この構造体が有効であるためには、属性の 1 つだけが null 以外の値になります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

列の説明

列の説明。

タイプ: ColumnDescription (p. 404) オブジェクト

: 必須 いいえ列地理的役割

列の地理空間ロール。

タイプ: 文字列

有効な値: COUNTRY | STATE | COUNTY | CITY | POSTCODE | LONGITUDE | LATITUDE

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

410

CreateColumnsOperation

CreateColumnsOperation計算列を作成する変換操作。このような操作で作成された列は、字句クロージャを形成します。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

作成する計算列。

タイプ: 配列インデックス作成CalculatedColumn (p. 402)objects

Array Members 最小項目数は 1 です。最大数は 12項目です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

411

CredentialPair

CredentialPair資格情報として使用されるユーザー名とパスワードの組み合わせです。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

パスワード

パスワード: 必須

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 1024 です。

: 必須 はいユーザー名

ユーザー名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

: 必須 はい代替データソースパラメータ

これらの資格情報で共有する代替データソースパラメーターのセット。認証情報は、作成または更新要求を使用してデータソースをコピーするときに、データソースパラメーターと並行して適用されます。API 操作では、DataSourceParameters構造体で、リクエスト内の構造体をAlternateDataSourceParameters許可リスト 構造体が完全に一致する場合、リクエストは既存の認証情報で新しいデータソースを使用できます。そのファイルにAlternateDataSourceParametersリストが null の場合、DataSourceParametersもともとこれらのCredentialsは自動的に許可されます。

タイプ: 配列インデックス作成DataSourceParameters (p. 441)objects

Array Members 最小項目数は 1 です。最大数は 50 項目です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

412

CustomSql

CustomSqlカスタム SQL クエリの結果から構築された物理テーブル型。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

DataSourceArn

データソースの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 はい名前

SQL クエリ結果の表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

: 必須 はいSqlQuery

SQL クエリ。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 65536 です。

: 必須 はい列

SQL クエリ結果セットのカラムスキーマ。

タイプ: 配列インデックス作成InputColumn (p. 459)objects

Array Members 最小項目数は 1 です。最大数は 20項目です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

413

Dashboard

Dashboardダッシュボード:

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

このデータセットが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえDashboardId

ダッシュボード ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえLastPublishedTime

このデータセットが最後に公開された時刻。

タイプ: タイムスタンプ

: 必須 いいえLastUpdatedTime

このデータセットが最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえ名前

ダッシュボードの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえ

414

Dashboard

バージョン

バージョン:

タイプ: DashboardVersion (p. 423) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

415

DashboardError

DashboardErrorダッシュボードエラー。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

メッセージ

メッセージ。

タイプ: 文字列

パターン: .*\S.*

: 必須 いいえタイプ

タイプ。

タイプ: 文字列

有効な値: ACCESS_DENIED | SOURCE_NOT_FOUND | DATA_SET_NOT_FOUND |INTERNAL_FAILURE | PARAMETER_VALUE_INCOMPATIBLE | PARAMETER_TYPE_INVALID |PARAMETER_NOT_FOUND | COLUMN_TYPE_MISMATCH | COLUMN_GEOGRAPHIC_ROLE_MISMATCH| COLUMN_REPLACEMENT_MISSING

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

416

DashboardPublishOptions

DashboardPublishOptionsダッシュボードの公開オプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AdHocFilteringOption

アドホック (ワンタイム) フィルタリングオプション。

タイプ: AdHocFilteringOption (p. 387) オブジェクト

: 必須 いいえExportToCSVOption

.csv にエクスポートオプション。

タイプ: ExportToCSVOption (p. 447) オブジェクト

: 必須 いいえSheetControlsOption

シートコントロールオプション。

タイプ: SheetControlsOption (p. 496) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

417

DashboardSearchFilter

DashboardSearchFilterダッシュボードを検索するときに適用するフィルタ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

演算子

フィルターとして使用する比較演算子 ("Operator": "StringEquals"。

タイプ: 文字列

有効な値: StringEquals

: 必須 はい名前

フィルターとして使用する値の名前 (など)。"Name": "QUICKSIGHT_USER"。

タイプ: 文字列

有効な値: QUICKSIGHT_USER

: 必須 いいえ値

名前付きアイテムの値。この場合はQUICKSIGHT_USERなど、フィルタとして使用したいフィルタです。"Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

418

DashboardSourceEntity

DashboardSourceEntityダッシュボードのソースエンティティ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

SourceTemplate

ソーステンプレート。

タイプ: DashboardSourceTemplate (p. 420) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

419

DashboardSourceTemplate

DashboardSourceTemplateダッシュボードソーステンプレート。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 はいDataSetReferences

データセットリファレンス。

タイプ: 配列インデックス作成DataSetReference (p. 432)objects

Array Members 最小項目数は 1 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

420

DashboardSummary

DashboardSummaryダッシュボードの概要。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

このダッシュボードが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえDashboardId

ダッシュボード ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえLastPublishedTime

このダッシュボードが最後に公開された時刻。

タイプ: タイムスタンプ

: 必須 いいえLastUpdatedTime

このダッシュボードが最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえ名前

ダッシュボードの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえ

421

DashboardSummary

公開バージョン番号

発行されたバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

422

DashboardVersion

DashboardVersionダッシュボードのバージョン。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

このダッシュボードバージョンが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえDataSetArns

このバージョンのダッシュボードに関連付けられているデータセットの Amazon Resource Numbers(ARN)。

タイプ: 文字列の配列

Array Members 最大数は 100 項目です。

: 必須 いいえ説明

説明。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえエラー

このダッシュボードバージョンに関連するエラー。

タイプ: 配列インデックス作成DashboardError (p. 416)objects

Array Members 最小項目数は 1 です。

: 必須 いいえシート

各シートの一意の識別子と名前を持つ、関連するシートのリスト。

タイプ: 配列インデックス作成Sheet (p. 495)objects

Array Members 最大数は 20 項目です。

423

DashboardVersion

: 必須 いいえSourceEntityArn

ソースエンティティ ARN。

タイプ: 文字列

: 必須 いいえステータス

リクエストの HTTP ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

: 必須 いいえThemeArn

ダッシュボードのバージョンに関連付けられたテーマの ARN。

タイプ: 文字列

: 必須 いいえVersionNumber

このバージョンのダッシュボードのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

424

DashboardVersionSummary

DashboardVersionSummaryダッシュボードのバージョンの概要。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

このダッシュボードバージョンが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえ説明

説明。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえSourceEntityArn

ソースエンティティ ARN。

タイプ: 文字列

: 必須 いいえステータス

リクエストの HTTP ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

: 必須 いいえVersionNumber

バージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

425

DashboardVersionSummary

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

426

DataColorPalette

DataColorPaletteグラフのデータの色に使用されるテーマカラーです。色の説明は、# の接頭辞を付けた、6 文字の英数字で構成された 16 進数のカラーコードです (例えば、#37BFF5)。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

カラー

色の 16 進数コード。

タイプ: 文字列の配列

Array Members 最大数は 100 項目です。

パターン: ^#[A-F0-9]{6}$

: 必須 いいえEmptyFillColor

データ不足が強調表示されているグラフに適用される色の 16 進数コード。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえMinMaxGradient

カラーグラデーションを表す最小および最大 16 進数コードです。

タイプ: 文字列の配列

Array Members 最大数は 100 項目です。

パターン: ^#[A-F0-9]{6}$

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

427

DataSet

DataSetデータセット。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 いいえ列グループ

特定の Amazon QuickSight 機能で連携する列のグループ化 現在は、空間階層のみがサポートされます。

タイプ: 配列インデックス作成ColumnGroup (p. 405)objects

Array Members 最小項目数は 1 です。最大数は 8 項目です。

: 必須 いいえ列レベル権限ルール

の 1 つ以上の定義のセット ColumnLevelPermissionRule (p. 408) 。

タイプ: 配列インデックス作成ColumnLevelPermissionRule (p. 408)objects

Array Members 最小項目数は 1 です。

: 必須 いいえファイル容量指定バイト数

このデータセットで使用される SPICE 容量の量。データセットが SPICE にインポートされていない場合、この値は 0 になります。

タイプ: Long

: 必須 いいえCreatedTime

このデータセットが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえデータセット ID

データセットの ID。

タイプ: 文字列

: 必須 いいえ

428

DataSet

フィールドフォルダ

データセットのフィールドとネストされたサブフォルダーを格納するフォルダー。

タイプ: 文字列FieldFolder (p. 448)オブジェクトマップ

キー長制約: 最小長は 1 です。 最大長は 1000 です。

: 必須 いいえインポートモード

データを SPICE にインポートするかどうかを示す値。

タイプ: 文字列

有効な値: SPICE | DIRECT_QUERY

: 必須 いいえLastUpdatedTime

このデータセットが最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえ論理テーブルマップ

物理テーブルからのデータの組み合わせと変換を設定します。

タイプ: 文字列LogicalTable (p. 465)オブジェクトマップ

マップエントリ: 最大数は 64 項目です。

キー長制約: 最小長は 1 です。 最大長は 64 です。

キーパターン:[0-9a-zA-Z-]*

: 必須 いいえ名前

データセットの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 いいえ出力列

すべての変換後の列のリスト。これらの列は、テンプレート、分析、およびダッシュボードで使用できます。

タイプ: 配列インデックス作成OutputColumn (p. 475)objects

: 必須 いいえ物理テーブルマップ

基になるデータソースで使用可能な物理テーブルを宣言します。

タイプ: 文字列PhysicalTable (p. 477)オブジェクトマップ

429

DataSet

マップエントリ: 最大数は 32 項目です。

キー長制約: 最小長は 1 です。 最大長は 64 です。

キーパターン:[0-9a-zA-Z-]*

: 必須 いいえRowlelPermissionデータセット

データセットの行レベルのセキュリティ設定。

タイプ: RowLevelPermissionDataSet (p. 490) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

430

DataSetConfiguration

DataSetConfigurationデータセット設定。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ColumnGroupSchemaList

列グループスキーマのリストを含む構造体。

タイプ: 配列インデックス作成ColumnGroupSchema (p. 407)objects

Array Members 最大数は 500 項目です。

: 必須 いいえDataSetSchema

データセットスキーマ

タイプ: DataSetSchema (p. 433) オブジェクト

: 必須 いいえPlaceholder

プレースホルダー。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

431

DataSetReference

DataSetReferenceデータセットリファレンス。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

DataSetArn

データセット Amazon リソースネーム (ARN)

タイプ: 文字列

: 必須 はいDataSetPlaceholder

データセットのプレースホルダー。

タイプ: 文字列

パターン: .*\S.*

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

432

DataSetSchema

DataSetSchemaデータセットスキーマ

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ColumnSchemaList

列スキーマのリストを含む構造体。

タイプ: 配列インデックス作成ColumnSchema (p. 409)objects

Array Members 最大数は 500 項目です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

433

DataSetSummary

DataSetSummaryデータセットの概要。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

データセットの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえ列レベルの権限ルール適用済み

データセットに列レベルの権限が設定されているかどうかを示す値。

タイプ: ブール値

: 必須 いいえCreatedTime

このデータセットが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえデータセット ID

データセットの ID。

タイプ: 文字列

: 必須 いいえインポートモード

データを SPICE にインポートするかどうかを示す値。

タイプ: 文字列

有効な値: SPICE | DIRECT_QUERY

: 必須 いいえLastUpdatedTime

このデータセットが最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえ名前

データセットの表示名。

タイプ: 文字列

434

DataSetSummary

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 いいえRowlelPermissionデータセット

データセットの行レベルのセキュリティ設定。

タイプ: RowLevelPermissionDataSet (p. 490) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

435

DataSource

DataSourceデータソースの構造。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

代替データソースパラメータ

このデータソースに格納されている資格情報を共有する代替データソースパラメータのセット。認証情報は、作成または更新要求を使用してデータソースをコピーするときに、データソースパラメーターと並行して適用されます。API 操作では、DataSourceParameters構造体で、リクエスト内の構造体をAlternateDataSourceParameters許可リスト 構造体が完全に一致する場合、要求はこの既存のデータソースの資格情報を使用できます。そのファイルにAlternateDataSourceParametersリストが null の場合、Credentialsもともとはこれで使用されたDataSourceParametersは自動的に許可されます。

タイプ: 配列インデックス作成DataSourceParameters (p. 441)objects

Array Members 最小項目数は 1 です。最大数は 50 項目です。

: 必須 いいえArn

データソースの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

このデータソースが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえデータソース ID

データソースの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列

: 必須 いいえデータソースパラメータ

基になるソースに接続するために Amazon QuickSight が使用するパラメータ。これはバリアント型の構造です。この構造体が有効であるためには、属性の 1 つだけが null 以外の値になります。

タイプ: DataSourceParameters (p. 441) オブジェクト

: 必須 いいえErrorInfo

前回の更新またはデータソースの作成からのエラー情報。

タイプ: DataSourceErrorInfo (p. 440) オブジェクト

436

DataSource

: 必須 いいえLastUpdatedTime

このデータソースが最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえ名前

データソースの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 いいえSSLプロパティ

QuickSight が基盤となるソースに接続するときに適用されるセキュアソケットレイヤー (SSL) プロパティ。

タイプ: SslProperties (p. 501) オブジェクト

: 必須 いいえステータス

リクエストの HTTP ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

: 必須 いいえタイプ

データソースの型。このタイプは、データソースが接続するデータベースエンジンを示します。

タイプ: 文字列

有効な値: ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | ATHENA | AURORA |AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | GITHUB | JIRA | MARIADB | MYSQL |ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW |SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TWITTER | TIMESTREAM

: 必須 いいえvPC接続のプロパティ

VPC 接続情報。このパラメーターは、基になるソースに接続するときに QuickSight で VPC 接続を使用する場合にのみ使用する必要があります。

タイプ: VpcConnectionProperties (p. 543) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

437

DataSourceCredentials

DataSourceCredentialsデータソース認証情報。これはバリアント型の構造です。この構造体が有効であるためには、属性の 1 つだけが null 以外の値になります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

コピーソースアーン

使用する証明書ペアがあるデータソースの Amazon リソースネーム (ARN)。メトリックCopySourceArnが null でない場合は、ARN のデータソースの資格情報ペアがDataSourceCredentials構造。

タイプ: 文字列

パターン: ^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+

: 必須 いいえクレデンシャルペア

認証情報のペア。詳細については、「CredentialPair (p. 412)」を参照してください。

タイプ: CredentialPair (p. 412) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

439

DataSourceErrorInfo

DataSourceErrorInfoデータソースの作成または更新のエラー情報。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

メッセージ

Error message.

タイプ: 文字列

: 必須 いいえタイプ

のエラーのタイプ

タイプ: 文字列

有効な値: ACCESS_DENIED | COPY_SOURCE_NOT_FOUND | TIMEOUT |ENGINE_VERSION_NOT_SUPPORTED | UNKNOWN_HOST | GENERIC_SQL_FAILURE | CONFLICT| UNKNOWN

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

440

DataSourceParameters

DataSourceParameters基になるデータソースに接続するために Amazon QuickSight が使用するパラメータ。これはバリアント型の構造です。この構造体が有効であるためには、属性の 1 つだけが null 以外の値になります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AmazonElastic検索パラメータ

Amazon Elasticsearch Service パラメータ

タイプ: AmazonElasticsearchParameters (p. 388) オブジェクト

: 必須 いいえアテネパラメーター

Amazon Athena パラメータ。

タイプ: AthenaParameters (p. 397) オブジェクト

: 必須 いいえオーロラパラメーター

Amazon Aurora MySQL パラメータ。

タイプ: AuroraParameters (p. 398) オブジェクト

: 必須 いいえオーロラポストグレスクルパラメータ

Aurora PostgreSQL パラメータです。

タイプ: AuroraPostgreSqlParameters (p. 399) オブジェクト

: 必須 いいえAWSIOTanalyticSparameters

AWS IoT Analytics パラメータ。

タイプ: AwsIotAnalyticsParameters (p. 400) オブジェクト

: 必須 いいえジラパラメーター

Jira パラメータ。

タイプ: JiraParameters (p. 461) オブジェクト

: 必須 いいえマリアDBパラメーター

MariaDB のパラメータ

タイプ: MariaDbParameters (p. 469) オブジェクト

441

DataSourceParameters

: 必須 いいえMySQLパラメータ

MySQL のパラメータ。

タイプ: MySqlParameters (p. 470) オブジェクト

: 必須 いいえOracleパラメータ

Oracle のパラメータ。

タイプ: OracleParameters (p. 474) オブジェクト

: 必須 いいえPostgreSQL パラメータ

PostgreSQL パラメータです。

タイプ: PostgreSqlParameters (p. 478) オブジェクト

: 必須 いいえプレストパラメーター

Presto のパラメータ。

タイプ: PrestoParameters (p. 479) オブジェクト

: 必須 いいえRDSパラメーター

Amazon RDS パラメーター。

タイプ: RdsParameters (p. 482) オブジェクト

: 必須 いいえRedShiftParameters

Amazon Redshift パラメータ。

タイプ: RedshiftParameters (p. 483) オブジェクト

: 必須 いいえパラメーター

S3 パラメータです。

タイプ: S3Parameters (p. 492) オブジェクト

: 必須 いいえサービスNOWパラメータ

ServiceNow パラメーター。

タイプ: ServiceNowParameters (p. 494) オブジェクト

: 必須 いいえスノーフレークパラメータ

雪片のパラメータ。

442

DataSourceParameters

タイプ: SnowflakeParameters (p. 498) オブジェクト

: 必須 いいえスパークパラメータ

Spark パラメータ。

タイプ: SparkParameters (p. 499) オブジェクト

: 必須 いいえSQLサーバーパラメータ

SQL Server パラメーター。

タイプ: SqlServerParameters (p. 500) オブジェクト

: 必須 いいえテラタパラメーター

Teradata パラメータ。

タイプ: TeradataParameters (p. 518) オブジェクト

: 必須 いいえTwitterパラメーター

Twitter のパラメーター

タイプ: TwitterParameters (p. 534) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

443

DateTimeParameter

DateTimeParameter日時パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

名前

日時パラメータの表示名。

タイプ: 文字列

パターン: .*\S.*

: 必須 はい値

日時パラメータの値。

タイプ: タイムスタンプの配列

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

444

DecimalParameter

DecimalParameter10 進数パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

名前

10 進数パラメータの表示名。

タイプ: 文字列

パターン: .*\S.*

: 必須 はい値

10 進数パラメータの値。

タイプ: 倍精度浮動小数点数の配列

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

445

ErrorInfo

ErrorInfoデータセットの SPICE 取り込みのエラー情報。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

メッセージ

Error message.

タイプ: 文字列

: 必須 いいえタイプ

のエラーのタイプ

タイプ: 文字列

有効な値: FAILURE_TO_ASSUME_ROLE | INGESTION_SUPERSEDED | INGESTION_CANCELED| DATA_SET_DELETED | DATA_SET_NOT_SPICE | S3_UPLOADED_FILE_DELETED |S3_MANIFEST_ERROR | DATA_TOLERANCE_EXCEPTION | SPICE_TABLE_NOT_FOUND| DATA_SET_SIZE_LIMIT_EXCEEDED | ROW_SIZE_LIMIT_EXCEEDED |ACCOUNT_CAPACITY_LIMIT_EXCEEDED | CUSTOMER_ERROR | DATA_SOURCE_NOT_FOUND| IAM_ROLE_NOT_AVAILABLE | CONNECTION_FAILURE | SQL_TABLE_NOT_FOUND |PERMISSION_DENIED | SSL_CERTIFICATE_VALIDATION_FAILURE | OAUTH_TOKEN_FAILURE| SOURCE_API_LIMIT_EXCEEDED_FAILURE | PASSWORD_AUTHENTICATION_FAILURE |SQL_SCHEMA_MISMATCH_ERROR | INVALID_DATE_FORMAT | INVALID_DATAPREP_SYNTAX |SOURCE_RESOURCE_LIMIT_EXCEEDED | SQL_INVALID_PARAMETER_VALUE | QUERY_TIMEOUT| SQL_NUMERIC_OVERFLOW | UNRESOLVABLE_HOST | UNROUTABLE_HOST | SQL_EXCEPTION| S3_FILE_INACCESSIBLE | IOT_FILE_NOT_FOUND | IOT_DATA_SET_FILE_EMPTY| INVALID_DATA_SOURCE_CONFIG | DATA_SOURCE_AUTH_FAILED |DATA_SOURCE_CONNECTION_FAILED | FAILURE_TO_PROCESS_JSON_FILE |INTERNAL_SERVICE_ERROR

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

446

ExportToCSVOption

ExportToCSVOption.csv にエクスポートオプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AvailabilityStatus

アベイラビリティーステータス。

タイプ: 文字列

有効な値: ENABLED | DISABLED

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

447

FieldFolder

FieldFolderFieldFolder 要素は、フィールドとネストされたサブフォルダを含むフォルダです。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

columns

フォルダには列のリストがあります。1 つの列は、1 つのフォルダにのみ配置できます。

タイプ: 文字列の配列

Array Members 最大数は 500項目です。

: 必須 いいえdescription

フィールドフォルダの説明。

タイプ: 文字列

長さの制約: 最大長は 500 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

448

FilterOperation

FilterOperation条件に基づいて行をフィルタする変換操作。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ConditionExpression

ブール値に評価する必要がある式。式が true と評価される行は、データセット内に保持されます。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 4096 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

449

GeoSpatialColumnGroup

GeoSpatialColumnGroup階層を示す空間列グループ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

この階層の列

タイプ: 文字列の配列

Array Members 最小項目数は 1 です。最大数は 16 項目です。

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はいCountryCode

国コード。

タイプ: 文字列

有効な値: US

: 必須 はい名前

階層の表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

450

Group

GroupAグループは、一連のユーザーで構成されています。グループを使用すると、アクセスとセキュリティの管理が簡単になります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

グループの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえ説明

グループの説明。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえGroupName

グループの名前。

タイプ: 文字列

長さの制約: 最小長は 1 です。

パターン: [\u0020-\u00FF]+

: 必須 いいえPrincipalId

グループのプリンシパル ID。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

451

GroupMember

GroupMemberAmazon QuickSight グループのメンバー。現在、グループメンバーはユーザーである必要があります。グループを別のグループのメンバーにすることはできません。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

グループメンバー (ユーザー) の Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえmembName

グループメンバー (ユーザー) の名前。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 256 です。

パターン: [\u0020-\u00FF]+

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

452

GutterStyle

GutterStyleシート上のタイル間のガーターのスペースの表示オプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Show

このブール値は、シートタイルの間にガータースペースを表示するかどうかを制御します。

タイプ: ブール値

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

453

IAMPolicyAssignment

IAMPolicyAssignmentAWS Identity and Access Management (IAM) ポリシー割り当て。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

割り当てID

割り当て ID。

タイプ: 文字列

: 必須 いいえ割り当て名

割り当て名。

タイプ: 文字列

長さの制限: 最小長は 1 です。

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$

: 必須 いいえAssignmentStatus

割り当てステータス。

タイプ: 文字列

有効な値: ENABLED | DRAFT | DISABLED

: 必須 いいえAwsAccountId

AWS アカウント ID。

タイプ: 文字列

長さの制限: 固定長 12。

パターン: ^[0-9]{12}$

: 必須 いいえID

アイデンティティ

タイプ: 文字列から文字列の配列へのマッピング

長さの制限: 最小長は 1 です。

パターン: [\u0020-\u00FF]+

: 必須 いいえ

454

IAMPolicyAssignment

PolicyArn

IAM ポリシーの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

455

IAMPolicyAssignmentSummary

IAMPolicyAssignmentSummaryIAM ポリシー割り当ての概要。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

割り当て名

割り当て名。

タイプ: 文字列

長さの制限: 最小長は 1 です。

パターン: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$

: 必須 いいえAssignmentStatus

割り当てステータス。

タイプ: 文字列

有効な値: ENABLED | DRAFT | DISABLED

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

456

Ingestion

Ingestionデータセットの SPICE 取り込みに関する情報。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 はいCreatedTime

この摂取が開始された時刻。

タイプ: タイムスタンプ

: 必須 はい取り込みステータス

取り込みステータス。

タイプ: 文字列

有効な値: INITIALIZED | QUEUED | RUNNING | FAILED | COMPLETED | CANCELLED

: 必須 はいErrorInfo

この取り込みのエラー情報。

タイプ: ErrorInfo (p. 446) オブジェクト

: 必須 いいえ取り込み ID

取り込み ID。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

パターン: ^[a-zA-Z0-9-_]+$

: 必須 いいえ取り込みサイズ (バイト)

取り込まれたデータのサイズ(バイト単位)。

タイプ: Long

: 必須 いいえ

457

Ingestion

インジェクション・タイムイン秒

この取り込みにかかった時間(秒単位)。

タイプ: Long

: 必須 いいえQueueInfo

キューに入れられたデータセットの SPICE 取り込みに関する情報。

タイプ: QueueInfo (p. 481) オブジェクト

: 必須 いいえリクエストソース

この取り込みのイベントソース。

タイプ: 文字列

有効な値: MANUAL | SCHEDULED

: 必須 いいえRequestType

この取り込みのタイプ。

タイプ: 文字列

有効な値: INITIAL_INGESTION | EDIT | INCREMENTAL_REFRESH | FULL_REFRESH

: 必須 いいえローウィンフォ

データセットの SPICE 取り込みの行に関する情報。

タイプ: RowInfo (p. 489) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

458

InputColumn

InputColumn変換操作の入力として使用される列のメタデータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

名前

基盤になるデータソースのこの列の名前。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

: 必須 はいタイプ

列のデータ型。

タイプ: 文字列

有効な値: STRING | INTEGER | DECIMAL | DATETIME | BIT | BOOLEAN | JSON

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

459

IntegerParameter

IntegerParameter整数パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

名前

整数パラメータの名前。

タイプ: 文字列

パターン: .*\S.*

: 必須 はい値

整数パラメータの値。

タイプ: 長整数配列

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

460

JiraParameters

JiraParametersJira パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

サイトベースURL

Jira サイトのベース URL。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 1024 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

461

JoinInstruction

JoinInstruction結合に関連付けられた指示。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

レフトーパーランド

結合の左側にあるオペランド。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 64 です。

パターン: [0-9a-zA-Z-]*

: 必須 はいオン句

「」セクションで説明している結合手順ON句を使用します。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 512 です。

: 必須 はい右ペランド

結合の右側にあるオペランド。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 64 です。

パターン: [0-9a-zA-Z-]*

: 必須 はいタイプ

結合の結合のタイプ。

タイプ: 文字列

有効な値: INNER | OUTER | LEFT | RIGHT

: 必須 はい左ジョインキーのプロパティ

左のオペランドの結合キープロパティ。

タイプ: JoinKeyProperties (p. 464) オブジェクト

: 必須 いいえ右ジョインキーのプロパティ

右のオペランドの主要なプロパティを結合します。

462

JoinInstruction

タイプ: JoinKeyProperties (p. 464) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

463

JoinKeyProperties

JoinKeyProperties結合に関与する列に関連付けられたプロパティ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ユニークキー

テーブル内の行が、結合キーの列によって一意に識別されることを示す値。これは、QuickSight によってクエリのパフォーマンスを最適化するために使用されます。

タイプ: ブール値

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

464

LogicalTable

LogicalTableA論理テーブルは、結合し、データ変換が動作する単位です。論理テーブルにはソースがあり、物理テーブルまたは結合の結果のいずれかになります。論理テーブルが物理テーブルを指している場合、論理テーブルは、変換操作によってその物理テーブルの変更可能なコピーとして機能します。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

エイリアス

論理テーブルの表示名。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 64 です。

: 必須 はい送信元

この論理テーブルのソース。

タイプ: LogicalTableSource (p. 466) オブジェクト

: 必須 はいデータランズフォーム

この論理テーブルに作用する変換操作。

タイプ: 配列インデックス作成TransformOperation (p. 532)objects

Array Members 最小項目数は 1 です。最大数は 20項目です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

465

LogicalTableSource

LogicalTableSource論理テーブルのソースに関する情報。これはバリアント型の構造です。この構造体が有効であるためには、属性の 1 つだけが null 以外の値になります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ジョイン指示

2 つの論理テーブルを結合した結果を指定します。

タイプ: JoinInstruction (p. 462) オブジェクト

: 必須 いいえ物理テーブル ID

物理テーブル ID。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 64 です。

パターン: [0-9a-zA-Z-]*

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

466

ManifestFileLocation

ManifestFileLocationAmazon S3 マニフェストファイルの場所。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

バケット

Amazon S3 バケット。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 1024 です。

: 必須 はいキー

オブジェクトを識別する Amazon S3 キー。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 1024 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

467

MarginStyle

MarginStyleシートの外縁の余白の表示オプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Show

このブール値は、シートの余白を表示するかどうかを制御します。

タイプ: ブール値

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

468

MariaDbParameters

MariaDbParametersMariaDB のパラメータです。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

469

MySqlParameters

MySqlParametersMySQL のパラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

470

NamespaceError

NamespaceError名前空間の作成中に発生するエラー。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

メッセージ

エラーのメッセージ。

タイプ: 文字列

: 必須 いいえタイプ

エラータイプ。

タイプ: 文字列

有効な値: PERMISSION_DENIED | INTERNAL_SERVICE_ERROR

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

471

NamespaceInfoV2

NamespaceInfoV2エラータイプ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

名前空間 ARN。

タイプ: 文字列

: 必須 いいえ容量リージョン

名前空間 AWS リージョン。

タイプ: 文字列

: 必須 いいえ作成ステータス

まだ完全に作成されていないネームスペースの作成ステータス。

タイプ: 文字列

有効な値: CREATED | CREATING | DELETING | RETRYABLE_FAILURE |NON_RETRYABLE_FAILURE

: 必須 いいえアイデンティティーストア

名前空間に使用される ID ストア。

タイプ: 文字列

有効な値: QUICKSIGHT

: 必須 いいえ名前

エラーの名前。

タイプ: 文字列

長さの制限: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 いいえ名前空間エラー

名前空間が作成されたときに発生したエラー。

タイプ: NamespaceError (p. 471) オブジェクト

472

NamespaceInfoV2

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

473

OracleParameters

OracleParametersOracle のパラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

Oracleホスト

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

474

OutputColumn

OutputColumn出力列

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

説明

列の説明。

タイプ: 文字列

長さの制限: 最小長は 0 です。最大長は 500 です。

: 必須 いいえ名前

データセットの表示名。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

: 必須 いいえタイプ

タイプ。

タイプ: 文字列

有効な値: STRING | INTEGER | DECIMAL | DATETIME

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

475

Parameters

ParametersQuickSight パラメータのリストとリストのオーバーライド値。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

DateTimeParameters

日時パラメータ。

タイプ: 配列インデックス作成DateTimeParameter (p. 444)objects

Array Members 最大数は 100 項目です。

: 必須 いいえDecimalParameters

10 進数パラメータ。

タイプ: 配列インデックス作成DecimalParameter (p. 445)objects

Array Members 最大数は 100 項目です。

: 必須 いいえIntegerParameters

整数パラメータ。

タイプ: 配列インデックス作成IntegerParameter (p. 460)objects

Array Members 最大数は 100 項目です。

: 必須 いいえStringParameters

文字列パラメータ。

タイプ: 配列インデックス作成StringParameter (p. 502)objects

Array Members 最大数は 100 項目です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

476

PhysicalTable

PhysicalTable基になるソースのデータの形状に関する情報を含むデータソースのビュー。これはバリアント型の構造です。この構造体が有効であるためには、属性の 1 つだけが null 以外の値になります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

カスタムSQL

カスタム SQL クエリの結果から構築された物理テーブル型。

タイプ: CustomSql (p. 413) オブジェクト

: 必須 いいえリレーションテーブル

リレーショナル・データ・ソースの物理テーブル・タイプ。

タイプ: RelationalTable (p. 485) オブジェクト

: 必須 いいえSource

S3 データソースとしての物理テーブルタイプ。

タイプ: S3Source (p. 493) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

477

PostgreSqlParameters

PostgreSqlParametersPostgreSQL パラメータです。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

478

PrestoParameters

PrestoParametersPresto のパラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

カタログ

カタログ:

タイプ: 文字列

長さの制限: 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

479

ProjectOperation

ProjectOperation列を投影する変換操作。投影後の操作は、投影された列のみを参照できます。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

投影された列

投影された列。

タイプ: 文字列の配列

Array Members 最小項目数は 1 です。最大数は 2000 項目です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

480

QueueInfo

QueueInfoキューに入れられたデータセットの SPICE 取り込みに関する情報。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

キューイング

進行中の摂取の ID。キューに入れられた取り込みは、進行中の取り込みが完了するのを待機しています。

タイプ: 文字列

: 必須 はい待機中

キューに入れられたインジェストの ID。

タイプ: 文字列

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

481

RdsParameters

RdsParametersAmazon RDS パラメーター。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

: 必須 はいInstanceId

インスタンス ID。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 64 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

482

RedshiftParameters

RedshiftParametersAmazon Redshift パラメータ。-ClusterIdフィールドは空白にすることができます。HostおよびPortが両方とも設定されている。-HostおよびPortフィールドは空白にすることができます。ClusterIdフィールドが設定されている場合の。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 128 です。

: 必須 はいClusterId

クラスター ID。このフィールドは、HostおよびPortが提供される。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 64 です。

: 必須 いいえHost

ホスト。このフィールドは空白にすることができます。ClusterIdはにあります。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 256 です。

: 必須 いいえポート

[ポート] 。このフィールドは、ClusterIdはにあります。

タイプ: 整数

有効範囲: 最小値は 0 です。最大値は 65535 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2

483

RelationalTable

RelationalTableリレーショナル・データ・ソースの物理テーブル・タイプ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

DataSourceArn

データソースの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 はい入力列

テーブルの列スキーマ。

タイプ: 配列インデックス作成InputColumn (p. 459)objects

Array Members 最小項目数は 1 です。最大数は 20項目です。

: 必須 はい名前

リレーショナルテーブルの名前。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 64 です。

: 必須 はいカタログ

テーブルに関連付けられたカタログ。

タイプ: 文字列

長さの制約: 最大長は 256 です。

: 必須 いいえスキーマ

スキーマ名。この名前は、特定のリレーショナルデータベースエンジンに適用されます。

タイプ: 文字列

長さの制約: 最大長は 64 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

485

RenameColumnOperation

RenameColumnOperation列の名前を変更する変換操作。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ColumnName

名前を変更する列の名前。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい新しい列名

列の新しい名前。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

487

ResourcePermission

ResourcePermissionリソースに対するアクセス許可。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

アクション

アクセス許可を付与または取り消す IAM アクション。

タイプ: 文字列の配列

Array Members 最小項目数は 1 です。最大数は 16 項目です。

: 必須 はいプリンシパル

プリンシパルの Amazon リソースネーム (ARN)。これには、次のいずれかを指定できます。• データソースまたはデータセットに関連付けられた Amazon QuickSight ユーザーまたはグループの

ARN。(こちらが普通です)。• 分析、ダッシュボード、テンプレート、またはテーマに関連付けられた Amazon QuickSight ユー

ザー、グループ、または名前空間のARN。(こちらが普通です)。• AWS アカウントのルートの ARN これは、QuickSight ARN ではなく IAM ARN です。このオプショ

ンは、AWS アカウント間でリソース(テンプレート)を共有する場合にのみ使用します。(こちらはそれほど一般的ではありません)。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 256 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

488

RowInfo

RowInfoデータセットの SPICE 取り込みの行に関する情報。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

行ドロップ

取り込まれていない行の数。

タイプ: Long

: 必須 いいえ行採用

取り込まれた行の数。

タイプ: Long

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

489

RowLevelPermissionDataSet

RowLevelPermissionDataSet行レベルのセキュリティ (RLS) アクセス許可を含むデータセットに関する情報。権限データセットは、フィールドをユーザーまたはグループにマッピングします。詳細については、「」を参照してください。行レベルセキュリティ (RLS) を使用したデータセットへのアクセスの制限()Amazon QuickSight ユーザーガイド。

設定することにより、アクセス許可を拒否するオプションPermissionPolicy~DENY_ACCESSは、新しい RLS データセットではサポートされていません。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

RLS のアクセス許可を含むデータセットの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 はいPermissionPolicy

RLS のアクセス許可を解釈するときに使用するアクセス許可のタイプ。DENY_ACCESS下位互換性の目的でのみ用意されています。

タイプ: 文字列

有効な値: GRANT_ACCESS | DENY_ACCESS

: 必須 はいFormatVersion

RLS の権限を含むデータセットに関連付けられたユーザーまたはグループのルール。

デフォルトでは、FormatVersion は VERSION_1 です。メトリックFormatVersion、VERSION_1,UserNameおよびGroupNameは必須です。メトリックFormatVersion、VERSION_2,UserARNおよびGroupARNは必須であり、Namespaceが存在してはなりません。

タイプ: 文字列

有効な値: VERSION_1 | VERSION_2

: 必須 いいえ名前空間

RLS のアクセス許可を含むデータセットに関連付けられた名前空間。

タイプ: 文字列

長さの制約: 最大長は 64 です。

パターン: ^[a-zA-Z0-9._-]*$

: 必須 いいえ

490

RowLevelPermissionDataSet

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

491

S3Parameters

S3ParametersS3 パラメータです。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

マニフェストファイルロケーション

Amazon S3 マニフェストファイルの場所。マニフェストファイルがコンソールにアップロードされた場合、これは NULL です。

タイプ: ManifestFileLocation (p. 467) オブジェクト

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

492

S3Source

S3SourceS3 データソースとしての物理テーブルタイプ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

DataSourceArn

データソースの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 はい入力列

S3 データソースとしての物理テーブルタイプ。

タイプ: 配列インデックス作成InputColumn (p. 459)objects

Array Members 最小項目数は 1 です。最大数は 20項目です。

: 必須 はいアップロード設定

S3 ソースファイルの形式に関する情報。

タイプ: UploadSettings (p. 538) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

493

ServiceNowParameters

ServiceNowParametersServiceNow パラメーター。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

サイトベースURL

ベースサイトの URL。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 1024 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

494

Sheet

Sheetシートは、Amazon QuickSight コンソールの 1 ページにまとめて表示される一連のビジュアルを含むオブジェクトです。すべての分析とダッシュボードには、少なくとも 1 枚のシートが含まれています。各シートには、グラフ、ピボットテーブルや説明的なインサイトなど、少なくとも 1 つの視覚化ウィジェットが含まれています。シートは、コントロール、フィルタなどの他のコンポーネントに関連付けることができます。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

名前

シートの名前。この名前は、QuickSight コンソールのシートのタブに表示されます。

タイプ: 文字列

パターン: .*\S.*

: 必須 いいえSheetId

このシートに関連付けられた一意の識別子。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

495

SheetControlsOption

SheetControlsOptionシートコントロールオプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

VisibilityState

可視性の状態。

タイプ: 文字列

有効な値: EXPANDED | COLLAPSED

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

496

SheetStyle

SheetStyleシートのテーマ表示オプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Tile

タイルの表示オプション。

タイプ: TileStyle (p. 531) オブジェクト

: 必須 いいえTileLayout

タイルのレイアウトオプション。

タイプ: TileLayoutStyle (p. 530) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

497

SnowflakeParameters

SnowflakeParameters雪片のパラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 256 です。

: 必須 はいウェアハウス

ウェアハウス

タイプ: 文字列

長さの制約: 最大長は 128 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

498

SparkParameters

SparkParametersSpark パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Host

ホスト。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

499

SqlServerParameters

SqlServerParametersSQL Server パラメーター。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

500

SslProperties

SslPropertiesQuickSight が基になるデータソースに接続するときに適用されるセキュアソケットレイヤー (SSL) プロパティ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ディスエーブルスル

SSL を無効にするかどうかを制御するブール型オプション。

タイプ: ブール値

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

501

StringParameter

StringParameter文字列パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

名前

文字列パラメータの表示名。

タイプ: 文字列

パターン: .*\S.*

: 必須 はい値

文字列パラメータの値。

タイプ: 文字列の配列

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

502

Tag

Tagリソースに割り当てられたリソースタグのキーと値のペアのキーです。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

キー

タグキー。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はい値

タグ値

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 256 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

503

TagColumnOperation

TagColumnOperation列に追加情報をタグ付けする変換操作。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ColumnName

この操作が作用する列。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はいタグ

データセット列タグ。現在、空間タイプのタグ付けにのみ使用されます。

Note

これは AWS タグ付け機能のタグではありません。

タイプ: 配列インデックス作成ColumnTag (p. 410)objects

Array Members 最小項目数は 1 です。最大数は 16 項目です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

504

Template

Templateテンプレートオブジェクト。AテンプレートQuickSight のエンティティで、分析の作成に必要なメタデータをカプセル化し、ダッシュボードの作成に使用できます。テンプレートは、プレースホルダーを使用して分析に関連付けられたデータセットを置き換えることにより、抽象レイヤーを追加します。データセットプレースホルダーをソース分析およびテンプレートの作成に使用したのと同じスキーマに従うデータセットに置き換えることにより、テンプレートを使用してダッシュボードを作成できます。

他の AWS アカウントのユーザーが既存のテンプレートからテンプレートまたはダッシュボードを作成できるようにすることで、AWS アカウント間でテンプレートを共有できます。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

テンプレートの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

これが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえLastUpdatedTime

これが最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえ名前

テンプレートの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえTemplateId

テンプレートの ID。これは、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえ

505

Template

バージョン

テンプレートのバージョンを記述する構造体。

タイプ: TemplateVersion (p. 514) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

506

TemplateAlias

TemplateAliasテンプレートのエイリアス。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AliasName

テンプレートエイリアスの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 いいえArn

テンプレートエイリアスの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえテンプレートバージョン番号

テンプレートエイリアスのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

507

TemplateError

TemplateErrorテンプレートバージョンの作成に失敗したときに発生したエラーのリスト。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

メッセージ

エラータイプの説明。

タイプ: 文字列

パターン: .*\S.*

: 必須 いいえタイプ

エラーのタイプ。

タイプ: 文字列

有効な値: SOURCE_NOT_FOUND | DATA_SET_NOT_FOUND | INTERNAL_FAILURE |ACCESS_DENIED

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

508

TemplateSourceAnalysis

TemplateSourceAnalysisテンプレートのソース分析。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 はいDataSetReferences

テンプレートでプレースホルダーとして使用されるデータセットリファレンスに関する情報を含む構造体。

タイプ: 配列インデックス作成DataSetReference (p. 432)objects

Array Members 最小項目数は 1 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

509

TemplateSourceEntity

TemplateSourceEntityテンプレートのソースエンティティ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

SourceAnalysis

ソース分析 (分析に基づいている場合)。

タイプ: TemplateSourceAnalysis (p. 509) オブジェクト

: 必須 いいえSourceTemplate

ソーステンプレート (テンプレートに基づいている場合)。

タイプ: TemplateSourceTemplate (p. 511) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

510

TemplateSourceTemplate

TemplateSourceTemplateテンプレートのソーステンプレート。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

511

TemplateSummary

TemplateSummaryテンプレートの概要です。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

テンプレートの概要。

タイプ: 文字列

: 必須 いいえCreatedTime

このテンプレートが最後に作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえLastUpdatedTime

このテンプレートが最後に更新された時刻。

タイプ: タイムスタンプ

: 必須 いいえLatestVersionNumber

テンプレートの概要のバージョン番号のリストを含む構造体。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ名前

テンプレートの表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえTemplateId

テンプレートの ID。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえ

512

TemplateSummary

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

513

TemplateVersion

TemplateVersionテンプレートのバージョン。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

CreatedTime

このテンプレートバージョンが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえDataSetConfigurations

プレースホルダーによって識別されるデータセットのスキーマ。このテンプレートから作成されたダッシュボードは、この API オペレーションで記述されたスキーマと同じスキーマに一致する新しいデータセットにバインドする必要があります。

タイプ: 配列インデックス作成DataSetConfiguration (p. 431)objects

Array Members 最大数は 30 項目です。

: 必須 いいえ説明

テンプレートの説明。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえエラー

このテンプレートバージョンに関連するエラー。

タイプ: 配列インデックス作成TemplateError (p. 508)objects

Array Members 最小項目数は 1 です。

: 必須 いいえシート

各シートの一意の識別子と名前を持つ、関連するシートのリスト。

タイプ: 配列インデックス作成Sheet (p. 495)objects

配列メンバ: 最大数は 20 項目です。

: 必須 いいえSourceEntityArn

このテンプレートの作成に使用された分析またはテンプレートの Amazon リソースネーム (ARN)。

514

TemplateVersion

タイプ: 文字列

: 必須 いいえステータス

リクエストの HTTP ステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

: 必須 いいえThemeArn

このバージョンのテンプレートに関連付けられているテーマの ARN。

タイプ: 文字列

: 必須 いいえVersionNumber

テンプレートバージョンのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

515

TemplateVersionSummary

TemplateVersionSummaryテンプレートのバージョン。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

テンプレートバージョンの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

このテンプレートバージョンが作成された時刻。

タイプ: タイムスタンプ

: 必須 いいえ説明

テンプレートバージョンの説明。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえステータス

テンプレートバージョンのステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

: 必須 いいえVersionNumber

テンプレートバージョンのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

516

TeradataParameters

TeradataParametersTeradata パラメータ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

データベース

データベース。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 128 です。

: 必須 はいHost

ホスト。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 256 です。

: 必須 はいポート

[ポート] 。

タイプ: 整数

有効範囲: 最小値は 1 です。最大値は 65535 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

518

Theme

Themeテーマに関する概要情報。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

テーマの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

テーマが作成された日時。

タイプ: タイムスタンプ

: 必須 いいえLastUpdatedTime

テーマが最後に更新された日時。

タイプ: タイムスタンプ

: 必須 いいえ名前

ユーザーがテーマに付ける名前。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえThemeId

ユーザーがテーマに与える識別子。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえタイプ

主題のタイプ。作成方法に基づきます。有効な値には、QUICKSIGHT や CUSTOM などがあります。

タイプ: 文字列

有効な値: QUICKSIGHT | CUSTOM | ALL

: 必須 いいえ

519

Theme

バージョン

テーマのバージョン。

タイプ: ThemeVersion (p. 526) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

520

ThemeAlias

ThemeAliasテーマのエイリアス。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

AliasName

テーマ別名の表示名。

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

: 必須 いいえArn

テーマエイリアスの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえテーマEversionNumber

テーマエイリアスのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

521

ThemeConfiguration

ThemeConfigurationテーマの設定。この設定には、テーマのすべての表示プロパティが含まれます。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

DataColorPalette

グラフデータの色に適用される色プロパティ。

タイプ: DataColorPalette (p. 427) オブジェクト

: 必須 いいえシート

シートに関連するオプションを表示します。

タイプ: SheetStyle (p. 497) オブジェクト

: 必須 いいえUIColorPalette

UI およびグラフに適用される色プロパティ (データに適用される色を除く)。

タイプ: UIColorPalette (p. 535) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

522

ThemeError

ThemeErrorテーマエラー。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

メッセージ

エラーメッセージ。

タイプ: 文字列

パターン: .*\S.*

: 必須 いいえタイプ

エラーのタイプ。

タイプ: 文字列

有効な値: INTERNAL_FAILURE

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java バージョン 2• AWS SDK for Ruby v3

523

ThemeSummary

ThemeSummaryテーマの概要。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

このテーマが作成された日時。

タイプ: タイムスタンプ

: 必須 いいえLastUpdatedTime

このテーマが更新された最終日時。

タイプ: タイムスタンプ

: 必須 いいえLatestVersionNumber

テーマの最新バージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ名前

テーマの表示名

タイプ: 文字列

長さの制約: 最小長は 1 です。 最大長は 2048 です。

: 必須 いいえThemeId

テーマの ID です。この ID は、各 AWS アカウントの AWS リージョンごとに一意です。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえ

524

ThemeSummary

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

525

ThemeVersion

ThemeVersionテーマのバージョン。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

リソースの Amazon リソース名 (ARN)。

タイプ: 文字列

: 必須 いいえBaseThemeId

カスタムテーマが継承するテーマの Amazon QuickSight で定義された ID。すべてのテーマは、最初は既定の QuickSight テーマから継承されます。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 2048 です。

パターン: [\w\-]+

: 必須 いいえ設定

すべてのテーマ表示プロパティを含むテーマ設定。

タイプ: ThemeConfiguration (p. 522) オブジェクト

: 必須 いいえCreatedTime

このテーマバージョンが作成された日時。

タイプ: タイムスタンプ

: 必須 いいえ説明

テーマの説明。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえエラー

テーマに関連するエラー。

タイプ: 配列インデックス作成ThemeError (p. 523)objects

配列メンバ: 最小項目数は 1 です。

526

ThemeVersion

: 必須 いいえステータス

テーマバージョンのステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

: 必須 いいえVersionNumber

テーマのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

527

ThemeVersionSummary

ThemeVersionSummaryテーマバージョン。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Arn

テーマバージョンの Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 いいえCreatedTime

このテーマバージョンが作成された日時。

タイプ: タイムスタンプ

: 必須 いいえ説明

テーマバージョンの説明。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 512 です。

: 必須 いいえステータス

テーマバージョンのステータス。

タイプ: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED |UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

: 必須 いいえVersionNumber

テーマバージョンのバージョン番号。

タイプ: Long

有効範囲: 最小値は 1 です。

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

528

TileLayoutStyle

TileLayoutStyleシート上のタイルのレイアウトの表示オプション。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

Gutter (ガーター)

タイル間に適用されるガーターの設定。

タイプ: GutterStyle (p. 453) オブジェクト

: 必須 いいえマージン

シートの外端に適用されるマージンの設定。

タイプ: MarginStyle (p. 468) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

530

TileStyle

TileStyleシート上のタイルに関連するオプションを表示します。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ボーダー

タイルの周囲の境界線。

タイプ: BorderStyle (p. 401) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

531

TransformOperation

TransformOperation論理テーブルのデータ変換。これはバリアント型の構造です。この構造体が有効であるためには、属性の1 つだけが null 以外の値になります。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

キャスト列タイプオペレーション

列を別の型にキャストする変換操作。

タイプ: CastColumnTypeOperation (p. 403) オブジェクト

: 必須 いいえ列の作成オペレーション

計算列を作成する操作。このような操作で作成された列は、字句クロージャを形成します。

タイプ: CreateColumnsOperation (p. 411) オブジェクト

: 必須 いいえフィルタ処理

何らかの条件に基づいて行をフィルタリングする操作。

タイプ: FilterOperation (p. 449) オブジェクト

: 必須 いいえプロジェクト・オペレーション#プロジェクト#

列を投影する操作。投影後の操作は、投影された列のみを参照できます。

タイプ: ProjectOperation (p. 480) オブジェクト

: 必須 いいえ名前変更ColumnOperation

列の名前を変更する操作。

タイプ: RenameColumnOperation (p. 487) オブジェクト

: 必須 いいえタグ列オペレーション

列に追加情報をタグ付けする操作。

タイプ: TagColumnOperation (p. 504) オブジェクト

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

532

TwitterParameters

TwitterParametersTwitter パラメーター。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

最大行数

Twitter にクエリする行の最大数。

タイプ: 整数

有効範囲: 最小値は 1 です。

: 必須 はいQuery

Twitter クエリ文字列。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 256 です。

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

534

UIColorPalette

UIColorPaletteUI およびグラフに適用されるテーマの色 (データの色を除く)。色の説明は、# の接頭辞を付けた、6 文字の英数字で構成された 16 進数のカラーコードです (例えば、#37BFF5)。詳細については、「」を参照してください。Amazon QuickSight でのテーマの使用()Amazon QuickSight ユーザーガイド

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

アクセント

この色は、選択した状態とボタンに適用されます。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえAccentForeground

アクセントカラーの上に表示されるテキストやその他の要素に適用される前景色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえ危険

エラーメッセージに適用される色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえDangerForeground

エラーカラーの上に表示されるテキストやその他の要素に適用される前景色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえディメンション

ディメンションとして識別されるフィールドの名前に適用される色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえDimensionForeground

ディメンションカラーの上に表示されるテキストやその他の要素に適用される前景色。

535

UIColorPalette

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえメジャー

メジャーとして識別されるフィールドの名前に適用される色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえMeasureForeground

メジャーカラーの上に表示されるテキストやその他の要素に適用される前景色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえPrimaryBackground

ビジュアルやその他の高強調 UI に適用される背景色です。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえPrimaryForeground

グリッド線、枠線、表の結合、アイコンなど、主要な背景領域に表示されるテキストやその他の前景要素の色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえSecondaryBackground

シートの背景とシートコントロールに適用される背景色です。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえSecondaryForeground

セカンダリ背景上に表示されるシートタイトル、シートコントロールテキスト、または UI に適用される前景色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえ

536

UIColorPalette

成功

ダウンロードの成功を示すチェックマークなど、成功メッセージに適用される色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえSuccessForeground

成功カラーの上に表示されるテキストやその他の要素に適用される前景色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえ警告

警告メッセージおよび情報メッセージに適用される色です。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえWarningForeground

警告カラーの上に表示されるテキストやその他の要素に適用される前景色。

タイプ: 文字列

パターン: ^#[A-F0-9]{6}$

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

537

UploadSettings

UploadSettings1 つまたは複数のソースファイルの形式に関する情報。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

ContainsHeader

ファイルにヘッダー行があるか、ファイルにそれぞれヘッダー行があるかどうか。

タイプ: ブール値

: 必須 いいえ区切り記号

ファイル内の値の間の区切り文字。

タイプ: 文字列

長さの制限: 固定長は 1 です。

: 必須 いいえ形式

ファイル形式。

タイプ: 文字列

有効な値: CSV | TSV | CLF | ELF | XLSX | JSON

: 必須 いいえスタートフロムロウ

データの読み込みを開始する行番号。

タイプ: 整数

有効範囲: 最小値は 1 です。

: 必須 いいえテキスト修飾子

テキスト修飾子。

タイプ: 文字列

有効な値: DOUBLE_QUOTE | SINGLE_QUOTE

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

538

User

UserAmazon QuickSight 登録ユーザー。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

アクティブ

ユーザーのアクティブステータス。IAM ユーザーまたは Active Directory ユーザーではない AmazonQuickSight ユーザーを作成すると、サインインしてパスワードを入力するまで、そのユーザーは非アクティブになります。

タイプ: ブール値

: 必須 いいえArn

ユーザーの Amazon リソースネーム (ARN)

タイプ: 文字列

: 必須 いいえカスタム権限名

このユーザーに関連付けられているカスタム権限プロファイル。

タイプ: 文字列

長さの制限: 最小長は 1 です。 最大長は 64 です。

パターン: ^[a-zA-Z0-9+=,.@_-]+$

: 必須 いいえメール

ユーザーの電子メールアドレス。

タイプ: 文字列

: 必須 いいえ外部ログインフェデレーションプロバイダータイプ

ユーザーが関連付けられた IAM ロールを使用して Amazon QuickSight にフェデレートできるようにID を提供する、サポートされている外部ログインプロバイダーのタイプ。タイプには、次のいずれかを指定できます。• COGNITO: Amazon Cognito。プロバイダの URL は cognito-identity.amazonaws.com です。• CUSTOM_OIDC: カスタム OpenID Connect (OIDC) プロバイダ。

タイプ: 文字列

: 必須 いいえ外部ログインフェデレーションプロバイダー URL

外部ログインプロバイダの URL。

540

User

タイプ: 文字列

: 必須 いいえ外部LoginID

外部ログインプロバイダ内のユーザの ID。

タイプ: 文字列

: 必須 いいえIdentityType

ユーザーが使用する ID 認証のタイプ。

タイプ: 文字列

有効な値: IAM | QUICKSIGHT

: 必須 いいえPrincipalId

ユーザーのプリンシパル ID。

タイプ: 文字列

: 必須 いいえロール

ユーザーの Amazon QuickSight ロール。ユーザーロールは、次のいずれかになります。• READER: ダッシュボードへの読み取り専用アクセス権を持つユーザー。• AUTHOR: データソース、データセット、分析、およびダッシュボードを作成できるユーザー。• ADMIN: Amazon QuickSight の設定を管理できる著者であるユーザー。• RESTRICTED_READER: このロールは現在使用できません。• RESTRICTED_AUTHOR: このロールは現在使用できません。

タイプ: 文字列

有効な値: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

: 必須 いいえUserName

ユーザーのユーザー名。

タイプ: 文字列

長さの制限: 最小長は 1 です。

パターン: [\u0020-\u00FF]+

: 必須 いいえ

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++

541

VpcConnectionProperties

VpcConnectionPropertiesVPC 接続プロパティ。

ContentsNote

次のリストでは、必要なパラメータを最初に説明します。

vPCConnectionArn

VPC 接続の Amazon リソースネーム (ARN)。

タイプ: 文字列

: 必須 はい

以下の資料も参照してください。言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby v3

一般的なエラーこのセクションでは、AWS のすべてのサービスの API アクションに共通のエラーを一覧表示しています。このサービスの API アクションに固有のエラーについては、その API アクションのトピックを参照してください。

AccessDeniedException

このアクションを実行する十分なアクセス権限がありません。

HTTP ステータスコード: 400IncompleteSignature

リクエストの署名が AWS 基準に適合しません。

HTTP ステータスコード: 400InternalFailure

リクエストの処理が、不明なエラー、例外、または障害により実行できませんでした。

HTTP ステータスコード: 500InvalidAction

要求されたアクション、またはオペレーションは無効です。アクションが正しく入力されていることを確認します。

HTTP ステータスコード: 400

543

一般的なエラー

InvalidClientTokenId

指定された x.509 証明書、または AWS アクセスキー ID が見つかりません。

HTTP ステータスコード: 403InvalidParameterCombination

同時に使用できないパラメータが、同時使用されています。

HTTP ステータスコード: 400InvalidParameterValue

無効な値または範囲外の値が入力パラメータとして指定されました。

HTTP ステータスコード: 400InvalidQueryParameter

AWS クエリ文字列が正しい形式でないか、AWS 標準を順守していません。

HTTP ステータスコード: 400MalformedQueryString

クエリ文字列に構文エラーがあります。

HTTP ステータスコード: 404MissingAction

リクエストに、アクションまたは必須パラメータが含まれていません。

HTTP ステータスコード: 400MissingAuthenticationToken

リクエストには、有効な(登録された)AWS アクセスキー ID、または X.509 証明書のどちらか一方が含まれている必要があります。

HTTP ステータスコード: 403MissingParameter

指定したアクションの必須パラメータが指定されていません。

HTTP ステータスコード: 400ノタウソー化

このアクションを実行するアクセス許可がユーザーになりません。

HTTP ステータスコード: 400OptInRequired

サービスを利用するためには、AWS アクセスキー ID を取得する必要があります。

HTTP ステータスコード: 403RequestExpired

リクエストの日付スタンプの 15 分以上後またはリクエストの有効期限(署名付き URL の場合など)の 15 分以上後に、リクエストが到着しました。または、リクエストの日付スタンプが現在より 15 分以上先です。

HTTP ステータスコード: 400

544

共通パラメータ

ServiceUnavailable

リクエストは、サーバーの一時的障害のために実行に失敗しました。

HTTP ステータスコード: 503ThrottlingException

リクエストは、制限が必要なために実行が拒否されました。

HTTP ステータスコード: 400ValidationError

入力が、AWS のサービスで指定された制約を満たしていません。

HTTP ステータスコード: 400

共通パラメータ次のリストには、すべてのアクションがクエリ文字列を使用して Signature Version 4 リクエストに署名するために使用するパラメータが含まれています。アクション固有のパラメーターは、そのアクションのトピックで示されています。署名バージョン 4 の詳細については、「」を参照してください。署名バージョン 4 の署名プロセス()Amazon Web Services 全般的なリファレンス。

アクション

実行するアクション。

タイプ: 文字列

必須 はいバージョン

リクエストが想定している API バージョン。YYYY-MM-DD 形式で表現されます。

タイプ: 文字列

必須 はいX-Amz-Algor

リクエストの署名を作成するのに使用したハッシュアルゴリズム。

条件: HTTP 認証ヘッダーではなく、クエリ文字列に認証情報を含める場合は、このパラメータを指定します。

タイプ: 文字列

有効な値: AWS4-HMAC-SHA256

必須 条件付きX-Amz-Credential

認証情報スコープ。アクセスキー、日付、対象とするリージョン、リクエストしているサービス、および終了文字列 (「aws4_request」) を含む文字列である認証情報スコープ。値は次の形式で表現されます。access_key/YYYYYYYMMDD/リージョン/service/aws4_requestです。

詳細については、「」を参照してください。タスク 2: 署名バージョン 4 の署名文字列を作成する()Amazon Web Services 全般的なリファレンス。

545

共通パラメータ

条件: HTTP 認証ヘッダーではなく、クエリ文字列に認証情報を含める場合は、このパラメータを指定します。

タイプ: 文字列

必須 条件付きX-Amz-Date

署名を作成するために使用される日付。形式は ISO 8601 basic のYYYYYYYYYYYMMDD'HHHMMSS'Z') でなければなりません。たとえば、次の日付時間は、有効なX-Amz-Date 値です。20120325T120000Z。

条件: X-Amz-Date はすべてのリクエストに対してオプションです。署名リクエストで使用する日付よりも優先される日付として使用できます。ISO 8601 基本形式で日付ヘッダーを指定した場合、X-Amz-Date は必要ありません。X-Amz-Date を使用すると、常に Date ヘッダーの値よりも優先されます。詳細については、「」を参照してください。署名バージョン 4 の日付の処理()Amazon WebServices 全般的なリファレンス。

タイプ: 文字列

必須 条件付きX-Amz-Security-Token

AWS Security Token Service (AWS STS) を呼び出して取得された一時的セキュリティトークン。AWS Security Token Service の一時的なセキュリティ認証情報をサポートするサービスのリストについては、IAM と連携する AWS のサービス()IAM ユーザーガイド。

条件: AWS Security Token Service から一時的なセキュリティ認証情報を使用する場合は、セキュリティトークンを含める必要があります。

タイプ: 文字列

必須 条件付きX-Amz-Dignature

署名する文字列と派生署名キーから計算された 16 進エンコードされた署名を指定します。

条件: HTTP 認証ヘッダーではなく、クエリ文字列に認証情報を含める場合は、このパラメータを指定します。

タイプ: 文字列

必須 条件付きX-Amz-SignedHeader

正規リクエストの一部として含まれていたすべての HTTP ヘッダーを指定します。署名ヘッダーの指定の詳細については、「」を参照してください。タスク 1: 署名バージョン 4 の正規リクエストを作成する()Amazon Web Services 全般的なリファレンス。

条件: HTTP 認証ヘッダーではなく、クエリ文字列に認証情報を含める場合は、このパラメータを指定します。

タイプ: 文字列

必須 条件付き

546

AWS の用語集For the latest AWS terminology, see the AWS glossary in the AWS General Reference.

547

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

dxlviii

top related