« blib/lib/Paws/Quicksight/GetDashboardEmbedUrlResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/GetSessionEmbedUrlResponse.pm »
| 1 | |||
| 2 | package Paws::Quicksight::GetSessionEmbedUrl; | ||
| 3 | use Moose; | ||
| 4 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 5 | has EntryPoint => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'entry-point'); | ||
| 6 | has SessionLifetimeInMinutes => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'session-lifetime'); | ||
| 7 | has UserArn => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'user-arn'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSessionEmbedUrl'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/session-embed-url'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::GetSessionEmbedUrlResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Quicksight::GetSessionEmbedUrl - Arguments for method GetSessionEmbedUrl on L<Paws::Quicksight> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetSessionEmbedUrl on the | ||
| 26 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 27 | as arguments to method GetSessionEmbedUrl. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSessionEmbedUrl. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $quicksight = Paws->service('Quicksight'); | ||
| 34 | my $GetSessionEmbedUrlResponse = $quicksight->GetSessionEmbedUrl( | ||
| 35 | AwsAccountId => 'MyAwsAccountId', | ||
| 36 | EntryPoint => 'MyEntryPoint', # OPTIONAL | ||
| 37 | SessionLifetimeInMinutes => 1, # OPTIONAL | ||
| 38 | UserArn => 'MyArn', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $EmbedUrl = $GetSessionEmbedUrlResponse->EmbedUrl; | ||
| 43 | my $RequestId = $GetSessionEmbedUrlResponse->RequestId; | ||
| 44 | my $Status = $GetSessionEmbedUrlResponse->Status; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Quicksight::GetSessionEmbedUrlResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/GetSessionEmbedUrl> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 55 | |||
| 56 | The ID for the AWS account associated with your QuickSight | ||
| 57 | subscription. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 EntryPoint => Str | ||
| 62 | |||
| 63 | The URL you use to access the embedded session. The entry point URL is | ||
| 64 | constrained to the following paths: | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C</start> | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C</start/analyses> | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C</start/dashboards> | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C</start/favorites> | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C</dashboards/I<DashboardId> > - where C<DashboardId> is the actual ID | ||
| 87 | key from the QuickSight console URL of the dashboard | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C</analyses/I<AnalysisId> > - where C<AnalysisId> is the actual ID key | ||
| 92 | from the QuickSight console URL of the analysis | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 SessionLifetimeInMinutes => Int | ||
| 100 | |||
| 101 | How many minutes the session is valid. The session lifetime must be | ||
| 102 | 15-600 minutes. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 UserArn => Str | ||
| 107 | |||
| 108 | The Amazon QuickSight user's Amazon Resource Name (ARN), for use with | ||
| 109 | C<QUICKSIGHT> identity type. You can use this for any type of Amazon | ||
| 110 | QuickSight users in your account (readers, authors, or admins). They | ||
| 111 | need to be authenticated as one of the following: | ||
| 112 | |||
| 113 | =over | ||
| 114 | |||
| 115 | =item 1. | ||
| 116 | |||
| 117 | Active Directory (AD) users or group members | ||
| 118 | |||
| 119 | =item 2. | ||
| 120 | |||
| 121 | Invited nonfederated users | ||
| 122 | |||
| 123 | =item 3. | ||
| 124 | |||
| 125 | AWS Identity and Access Management (IAM) users and IAM role-based | ||
| 126 | sessions authenticated through Federated Single Sign-On using SAML, | ||
| 127 | OpenID Connect, or IAM federation | ||
| 128 | |||
| 129 | =back | ||
| 130 | |||
| 131 | Omit this parameter for users in the third group, IAM users and IAM | ||
| 132 | role-based sessions. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head1 SEE ALSO | ||
| 138 | |||
| 139 | This class forms part of L<Paws>, documenting arguments for method GetSessionEmbedUrl in L<Paws::Quicksight> | ||
| 140 | |||
| 141 | =head1 BUGS and CONTRIBUTIONS | ||
| 142 | |||
| 143 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 144 | |||
| 145 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 146 | |||
| 147 | =cut | ||
| 148 |