« blib/lib/Paws/Quicksight/UpdateIAMPolicyAssignmentResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/UpdateTemplateAlias.pm »
| 1 | |||
| 2 | package Paws::Quicksight::UpdateTemplate; | ||
| 3 | use Moose; | ||
| 4 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 5 | has Name => (is => 'ro', isa => 'Str'); | ||
| 6 | has SourceEntity => (is => 'ro', isa => 'Paws::Quicksight::TemplateSourceEntity', required => 1); | ||
| 7 | has TemplateId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'TemplateId', required => 1); | ||
| 8 | has VersionDescription => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateTemplate'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/templates/{TemplateId}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::UpdateTemplateResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Quicksight::UpdateTemplate - Arguments for method UpdateTemplate on L<Paws::Quicksight> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateTemplate on the | ||
| 27 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateTemplate. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateTemplate. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $quicksight = Paws->service('Quicksight'); | ||
| 35 | my $UpdateTemplateResponse = $quicksight->UpdateTemplate( | ||
| 36 | AwsAccountId => 'MyAwsAccountId', | ||
| 37 | SourceEntity => { | ||
| 38 | SourceAnalysis => { | ||
| 39 | Arn => 'MyArn', | ||
| 40 | DataSetReferences => [ | ||
| 41 | { | ||
| 42 | DataSetArn => 'MyArn', | ||
| 43 | DataSetPlaceholder => 'MyNonEmptyString', | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # min: 1 | ||
| 48 | |||
| 49 | }, # OPTIONAL | ||
| 50 | SourceTemplate => { | ||
| 51 | Arn => 'MyArn', | ||
| 52 | |||
| 53 | }, # OPTIONAL | ||
| 54 | }, | ||
| 55 | TemplateId => 'MyRestrictiveResourceId', | ||
| 56 | Name => 'MyTemplateName', # OPTIONAL | ||
| 57 | VersionDescription => 'MyVersionDescription', # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $Arn = $UpdateTemplateResponse->Arn; | ||
| 62 | my $CreationStatus = $UpdateTemplateResponse->CreationStatus; | ||
| 63 | my $RequestId = $UpdateTemplateResponse->RequestId; | ||
| 64 | my $Status = $UpdateTemplateResponse->Status; | ||
| 65 | my $TemplateId = $UpdateTemplateResponse->TemplateId; | ||
| 66 | my $VersionArn = $UpdateTemplateResponse->VersionArn; | ||
| 67 | |||
| 68 | # Returns a L<Paws::Quicksight::UpdateTemplateResponse> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/UpdateTemplate> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 77 | |||
| 78 | The ID of the AWS account that contains the template that you're | ||
| 79 | updating. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Name => Str | ||
| 84 | |||
| 85 | The name for the template. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> SourceEntity => L<Paws::Quicksight::TemplateSourceEntity> | ||
| 90 | |||
| 91 | The entity that you are using as a source when you update the template. | ||
| 92 | In C<SourceEntity>, you specify the type of object you're using as | ||
| 93 | source: C<SourceTemplate> for a template or C<SourceAnalysis> for an | ||
| 94 | analysis. Both of these require an Amazon Resource Name (ARN). For | ||
| 95 | C<SourceTemplate>, specify the ARN of the source template. For | ||
| 96 | C<SourceAnalysis>, specify the ARN of the source analysis. The | ||
| 97 | C<SourceTemplate> ARN can contain any AWS Account and any | ||
| 98 | QuickSight-supported AWS Region. | ||
| 99 | |||
| 100 | Use the C<DataSetReferences> entity within C<SourceTemplate> or | ||
| 101 | C<SourceAnalysis> to list the replacement datasets for the placeholders | ||
| 102 | listed in the original. The schema in each dataset must match its | ||
| 103 | placeholder. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> TemplateId => Str | ||
| 108 | |||
| 109 | The ID for the template. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 VersionDescription => Str | ||
| 114 | |||
| 115 | A description of the current template version that is being updated. | ||
| 116 | Every time you call C<UpdateTemplate>, you create a new version of the | ||
| 117 | template. Each version of the template maintains a description of the | ||
| 118 | version in the C<VersionDescription> field. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, documenting arguments for method UpdateTemplate in L<Paws::Quicksight> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |