blib/lib/Paws/LocationService/CreatePlaceIndex.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::LocationService::CreatePlaceIndex;
3 use Moose;
4 has DataSource => (is => 'ro', isa => 'Str', required => 1);
5 has DataSourceConfiguration => (is => 'ro', isa => 'Paws::LocationService::DataSourceConfiguration');
6 has Description => (is => 'ro', isa => 'Str');
7 has IndexName => (is => 'ro', isa => 'Str', required => 1);
8 has PricingPlan => (is => 'ro', isa => 'Str', required => 1);
9 has Tags => (is => 'ro', isa => 'Paws::LocationService::TagMap');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePlaceIndex');
14 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/places/v0/indexes');
15 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LocationService::CreatePlaceIndexResponse');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::LocationService::CreatePlaceIndex - Arguments for method CreatePlaceIndex on L<Paws::LocationService>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method CreatePlaceIndex on the
28 L<Amazon Location Service|Paws::LocationService> service. Use the attributes of this class
29 as arguments to method CreatePlaceIndex.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePlaceIndex.
32  
33 =head1 SYNOPSIS
34  
35 my $geo = Paws->service('LocationService');
36 my $CreatePlaceIndexResponse = $geo->CreatePlaceIndex(
37 DataSource => 'MyString',
38 IndexName => 'MyResourceName',
39 PricingPlan => 'RequestBasedUsage',
40 DataSourceConfiguration => {
41 IntendedUse => 'SingleUse', # values: SingleUse, Storage; OPTIONAL
42 }, # OPTIONAL
43 Description => 'MyResourceDescription', # OPTIONAL
44 Tags => {
45 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256
46 }, # OPTIONAL
47 );
48  
49 # Results:
50 my $CreateTime = $CreatePlaceIndexResponse->CreateTime;
51 my $IndexArn = $CreatePlaceIndexResponse->IndexArn;
52 my $IndexName = $CreatePlaceIndexResponse->IndexName;
53  
54 # Returns a L<Paws::LocationService::CreatePlaceIndexResponse> object.
55  
56 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.
57 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/geo/CreatePlaceIndex>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 B<REQUIRED> DataSource => Str
63  
64 Specifies the data provider of geospatial data.
65  
66 This field is case-sensitive. Enter the valid values as shown. For
67 example, entering C<HERE> will return an error.
68  
69 Valid values include:
70  
71 =over
72  
73 =item *
74  
75 C<Esri>
76  
77 =item *
78  
79 C<Here>
80  
81 Place index resources using HERE as a data provider can't be used to
82 store
83 (https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html)
84 results for locations in Japan. For more information, see the AWS
85 Service Terms (https://aws.amazon.com/service-terms/) for Amazon
86 Location Service.
87  
88 =back
89  
90 For additional details on data providers, see the Amazon Location
91 Service data providers page
92 (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).
93  
94  
95  
96 =head2 DataSourceConfiguration => L<Paws::LocationService::DataSourceConfiguration>
97  
98 Specifies the data storage option for requesting Places.
99  
100  
101  
102 =head2 Description => Str
103  
104 The optional description for the place index resource.
105  
106  
107  
108 =head2 B<REQUIRED> IndexName => Str
109  
110 The name of the place index resource.
111  
112 Requirements:
113  
114 =over
115  
116 =item *
117  
118 Contain only alphanumeric characters (AE<ndash>Z, aE<ndash>z,
119 0E<ndash>9), hyphens (-), periods (.), and underscores (_).
120  
121 =item *
122  
123 Must be a unique place index resource name.
124  
125 =item *
126  
127 No spaces allowed. For example, C<ExamplePlaceIndex>.
128  
129 =back
130  
131  
132  
133  
134 =head2 B<REQUIRED> PricingPlan => Str
135  
136 Specifies the pricing plan for your place index resource.
137  
138 For additional details and restrictions on each pricing plan option,
139 see the Amazon Location Service pricing page
140 (https://aws.amazon.com/location/pricing/).
141  
142 Valid values are: C<"RequestBasedUsage">, C<"MobileAssetTracking">, C<"MobileAssetManagement">
143  
144 =head2 Tags => L<Paws::LocationService::TagMap>
145  
146 Applies one or more tags to the place index resource. A tag is a
147 key-value pair helps manage, identify, search, and filter your
148 resources by labelling them.
149  
150 Format: C<"key" : "value">
151  
152 Restrictions:
153  
154 =over
155  
156 =item *
157  
158 Maximum 50 tags per resource
159  
160 =item *
161  
162 Each resource tag must be unique with a maximum of one value.
163  
164 =item *
165  
166 Maximum key length: 128 Unicode characters in UTF-8
167  
168 =item *
169  
170 Maximum value length: 256 Unicode characters in UTF-8
171  
172 =item *
173  
174 Can use alphanumeric characters (AE<ndash>Z, aE<ndash>z, 0E<ndash>9),
175 and the following characters: + - = . _ : / @.
176  
177 =back
178  
179  
180  
181  
182  
183 =head1 SEE ALSO
184  
185 This class forms part of L<Paws>, documenting arguments for method CreatePlaceIndex in L<Paws::LocationService>
186  
187 =head1 BUGS and CONTRIBUTIONS
188  
189 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
190  
191 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
192  
193 =cut
194