« blib/lib/Paws/Quicksight/DescribeAnalysisResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/DescribeDashboardPermissions.pm »
| 1 | |||
| 2 | package Paws::Quicksight::DescribeDashboard; | ||
| 3 | use Moose; | ||
| 4 | has AliasName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'alias-name'); | ||
| 5 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 6 | has DashboardId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DashboardId', required => 1); | ||
| 7 | has VersionNumber => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'version-number'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDashboard'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/dashboards/{DashboardId}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::DescribeDashboardResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Quicksight::DescribeDashboard - Arguments for method DescribeDashboard on L<Paws::Quicksight> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeDashboard on the | ||
| 26 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeDashboard. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDashboard. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $quicksight = Paws->service('Quicksight'); | ||
| 34 | my $DescribeDashboardResponse = $quicksight->DescribeDashboard( | ||
| 35 | AwsAccountId => 'MyAwsAccountId', | ||
| 36 | DashboardId => 'MyRestrictiveResourceId', | ||
| 37 | AliasName => 'MyAliasName', # OPTIONAL | ||
| 38 | VersionNumber => 1, # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $Dashboard = $DescribeDashboardResponse->Dashboard; | ||
| 43 | my $RequestId = $DescribeDashboardResponse->RequestId; | ||
| 44 | my $Status = $DescribeDashboardResponse->Status; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Quicksight::DescribeDashboardResponse> 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/DescribeDashboard> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 AliasName => Str | ||
| 55 | |||
| 56 | The alias name. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 61 | |||
| 62 | The ID of the AWS account that contains the dashboard that you're | ||
| 63 | describing. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> DashboardId => Str | ||
| 68 | |||
| 69 | The ID for the dashboard. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 VersionNumber => Int | ||
| 74 | |||
| 75 | The version number for the dashboard. If a version number isn't passed, | ||
| 76 | the latest published dashboard version is described. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method DescribeDashboard in L<Paws::Quicksight> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |