요청 구문 URI 요청 파라미터 요청 본문 응답 구문 응답 요소 오류 참고 항목

CreateDashboard

템플릿에서 대시보드를 생성합니다. 먼저 템플릿을 생성하려면 CreateTemplate API 작업을 참조하세요.

대시보드는 Amazon의 엔티티입니다. QuickSight 아마존을 식별하는 QuickSight 보고서: 분석에서 생성됨. 아마존을 공유할 수 있습니다 QuickSight 대시보드. 올바른 권한이 있으면 해당 보고서에서 예약된 이메일 보고서를 생성할 수 있습니다. 올바른 권한이 있으면 다른 템플릿에서 대시보드를 생성할 수 있습니다.AWS계정.

요청 구문


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

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

URI 요청 파라미터

요청은 다음의 URI 파라미터를 사용합니다.

AwsAccountId

이 의 ID입니다.AWS대시보드를 생성하려는 경우

길이 제약 조건:: 고정 길이는 12입니다.

패턴: ^[0-9]{12}$

필수 사항: 예

DashboardId

대시보드의 ID이며 IAM 정책에도 추가됩니다.

길이 제약 조건:: 최소 길이는 1이고, 최대 길이 2048.

패턴: [\w\-]+

필수 사항: 예

요청 본문

요청은 JSON 형식의 다음 데이터를 받습니다.

Name

대시보드의 표시 이름입니다.

Type: 문자열

길이 제약 조건:: 최소 길이는 1이고, 최대 길이 2048.

필수 사항: 예

SourceEntity

대시보드를 만들 때 소스로 사용하는 엔터티입니다. InSourceEntity소스로 사용할 객체 유형을 지정합니다. 템플릿에서만 대시보드를 생성할 수 있으므로SourceTemplate엔터티. 분석에서 대시보드를 생성해야 하는 경우 먼저CreateTemplateAPI 연산. 용SourceTemplate소스 템플릿의 Amazon 리소스 이름 (ARN) 을 지정합니다. 이SourceTemplateARN에는 임의의 항목이 포함될 수AWS계정 및 모든 아마존 QuickSight지원AWS 리전.

사용DataSetReferences내 엔티티SourceTemplate원본에 나열된 자리 표시자의 대체 데이터셋을 나열합니다. 각 데이터셋의 스키마는 자리 표시자와 일치해야 합니다.

유형: DashboardSourceEntity 객체

필수 사항: 예

DashboardPublishOptions

대시보드를 만들 때 대시보드를 게시하는 옵션은 다음과 같습니다.

AvailabilityStatus...에 대한AdHocFilteringOption이 상태는 다음 중 하나일 수 있습니다.ENABLED또는DISABLED. 이를 다음과 같이 해야 합니다.DISABLED, Amazon QuickSight 게시된 대시보드에서 임시 (일회성) 필터링에 사용할 수 있는 왼쪽 필터 창을 비활성화합니다. 이 옵션은 다음과 같습니다.ENABLED기본적으로.
AvailabilityStatus...에 대한ExportToCSVOption이 상태는 다음 중 하나일 수 있습니다.ENABLED또는DISABLED. 데이터를.CSV 형식으로 내보내는 시각적 옵션은 로 설정된 경우 활성화되지 않습니다.DISABLED. 이 옵션은 다음과 같습니다.ENABLED기본적으로.
VisibilityState...에 대한SheetControlsOption- 가시성 상태는 다음 중 하나일 수 있습니다COLLAPSED또는EXPANDED. 이 옵션은 다음과 같습니다.COLLAPSED기본적으로.

유형: DashboardPublishOptions 객체

필수 사항: 아니요

Parameters

대시보드 생성을 위한 매개 변수로, 기본 설정을 재정의하는 데 사용할 매개 변수입니다. 대시보드에는 모든 유형의 매개 변수가 있을 수 있으며 일부 매개 변수에는 여러 값이 포함될 수 있습니다.

유형: Parameters 객체

필수 사항: 아니요

Permissions

대시보드의 권한이 포함된 구조입니다. 각 보안 주체 ARN에 대한 IAM 작업 정보 목록을 제공하여 이 구조를 사용하여 권한을 부여할 수 있습니다.

권한을 지정하지 않으려면 권한 목록을 생략합니다.

Type: 배열ResourcePermission사물

배열 멤버: 최소 항목 수는 1개입니다. 최대 항목 수는 64개입니다.

필수 사항: 아니요

Tags

대시보드에 할당된 리소스 태그에 대한 키-값 쌍의 맵을 포함합니다.

Type: 배열Tag사물

배열 멤버: 최소 항목 수는 1개입니다. 최대 항목 수는 200개입니다.

필수 사항: 아니요

ThemeArn

대시보드에 사용되는 테마의 Amazon 리소스 이름 (ARN) 입니다. 이 필드의 값을 추가하면 원본 엔터티에 사용된 값이 재정의됩니다. 테마 ARN 같은 에 있어야 합니다.AWS대시보드를 만들 수 있는 계정입니다.

Type: 문자열

필수 사항: 아니요

VersionDescription

생성 중인 대시보드의 첫 번째 버전에 대한 설명입니다.

Type: 문자열

길이 제약 조건:: 최소 길이는 1이고, 최대 길이는 512입니다.

필수 사항: 아니요

응답 구문


HTTP/1.1 Status
Content-type: application/json

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

응답 요소

작업이 성공하면 서비스가 다음 HTTP 응답을 다시 전송합니다.

Status: 요청의 HTTP 상태입니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

Arn

대시보드의 ARN입니다.

Type: 문자열

CreationStatus

대시보드 생성 요청의 상태.

Type: 문자열

DashboardId

대시보드의 ID입니다.

Type: 문자열

길이 제약 조건:: 최소 길이는 1이고, 최대 길이 2048.

패턴: [\w\-]+

RequestId

이AWS작업에 대한 요청 ID입니다.

Type: 문자열

VersionArn

생성된 첫 번째 버전의 버전 번호를 포함한 대시보드의 ARN

Type: 문자열

오류

모든 작업에 공통적인 오류에 대한 자세한 내용은 단원을 참조하십시오.일반적인 오류.

ConflictException

리소스를 업데이트하거나 삭제하면 일관성 없는 상태가 발생할 수 있습니다.

HTTP 상태 코드: 409

InternalFailureException

내부 실패가 발생했습니다.

HTTP 상태 코드: 500

InvalidParameterValueException

하나 이상의 매개변수에 유효하지 않은 값이 있습니다.

HTTP 상태 코드: 400

ResourceExistsException

지정한 리소스가 이미 존재합니다.

HTTP 상태 코드: 409

ResourceNotFoundException

리소스를 하나 이상 찾을 수 없습니다.

HTTP 상태 코드: 404

ThrottlingException

액세스가 제한되었습니다.

HTTP 상태 코드: 429

UnsupportedUserEditionException

이 오류는 아마존에서 작업을 호출하고 있음을 나타냅니다. QuickSight구독: 에디션에는 해당 작업에 대한 지원이 포함되어 있지 않습니다. Amazon QuickSight 현재 스탠다드 에디션과 엔터프라이즈 에디션이 있습니다. 모든 에디션에서 모든 작동 및 기능을 사용할 수 있는 것은 아닙니다.

HTTP 상태 코드: 403

참고 항목

이 API를 언어별 AWS SDK 중 하나로 사용하는 방법에 대한 자세한 내용은 다음을 참조하세요.

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

CreateAnalysis

CreateDataSet