/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Quicksight::GetSessionEmbedUrl

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $quicksight = Paws->service('Quicksight');
my $GetSessionEmbedUrlResponse = $quicksight->GetSessionEmbedUrl(
  AwsAccountId             => 'MyAwsAccountId',
  EntryPoint               => 'MyEntryPoint',     # OPTIONAL
  SessionLifetimeInMinutes => 1,                  # OPTIONAL
  UserArn                  => 'MyArn',            # OPTIONAL
);

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

# Returns a L<Paws::Quicksight::GetSessionEmbedUrlResponse> 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/GetSessionEmbedUrl

ATTRIBUTES

REQUIRED AwsAccountId => Str

The ID for the AWS account associated with your QuickSight subscription.

EntryPoint => Str

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId - where DashboardId is the actual ID key from the QuickSight console URL of the dashboard

  • /analyses/AnalysisId - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis

SessionLifetimeInMinutes => Int

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

UserArn => Str

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

  1. Active Directory (AD) users or group members

  2. Invited nonfederated users

  3. AWS Identity and Access Management (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 GetSessionEmbedUrl 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