DescribeDashboard - Amazon QuickSight

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

DescribeDashboard

대시보드에 대한 요약 제공

요청 구문

GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

URI 요청 파라미터

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

AliasName

별칭 이름입니다.

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

패턴: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

의 ID입니다.AWS설명 중인 대시보드가 포함된 계정입니다.

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

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

필수: 예

DashboardId

대시보드의 ID입니다.

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

패턴: [\w\-]+

필수: 예

VersionNumber

대시보드의 버전 번호입니다. 버전 번호가 전달되지 않으면 최근에 게시된 대시보드 버전이 설명됩니다.

유효 범위: 최소값 1.

요청 본문

요청에 요청 본문이 없습니다.

응답 구문

HTTP/1.1 Status Content-type: application/json { "Dashboard": { "Arn": "string", "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 응답을 다시 전송합니다.

Status

요청의 HTTP 상태입니다.

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

Dashboard

대시보드에 대한 정보입니다.

유형: Dashboard 객체

RequestId

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

Type: 문자열

오류

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

AccessDeniedException

항목에 액세스할 수 없습니다. 제공된 자격 증명을 검증할 수 없습니다. 요청을 수행할 권한이 없을 수도 있습니다. 계정이 Amazon을 사용할 수 있도록 승인되었는지 확인합니다. QuickSight 정책에 올바른 권한이 있고 올바른 액세스 키를 사용하고 있는지 확인합니다.

HTTP 상태 코드: 401

InternalFailureException

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

HTTP 상태 코드: 500

InvalidParameterValueException

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

HTTP 상태 코드: 400

ResourceNotFoundException

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

HTTP 상태 코드: 404

ThrottlingException

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

HTTP 상태 코드: 429

UnsupportedUserEditionException

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

HTTP 상태 코드: 403

참고 항목

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