LocationService / Client / describe_route_calculator

describe_route_calculator#

LocationService.Client.describe_route_calculator(**kwargs)#

Retrieves the route calculator resource details.

Request Syntax

response = client.describe_route_calculator(
    CalculatorName='string'
)

Parameters:

CalculatorName (string) –

[REQUIRED]

The name of the route calculator resource.

Return type:

dict

Returns:

Response Syntax

{
    'CalculatorArn': 'string',
    'CalculatorName': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'DataSource': 'string',
    'Description': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'Tags': {
        'string': 'string'
    },
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- CalculatorArn (string) –
  
  The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across Amazon Web Services.
  - Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
- CalculatorName (string) –
  
  The name of the route calculator resource being described.
- CreateTime (datetime) –
  
  The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - For example, 2020–07-2T12:15:20.000Z+01:00
- DataSource (string) –
  
  The data provider of traffic and road network data. Indicates one of the available providers:
  - Esri
  - Grab
  - Here
  For more information about data providers, see Amazon Location Service data providers.
- Description (string) –
  
  The optional description of the route calculator resource.
- PricingPlan (string) –
  
  Always returns RequestBasedUsage.
- Tags (dict) –
  
  Tags associated with route calculator resource.
  - (string) –
    - (string) –
- UpdateTime (datetime) –
  
  The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - For example, 2020–07-2T12:15:20.000Z+01:00

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.ResourceNotFoundException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException