NAME

Paws::Quicksight::GetDashboardEmbedUrl - Arguments for method GetDashboardEmbedUrl on Paws::Quicksight

DESCRIPTION

This class represents the parameters used for calling the method GetDashboardEmbedUrl on the Amazon QuickSight service. Use the attributes of this class as arguments to method GetDashboardEmbedUrl.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDashboardEmbedUrl.

SYNOPSIS

    my $quicksight = Paws->service('Quicksight');
    my $GetDashboardEmbedUrlResponse = $quicksight->GetDashboardEmbedUrl(
      AwsAccountId           => 'MyAwsAccountId',
      DashboardId            => 'MyRestrictiveResourceId',
      IdentityType           => 'IAM',
      AdditionalDashboardIds => [
        'MyRestrictiveResourceId', ...    # min: 1, max: 2048
      ],    # OPTIONAL
      Namespace                => 'MyNamespace',    # OPTIONAL
      ResetDisabled            => 1,                # OPTIONAL
      SessionLifetimeInMinutes => 1,                # OPTIONAL
      StatePersistenceEnabled  => 1,                # OPTIONAL
      UndoRedoDisabled         => 1,                # OPTIONAL
      UserArn                  => 'MyArn',          # OPTIONAL
    );

    # Results:
    my $EmbedUrl  = $GetDashboardEmbedUrlResponse->EmbedUrl;
    my $RequestId = $GetDashboardEmbedUrlResponse->RequestId;
    my $Status    = $GetDashboardEmbedUrlResponse->Status;

    # Returns a L<Paws::Quicksight::GetDashboardEmbedUrlResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/quicksight/GetDashboardEmbedUrl

ATTRIBUTES

AdditionalDashboardIds => ArrayRef[Str|Undef]

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.

REQUIRED AwsAccountId => Str

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

REQUIRED DashboardId => Str

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

REQUIRED IdentityType => Str

The authentication method that the user uses to sign in.

Valid values are: "IAM", "QUICKSIGHT", "ANONYMOUS"

Namespace => Str

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

ResetDisabled => Bool

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

SessionLifetimeInMinutes => Int

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

StatePersistenceEnabled => Bool

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.

UndoRedoDisabled => Bool

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

UserArn => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetDashboardEmbedUrl in Paws::Quicksight

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws

perl -MCPAN -e shell
install Paws