« blib/lib/Paws/LocationService/CalculateRouteTruckModeOptions.pm
↑ Summary
blib/lib/Paws/LocationService/CreateGeofenceCollectionResponse.pm »
| 1 | |||
| 2 | package Paws::LocationService::CreateGeofenceCollection; | ||
| 3 | use Moose; | ||
| 4 | has CollectionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | has PricingPlan => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has PricingPlanDataSource => (is => 'ro', isa => 'Str'); | ||
| 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 => 'CreateGeofenceCollection'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/geofencing/v0/collections'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LocationService::CreateGeofenceCollectionResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::LocationService::CreateGeofenceCollection - Arguments for method CreateGeofenceCollection on L<Paws::LocationService> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateGeofenceCollection on the | ||
| 28 | L<Amazon Location Service|Paws::LocationService> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateGeofenceCollection. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGeofenceCollection. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $geo = Paws->service('LocationService'); | ||
| 36 | my $CreateGeofenceCollectionResponse = $geo->CreateGeofenceCollection( | ||
| 37 | CollectionName => 'MyResourceName', | ||
| 38 | PricingPlan => 'RequestBasedUsage', | ||
| 39 | Description => 'MyResourceDescription', # OPTIONAL | ||
| 40 | KmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 41 | PricingPlanDataSource => 'MyString', # OPTIONAL | ||
| 42 | Tags => { | ||
| 43 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 44 | }, # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $CollectionArn = $CreateGeofenceCollectionResponse->CollectionArn; | ||
| 49 | my $CollectionName = $CreateGeofenceCollectionResponse->CollectionName; | ||
| 50 | my $CreateTime = $CreateGeofenceCollectionResponse->CreateTime; | ||
| 51 | |||
| 52 | # Returns a L<Paws::LocationService::CreateGeofenceCollectionResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/geo/CreateGeofenceCollection> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> CollectionName => Str | ||
| 61 | |||
| 62 | A custom name for the geofence collection. | ||
| 63 | |||
| 64 | Requirements: | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | Contain only alphanumeric characters (AE<ndash>Z, aE<ndash>z, | ||
| 71 | 0E<ndash>9), hyphens (-), periods (.), and underscores (_). | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | Must be a unique geofence collection name. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | No spaces allowed. For example, C<ExampleGeofenceCollection>. | ||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 Description => Str | ||
| 87 | |||
| 88 | An optional description for the geofence collection. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 KmsKeyId => Str | ||
| 93 | |||
| 94 | A key identifier for an AWS KMS customer managed key | ||
| 95 | (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). | ||
| 96 | Enter a key ID, key ARN, alias name, or alias ARN. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> PricingPlan => Str | ||
| 101 | |||
| 102 | Specifies the pricing plan for the geofence collection. | ||
| 103 | |||
| 104 | For additional details and restrictions on each pricing plan option, | ||
| 105 | see the Amazon Location Service pricing page | ||
| 106 | (https://aws.amazon.com/location/pricing/). | ||
| 107 | |||
| 108 | Valid values are: C<"RequestBasedUsage">, C<"MobileAssetTracking">, C<"MobileAssetManagement"> | ||
| 109 | |||
| 110 | =head2 PricingPlanDataSource => Str | ||
| 111 | |||
| 112 | Specifies the data provider for the geofence collection. | ||
| 113 | |||
| 114 | =over | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | Required value for the following pricing plans: C<MobileAssetTracking | ||
| 119 | >| C<MobileAssetManagement> | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | For more information about Data Providers | ||
| 124 | (https://aws.amazon.com/location/data-providers/), and Pricing plans | ||
| 125 | (https://aws.amazon.com/location/pricing/), see the Amazon Location | ||
| 126 | Service product page. | ||
| 127 | |||
| 128 | Amazon Location Service only uses C<PricingPlanDataSource> to calculate | ||
| 129 | billing for your geofence collection. Your data won't be shared with | ||
| 130 | the data provider, and will remain in your AWS account or Region unless | ||
| 131 | you move it. | ||
| 132 | |||
| 133 | Valid Values: C<Esri >| C<Here> | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 Tags => L<Paws::LocationService::TagMap> | ||
| 138 | |||
| 139 | Applies one or more tags to the geofence collection. A tag is a | ||
| 140 | key-value pair helps manage, identify, search, and filter your | ||
| 141 | resources by labelling them. | ||
| 142 | |||
| 143 | Format: C<"key" : "value"> | ||
| 144 | |||
| 145 | Restrictions: | ||
| 146 | |||
| 147 | =over | ||
| 148 | |||
| 149 | =item * | ||
| 150 | |||
| 151 | Maximum 50 tags per resource | ||
| 152 | |||
| 153 | =item * | ||
| 154 | |||
| 155 | Each resource tag must be unique with a maximum of one value. | ||
| 156 | |||
| 157 | =item * | ||
| 158 | |||
| 159 | Maximum key length: 128 Unicode characters in UTF-8 | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | Maximum value length: 256 Unicode characters in UTF-8 | ||
| 164 | |||
| 165 | =item * | ||
| 166 | |||
| 167 | Can use alphanumeric characters (AE<ndash>Z, aE<ndash>z, 0E<ndash>9), | ||
| 168 | and the following characters: + - = . _ : / @. | ||
| 169 | |||
| 170 | =back | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | =head1 SEE ALSO | ||
| 177 | |||
| 178 | This class forms part of L<Paws>, documenting arguments for method CreateGeofenceCollection in L<Paws::LocationService> | ||
| 179 | |||
| 180 | =head1 BUGS and CONTRIBUTIONS | ||
| 181 | |||
| 182 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 183 | |||
| 184 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 185 | |||
| 186 | =cut | ||
| 187 |