« blib/lib/Paws/Quicksight/DescribeNamespaceResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/DescribeTemplateAlias.pm »
| 1 | |||
| 2 | package Paws::Quicksight::DescribeTemplate; | ||
| 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 TemplateId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'TemplateId', 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 => 'DescribeTemplate'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/templates/{TemplateId}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::DescribeTemplateResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Quicksight::DescribeTemplate - Arguments for method DescribeTemplate on L<Paws::Quicksight> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeTemplate on the | ||
| 26 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeTemplate. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeTemplate. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $quicksight = Paws->service('Quicksight'); | ||
| 34 | my $DescribeTemplateResponse = $quicksight->DescribeTemplate( | ||
| 35 | AwsAccountId => 'MyAwsAccountId', | ||
| 36 | TemplateId => 'MyRestrictiveResourceId', | ||
| 37 | AliasName => 'MyAliasName', # OPTIONAL | ||
| 38 | VersionNumber => 1, # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $RequestId = $DescribeTemplateResponse->RequestId; | ||
| 43 | my $Status = $DescribeTemplateResponse->Status; | ||
| 44 | my $Template = $DescribeTemplateResponse->Template; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Quicksight::DescribeTemplateResponse> 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/DescribeTemplate> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 AliasName => Str | ||
| 55 | |||
| 56 | The alias of the template that you want to describe. If you name a | ||
| 57 | specific alias, you describe the version that the alias points to. You | ||
| 58 | can specify the latest version of the template by providing the keyword | ||
| 59 | C<$LATEST> in the C<AliasName> parameter. The keyword C<$PUBLISHED> | ||
| 60 | doesn't apply to templates. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 65 | |||
| 66 | The ID of the AWS account that contains the template that you're | ||
| 67 | describing. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> TemplateId => Str | ||
| 72 | |||
| 73 | The ID for the template. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 VersionNumber => Int | ||
| 78 | |||
| 79 | (Optional) The number for the version to describe. If a | ||
| 80 | C<VersionNumber> parameter value isn't provided, the latest version of | ||
| 81 | the template is described. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, documenting arguments for method DescribeTemplate in L<Paws::Quicksight> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |