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