/ 
Paws-0.43
⭐ Starred 171 / Paws::Quicksight::GetDashboardEmbedUrl

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',
  ResetDisabled            => 1,                           # OPTIONAL
  SessionLifetimeInMinutes => 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

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 IAM policy.

REQUIRED IdentityType => Str

The authentication method that the user uses to sign in.

Valid values are: "IAM", "QUICKSIGHT"

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.

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.

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