getDashboardEmbedUrl method

Future<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl({ required String awsAccountId, required String dashboardId, required EmbeddingIdentityType identityType, List<String>? additionalDashboardIds, String? namespace, bool? resetDisabled, int? sessionLifetimeInMinutes, bool? statePersistenceEnabled, bool? undoRedoDisabled, String? userArn, })

Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:

• They must be used together.
• They can be used one time only.
• They are valid for 5 minutes after you run this command.
• The resulting user session is valid for 10 hours.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

May throw AccessDeniedException. May throw InvalidParameterValueException. May throw ResourceExistsException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw DomainNotWhitelistedException. May throw QuickSightUserNotFoundException. May throw IdentityTypeNotSupportedException. May throw SessionLifetimeInMinutesInvalidException. May throw UnsupportedUserEditionException. May throw UnsupportedPricingPlanException. May throw InternalFailureException.

Parameter awsAccountId : The ID for the AWS account that contains the dashboard that you're embedding.

Parameter dashboardId : The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Parameter identityType : The authentication method that the user uses to sign in.

Parameter additionalDashboardIds : A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Parameter namespace : The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "default".

Parameter resetDisabled : Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Parameter sessionLifetimeInMinutes : How many minutes the session is valid. The session lifetime must be 15-600 minutes.

Parameter statePersistenceEnabled : Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Parameter undoRedoDisabled : Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Parameter userArn : The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members
• Invited nonfederated users
• IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

Implementation

Future<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl({
  required String awsAccountId,
  required String dashboardId,
  required EmbeddingIdentityType identityType,
  List<String>? additionalDashboardIds,
  String? namespace,
  bool? resetDisabled,
  int? sessionLifetimeInMinutes,
  bool? statePersistenceEnabled,
  bool? undoRedoDisabled,
  String? userArn,
}) async {
  ArgumentError.checkNotNull(awsAccountId, 'awsAccountId');
  _s.validateStringLength(
    'awsAccountId',
    awsAccountId,
    12,
    12,
    isRequired: true,
  );
  ArgumentError.checkNotNull(dashboardId, 'dashboardId');
  _s.validateStringLength(
    'dashboardId',
    dashboardId,
    1,
    2048,
    isRequired: true,
  );
  ArgumentError.checkNotNull(identityType, 'identityType');
  _s.validateStringLength(
    'namespace',
    namespace,
    0,
    64,
  );
  _s.validateNumRange(
    'sessionLifetimeInMinutes',
    sessionLifetimeInMinutes,
    15,
    600,
  );
  final $query = <String, List<String>>{
    'creds-type': [identityType.toValue()],
    if (additionalDashboardIds != null)
      'additional-dashboard-ids': additionalDashboardIds,
    if (namespace != null) 'namespace': [namespace],
    if (resetDisabled != null) 'reset-disabled': [resetDisabled.toString()],
    if (sessionLifetimeInMinutes != null)
      'session-lifetime': [sessionLifetimeInMinutes.toString()],
    if (statePersistenceEnabled != null)
      'state-persistence-enabled': [statePersistenceEnabled.toString()],
    if (undoRedoDisabled != null)
      'undo-redo-disabled': [undoRedoDisabled.toString()],
    if (userArn != null) 'user-arn': [userArn],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/accounts/${Uri.encodeComponent(awsAccountId)}/dashboards/${Uri.encodeComponent(dashboardId)}/embed-url',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return GetDashboardEmbedUrlResponse.fromJson(response);
}