« blib/lib/Paws/Quicksight/CreateNamespaceResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/CreateTemplateAlias.pm »
| 1 | |||
| 2 | package Paws::Quicksight::CreateTemplate; | ||
| 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 Permissions => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::ResourcePermission]'); | ||
| 7 | has SourceEntity => (is => 'ro', isa => 'Paws::Quicksight::TemplateSourceEntity', required => 1); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::Tag]'); | ||
| 9 | has TemplateId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'TemplateId', required => 1); | ||
| 10 | has VersionDescription => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTemplate'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/templates/{TemplateId}'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::CreateTemplateResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Quicksight::CreateTemplate - Arguments for method CreateTemplate on L<Paws::Quicksight> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateTemplate on the | ||
| 29 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateTemplate. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTemplate. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $quicksight = Paws->service('Quicksight'); | ||
| 37 | my $CreateTemplateResponse = $quicksight->CreateTemplate( | ||
| 38 | AwsAccountId => 'MyAwsAccountId', | ||
| 39 | SourceEntity => { | ||
| 40 | SourceAnalysis => { | ||
| 41 | Arn => 'MyArn', | ||
| 42 | DataSetReferences => [ | ||
| 43 | { | ||
| 44 | DataSetArn => 'MyArn', | ||
| 45 | DataSetPlaceholder => 'MyNonEmptyString', | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # min: 1 | ||
| 50 | |||
| 51 | }, # OPTIONAL | ||
| 52 | SourceTemplate => { | ||
| 53 | Arn => 'MyArn', | ||
| 54 | |||
| 55 | }, # OPTIONAL | ||
| 56 | }, | ||
| 57 | TemplateId => 'MyRestrictiveResourceId', | ||
| 58 | Name => 'MyTemplateName', # OPTIONAL | ||
| 59 | Permissions => [ | ||
| 60 | { | ||
| 61 | Actions => [ 'MyString', ... ], # min: 1, max: 16 | ||
| 62 | Principal => 'MyPrincipal', # min: 1, max: 256 | ||
| 63 | |||
| 64 | }, | ||
| 65 | ... | ||
| 66 | ], # OPTIONAL | ||
| 67 | Tags => [ | ||
| 68 | { | ||
| 69 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 70 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 71 | |||
| 72 | }, | ||
| 73 | ... | ||
| 74 | ], # OPTIONAL | ||
| 75 | VersionDescription => 'MyVersionDescription', # OPTIONAL | ||
| 76 | ); | ||
| 77 | |||
| 78 | # Results: | ||
| 79 | my $Arn = $CreateTemplateResponse->Arn; | ||
| 80 | my $CreationStatus = $CreateTemplateResponse->CreationStatus; | ||
| 81 | my $RequestId = $CreateTemplateResponse->RequestId; | ||
| 82 | my $Status = $CreateTemplateResponse->Status; | ||
| 83 | my $TemplateId = $CreateTemplateResponse->TemplateId; | ||
| 84 | my $VersionArn = $CreateTemplateResponse->VersionArn; | ||
| 85 | |||
| 86 | # Returns a L<Paws::Quicksight::CreateTemplateResponse> object. | ||
| 87 | |||
| 88 | 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. | ||
| 89 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateTemplate> | ||
| 90 | |||
| 91 | =head1 ATTRIBUTES | ||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 95 | |||
| 96 | The ID for the AWS account that the group is in. Currently, you use the | ||
| 97 | ID for the AWS account that contains your Amazon QuickSight account. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 Name => Str | ||
| 102 | |||
| 103 | A display name for the template. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 Permissions => ArrayRef[L<Paws::Quicksight::ResourcePermission>] | ||
| 108 | |||
| 109 | A list of resource permissions to be set on the template. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> SourceEntity => L<Paws::Quicksight::TemplateSourceEntity> | ||
| 114 | |||
| 115 | The entity that you are using as a source when you create the template. | ||
| 116 | In C<SourceEntity>, you specify the type of object you're using as | ||
| 117 | source: C<SourceTemplate> for a template or C<SourceAnalysis> for an | ||
| 118 | analysis. Both of these require an Amazon Resource Name (ARN). For | ||
| 119 | C<SourceTemplate>, specify the ARN of the source template. For | ||
| 120 | C<SourceAnalysis>, specify the ARN of the source analysis. The | ||
| 121 | C<SourceTemplate> ARN can contain any AWS Account and any | ||
| 122 | QuickSight-supported AWS Region. | ||
| 123 | |||
| 124 | Use the C<DataSetReferences> entity within C<SourceTemplate> or | ||
| 125 | C<SourceAnalysis> to list the replacement datasets for the placeholders | ||
| 126 | listed in the original. The schema in each dataset must match its | ||
| 127 | placeholder. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 Tags => ArrayRef[L<Paws::Quicksight::Tag>] | ||
| 132 | |||
| 133 | Contains a map of the key-value pairs for the resource tag or tags | ||
| 134 | assigned to the resource. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 B<REQUIRED> TemplateId => Str | ||
| 139 | |||
| 140 | An ID for the template that you want to create. This template is unique | ||
| 141 | per AWS Region in each AWS account. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 VersionDescription => Str | ||
| 146 | |||
| 147 | A description of the current template version being created. This API | ||
| 148 | operation creates the first version of the template. Every time | ||
| 149 | C<UpdateTemplate> is called, a new version is created. Each version of | ||
| 150 | the template maintains a description of the version in the | ||
| 151 | C<VersionDescription> field. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head1 SEE ALSO | ||
| 157 | |||
| 158 | This class forms part of L<Paws>, documenting arguments for method CreateTemplate in L<Paws::Quicksight> | ||
| 159 | |||
| 160 | =head1 BUGS and CONTRIBUTIONS | ||
| 161 | |||
| 162 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 163 | |||
| 164 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 165 | |||
| 166 | =cut | ||
| 167 |