GenerateEmbedUrlForRegisteredUser - Amazon QuickSight

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

GenerateEmbedUrlForRegisteredUser

아마존을 임베드하는 데 사용할 수 있는 임베드 URL을 생성합니다. QuickSight 웹 사이트에서의 경험. 이 작업은 Amazon에 등록된 모든 유형의 사용자에게 사용할 수 있습니다. QuickSight 계정. 이 작업을 수행하기 전에 관련 Amazon을 구성하는지 확인합니다. QuickSight 리소스 및 권한.

다음 규칙이 생성된 URL에 적용됩니다.

  • 여기에는 임시 베어러 토큰이 포함되어 있습니다. 생성 후 5분 동안 유효합니다. 이 기간 내에 사용한 후에는 다시 사용할 수 없습니다.

  • URL 유효 기간을 사용하여 사용자 지정할 수 있는 실제 세션 수명과 혼동해서는 안 됩니다. SessionLifetimeInMinutes 파라미터.

    결과 사용자 세션은 15분 (최소) 에서 10시간 (최대) 까지 유효합니다. 기본 세션 기간은 10시간입니다.

  • URL이 사용되거나 Amazon과 상호 작용할 때만 요금이 부과됩니다. QuickSight.

자세한 내용은 단원을 참조하십시오.내장형 분석아마존 QuickSight 사용 설명서.

임베딩을 위한 개략적인 단계에 대한 자세한 내용과 임베딩을 사용자 지정하는 방법에 대한 대화형 데모를 보려면아마존 QuickSight 개발자 포털.

요청 구문

POST /accounts/AwsAccountId/embed-url/registered-user HTTP/1.1 Content-type: application/json { "AllowedDomains": [ "string" ], "ExperienceConfiguration": { "Dashboard": { "InitialDashboardId": "string" }, "QSearchBar": { "InitialTopicId": "string" }, "QuickSightConsole": { "InitialPath": "string" } }, "SessionLifetimeInMinutes": number, "UserArn": "string" }

URI 요청 파라미터

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

AwsAccountId

다음 ID입니다.AWS 계정여기에는 내장하려는 대시보드가 포함되어 있습니다.

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

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

필수 사항: 예

요청 본문

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

ExperienceConfiguration

임베딩하고 있는 경험. 등록된 사용자의 경우 Amazon을 임베드할 수 있습니다. QuickSight 대시보드 또는 전체 아마존 QuickSight 콘솔.

유형: RegisteredUserEmbeddingExperienceConfiguration 객체

필수 사항: 예

UserArn

등록된 사용자의 Amazon 리소스 이름입니다.

Type: 문자열

필수 사항: 예

AllowedDomains

생성된 URL에 액세스할 수 있도록 허용 목록에 추가할 도메인입니다. 이 선택적 매개 변수는 관리에서 구성된 정적 도메인을 재정의합니다. QuickSight 아마존 메뉴 QuickSight 콘솔. 대신 이 매개 변수에 포함하는 도메인만 허용합니다. 각 API 호출에 최대 3개의 도메인 또는 하위 도메인을 나열할 수 있습니다.

특정 도메인 아래의 모든 하위 도메인을 허용 목록에 포함하려면 다음을 사용합니다.*. 예,https://*.sapp.amazon.com아래에 모든 하위 도메인 포함https://sapp.amazon.com.

Type: 문자열 배열

필수 사항: 아니요

SessionLifetimeInMinutes

세션의 유효 시간 (분) 입니다. 세션 수명은 [15-600] 분 범위여야 합니다.

Type: Long

유효 범위: 최소값 값 15입니다. 최대값은 600입니다.

필수 사항: 아니요

응답 구문

HTTP/1.1 Status Content-type: application/json { "EmbedUrl": "string", "RequestId": "string" }

응답 요소

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

Status

요청의 HTTP 상태입니다.

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

EmbedUrl

아마존의 임베드 URL QuickSight 대시보드 또는 콘솔.

Type: 문자열

RequestId

이AWS작업에 대한 요청 ID.

Type: 문자열

오류

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

AccessDeniedException

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

HTTP 상태 코드: 401

InternalFailureException

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

HTTP 상태 코드: 500

InvalidParameterValueException

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

HTTP 상태 코드: 400

QuickSightUserNotFoundException

입력한 이름을 가진 사용자를 찾을 수 없습니다. 이 오류는 다음과 같이 제공된 사용자 이름을 기반으로 사용자를 찾아야 하는 모든 작업에서 발생할 수 있습니다.DeleteUser,DescribeUser, 등.

HTTP 상태 코드: 404

ResourceNotFoundException

리소스를 하나 이상 찾을 수 없음.

HTTP 상태 코드: 404

SessionLifetimeInMinutesInvalidException

세션 수명 동안 지정된 시간 (분) 이 유효하지 않습니다. 세션 수명은 15-600분이어야 합니다.

HTTP 상태 코드: 400

ThrottlingException

액세스가 제한됩니다.

HTTP 상태 코드: 429

UnsupportedPricingPlanException

이 오류는 Amazon에서 포함 작업을 호출하고 있음을 나타냅니다. QuickSight필요한 요금제 없이AWS계정. 익명 사용자에 대해 임베딩을 사용하려면 먼저 QuickSight 관리자가 Amazon에 용량 요금을 추가해야 함 QuickSight. 이 작업을 수행할 수 있습니다.Amazon Amazon 관리 QuickSight페이지.

용량 가격이 추가된 후 다음을 사용할 수 있습니다. GetDashboardEmbedUrl API 작업:--identity-type ANONYMOUS옵션.

HTTP 상태 코드: 403

UnsupportedUserEditionException

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

HTTP 상태 코드: 403

참고 항목

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