Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.
Creates a new event data store.
", "CreateTrail": "Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
", - "DeleteEventDataStore": "Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run DeleteEventDataStore, the event data store is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store; this operation cannot work if TerminationProtectionEnabled is True.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, DescribeQuery, or GetQueryResults on queries that are using an event data store in a PENDING_DELETION state.
Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store; this operation cannot work if TerminationProtectionEnabled is True.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, DescribeQuery, or GetQueryResults on queries that are using an event data store in a PENDING_DELETION state. An event data store in the PENDING_DELETION state does not incur costs.
Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for EventDataStore, and a value for QueryID.
Retrieves settings for one or more trails associated with the current region for your account.
", @@ -390,7 +390,7 @@ "ExcludeManagementEventSources": { "base": null, "refs": { - "EventSelector$ExcludeManagementEventSources": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail.
An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in regions that support the event source.
A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
readOnly - Optional. Can be set to Equals a value of true or false. A value of false logs both read and write events.
eventSource - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com.
eventName - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock. You can have multiple values for this field, separated by commas.
eventCategory - This is required. It must be set to Equals, and the value must be Management or Data.
resources.type - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
resources.ARN - You can use any operator with resources.ARN, but if you use Equals or NotEquals, the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object, the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
readOnly - Optional. Can be set to Equals a value of true or false. If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
eventSource - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com.
eventName - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock. You can have multiple values for this field, separated by commas.
eventCategory - This is required. It must be set to Equals, and the value must be Management or Data.
resources.type - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
resources.ARN - You can use any operator with resources.ARN, but if you use Equals or NotEquals, the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object, the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type equals AWS::Glue::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
", "CreateTrailResponse$CloudWatchLogsRoleArn": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
", "CreateTrailResponse$KmsKeyId": "Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
The resource type in which you want to log data events. You can specify the following basic event selector resource types:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
The following resource types are also availble through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector$Field.
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
The resource type in which you want to log data events. You can specify the following basic event selector resource types:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
The following resource types are also availble through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector$Field.
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The CloudTrail ID of the event returned.
", diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 493d998782b..50a2b3dc0f9 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -7750,6 +7750,26 @@ "UploadStart":{"shape":"DateTime"} } }, + "ClientLoginBannerOptions":{ + "type":"structure", + "members":{ + "Enabled":{"shape":"Boolean"}, + "BannerText":{"shape":"String"} + } + }, + "ClientLoginBannerResponseOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "locationName":"enabled" + }, + "BannerText":{ + "shape":"String", + "locationName":"bannerText" + } + } + }, "ClientVpnAssociationId":{"type":"string"}, "ClientVpnAuthentication":{ "type":"structure", @@ -8000,6 +8020,14 @@ "ClientConnectOptions":{ "shape":"ClientConnectResponseOptions", "locationName":"clientConnectOptions" + }, + "SessionTimeoutHours":{ + "shape":"Integer", + "locationName":"sessionTimeoutHours" + }, + "ClientLoginBannerOptions":{ + "shape":"ClientLoginBannerResponseOptions", + "locationName":"clientLoginBannerOptions" } } }, @@ -8690,7 +8718,9 @@ }, "VpcId":{"shape":"VpcId"}, "SelfServicePortal":{"shape":"SelfServicePortal"}, - "ClientConnectOptions":{"shape":"ClientConnectOptions"} + "ClientConnectOptions":{"shape":"ClientConnectOptions"}, + "SessionTimeoutHours":{"shape":"Integer"}, + "ClientLoginBannerOptions":{"shape":"ClientLoginBannerOptions"} } }, "CreateClientVpnEndpointResult":{ @@ -26911,7 +26941,9 @@ }, "VpcId":{"shape":"VpcId"}, "SelfServicePortal":{"shape":"SelfServicePortal"}, - "ClientConnectOptions":{"shape":"ClientConnectOptions"} + "ClientConnectOptions":{"shape":"ClientConnectOptions"}, + "SessionTimeoutHours":{"shape":"Integer"}, + "ClientLoginBannerOptions":{"shape":"ClientLoginBannerOptions"} } }, "ModifyClientVpnEndpointResult":{ diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index d969ebf0f6e..1cff88ea0e9 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -1666,6 +1666,8 @@ "ClassicLinkDnsSupport$ClassicLinkDnsSupported": "Indicates whether ClassicLink DNS support is enabled for the VPC.
", "ClientConnectOptions$Enabled": "Indicates whether client connect options are enabled. The default is false (not enabled).
Indicates whether client connect options are enabled.
", + "ClientLoginBannerOptions$Enabled": null, + "ClientLoginBannerResponseOptions$Enabled": null, "ClientVpnEndpoint$SplitTunnel": "Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
", "ConfirmProductInstanceRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
The client-specific data.
" } }, + "ClientLoginBannerOptions": { + "base": null, + "refs": { + "CreateClientVpnEndpointRequest$ClientLoginBannerOptions": null, + "ModifyClientVpnEndpointRequest$ClientLoginBannerOptions": null + } + }, + "ClientLoginBannerResponseOptions": { + "base": null, + "refs": { + "ClientVpnEndpoint$ClientLoginBannerOptions": null + } + }, "ClientVpnAssociationId": { "base": null, "refs": { @@ -10179,6 +10194,7 @@ "CapacityReservation$AvailableInstanceCount": "The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
", "CapacityReservationFleet$TotalTargetCapacity": "The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see Total target capacity in the Amazon EC2 User Guide.
", "ClientVpnEndpoint$VpnPort": "The port number for the Client VPN endpoint.
", + "ClientVpnEndpoint$SessionTimeoutHours": null, "CpuOptions$CoreCount": "The number of CPU cores for the instance.
", "CpuOptions$ThreadsPerCore": "The number of threads per CPU core.
", "CpuOptionsRequest$CoreCount": "The number of CPU cores for the instance.
", @@ -10187,6 +10203,7 @@ "CreateCapacityReservationFleetResult$TotalTargetCapacity": "The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.
", "CreateCapacityReservationRequest$InstanceCount": "The number of instances for which to reserve capacity.
Valid range: 1 - 1000
", "CreateClientVpnEndpointRequest$VpnPort": "The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
", "CreateFlowLogsRequest$MaxAggregationInterval": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
", "CreateManagedPrefixListRequest$MaxEntries": "The maximum number of entries for the prefix list.
", @@ -10329,6 +10346,7 @@ "ModifyCapacityReservationFleetRequest$TotalTargetCapacity": "The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.
", "ModifyCapacityReservationRequest$InstanceCount": "The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than 1000 in a single request.
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
", "ModifyInstancePlacementRequest$PartitionNumber": "The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition.
The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
", @@ -16351,6 +16369,8 @@ "ClientConnectOptions$LambdaFunctionArn": "The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
", "ClientConnectResponseOptions$LambdaFunctionArn": "The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
", "ClientData$Comment": "A user-defined comment about the disk upload.
", + "ClientLoginBannerOptions$BannerText": null, + "ClientLoginBannerResponseOptions$BannerText": null, "ClientVpnAuthorizationRuleStatus$Message": "A message about the status of the authorization rule, if applicable.
", "ClientVpnConnection$ClientVpnEndpointId": "The ID of the Client VPN endpoint to which the client is connected.
", "ClientVpnConnection$Timestamp": "The current date and time.
", diff --git a/models/apis/ivs/2020-07-14/api-2.json b/models/apis/ivs/2020-07-14/api-2.json index 41a551cdc4e..dd84998efb0 100644 --- a/models/apis/ivs/2020-07-14/api-2.json +++ b/models/apis/ivs/2020-07-14/api-2.json @@ -341,7 +341,8 @@ "input":{"shape":"ListStreamsRequest"}, "output":{"shape":"ListStreamsResponse"}, "errors":[ - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} ] }, "ListTagsForResource":{ @@ -620,7 +621,8 @@ "members":{ "destinationConfiguration":{"shape":"DestinationConfiguration"}, "name":{"shape":"RecordingConfigurationName"}, - "tags":{"shape":"Tags"} + "tags":{"shape":"Tags"}, + "thumbnailConfiguration":{"shape":"ThumbnailConfiguration"} } }, "CreateRecordingConfigurationResponse":{ @@ -1010,7 +1012,8 @@ "destinationConfiguration":{"shape":"DestinationConfiguration"}, "name":{"shape":"RecordingConfigurationName"}, "state":{"shape":"RecordingConfigurationState"}, - "tags":{"shape":"Tags"} + "tags":{"shape":"Tags"}, + "thumbnailConfiguration":{"shape":"ThumbnailConfiguration"} } }, "RecordingConfigurationArn":{ @@ -1052,6 +1055,13 @@ "tags":{"shape":"Tags"} } }, + "RecordingMode":{ + "type":"string", + "enum":[ + "DISABLED", + "INTERVAL" + ] + }, "ResourceArn":{ "type":"string", "max":128, @@ -1302,6 +1312,11 @@ "max":50, "min":0 }, + "TargetIntervalSeconds":{ + "type":"long", + "max":60, + "min":5 + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -1313,6 +1328,13 @@ }, "exception":true }, + "ThumbnailConfiguration":{ + "type":"structure", + "members":{ + "recordingMode":{"shape":"RecordingMode"}, + "targetIntervalSeconds":{"shape":"TargetIntervalSeconds"} + } + }, "Time":{ "type":"timestamp", "timestampFormat":"iso8601" diff --git a/models/apis/ivs/2020-07-14/docs-2.json b/models/apis/ivs/2020-07-14/docs-2.json index 4e7697be47d..315b9e83abe 100644 --- a/models/apis/ivs/2020-07-14/docs-2.json +++ b/models/apis/ivs/2020-07-14/docs-2.json @@ -583,6 +583,12 @@ "RecordingConfigurationList$member": null } }, + "RecordingMode": { + "base": null, + "refs": { + "ThumbnailConfiguration$recordingMode": "Thumbnail recording mode. Default: INTERVAL.
List of stream sessions.
" } }, "StreamSessionSummary": { @@ -837,11 +843,24 @@ "TagResourceRequest$tags": "Array of tags to be added or updated.
" } }, + "TargetIntervalSeconds": { + "base": null, + "refs": { + "ThumbnailConfiguration$targetIntervalSeconds": "The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.
An object representing a configuration of thumbnails for recorded video.
", + "refs": { + "CreateRecordingConfigurationRequest$thumbnailConfiguration": "A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
", + "RecordingConfiguration$thumbnailConfiguration": "A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
" + } + }, "Time": { "base": null, "refs": { diff --git a/models/apis/location/2020-11-19/api-2.json b/models/apis/location/2020-11-19/api-2.json index 3d6da6ae1ba..b7a7c7a4a9c 100644 --- a/models/apis/location/2020-11-19/api-2.json +++ b/models/apis/location/2020-11-19/api-2.json @@ -158,6 +158,24 @@ ], "endpoint":{"hostPrefix":"routes."} }, + "CalculateRouteMatrix":{ + "name":"CalculateRouteMatrix", + "http":{ + "method":"POST", + "requestUri":"/routes/v0/calculators/{CalculatorName}/calculate/route-matrix", + "responseCode":200 + }, + "input":{"shape":"CalculateRouteMatrixRequest"}, + "output":{"shape":"CalculateRouteMatrixResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"routes."} + }, "CreateGeofenceCollection":{ "name":"CreateGeofenceCollection", "http":{ @@ -1330,6 +1348,93 @@ "AvoidTolls":{"shape":"Boolean"} } }, + "CalculateRouteMatrixRequest":{ + "type":"structure", + "required":[ + "CalculatorName", + "DeparturePositions", + "DestinationPositions" + ], + "members":{ + "CalculatorName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"CalculatorName" + }, + "CarModeOptions":{"shape":"CalculateRouteCarModeOptions"}, + "DepartNow":{"shape":"Boolean"}, + "DeparturePositions":{"shape":"CalculateRouteMatrixRequestDeparturePositionsList"}, + "DepartureTime":{"shape":"Timestamp"}, + "DestinationPositions":{"shape":"CalculateRouteMatrixRequestDestinationPositionsList"}, + "DistanceUnit":{"shape":"DistanceUnit"}, + "TravelMode":{"shape":"TravelMode"}, + "TruckModeOptions":{"shape":"CalculateRouteTruckModeOptions"} + } + }, + "CalculateRouteMatrixRequestDeparturePositionsList":{ + "type":"list", + "member":{"shape":"Position"}, + "max":350, + "min":1 + }, + "CalculateRouteMatrixRequestDestinationPositionsList":{ + "type":"list", + "member":{"shape":"Position"}, + "max":350, + "min":1 + }, + "CalculateRouteMatrixResponse":{ + "type":"structure", + "required":[ + "RouteMatrix", + "Summary" + ], + "members":{ + "RouteMatrix":{"shape":"RouteMatrix"}, + "SnappedDeparturePositions":{"shape":"CalculateRouteMatrixResponseSnappedDeparturePositionsList"}, + "SnappedDestinationPositions":{"shape":"CalculateRouteMatrixResponseSnappedDestinationPositionsList"}, + "Summary":{"shape":"CalculateRouteMatrixSummary"} + } + }, + "CalculateRouteMatrixResponseSnappedDeparturePositionsList":{ + "type":"list", + "member":{"shape":"Position"}, + "max":350, + "min":1 + }, + "CalculateRouteMatrixResponseSnappedDestinationPositionsList":{ + "type":"list", + "member":{"shape":"Position"}, + "max":350, + "min":1 + }, + "CalculateRouteMatrixSummary":{ + "type":"structure", + "required":[ + "DataSource", + "DistanceUnit", + "ErrorCount", + "RouteCount" + ], + "members":{ + "DataSource":{"shape":"String"}, + "DistanceUnit":{"shape":"DistanceUnit"}, + "ErrorCount":{"shape":"CalculateRouteMatrixSummaryErrorCountInteger"}, + "RouteCount":{"shape":"CalculateRouteMatrixSummaryRouteCountInteger"} + } + }, + "CalculateRouteMatrixSummaryErrorCountInteger":{ + "type":"integer", + "box":true, + "max":160000, + "min":1 + }, + "CalculateRouteMatrixSummaryRouteCountInteger":{ + "type":"integer", + "box":true, + "max":160000, + "min":1 + }, "CalculateRouteRequest":{ "type":"structure", "required":[ @@ -1440,8 +1545,16 @@ "CollectionName":{"shape":"ResourceName"}, "Description":{"shape":"ResourceDescription"}, "KmsKeyId":{"shape":"KmsKeyId"}, - "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. No longer allowed." + }, "Tags":{"shape":"TagMap"} } }, @@ -1468,7 +1581,11 @@ "Configuration":{"shape":"MapConfiguration"}, "Description":{"shape":"ResourceDescription"}, "MapName":{"shape":"ResourceName"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + }, "Tags":{"shape":"TagMap"} } }, @@ -1496,7 +1613,11 @@ "DataSourceConfiguration":{"shape":"DataSourceConfiguration"}, "Description":{"shape":"ResourceDescription"}, "IndexName":{"shape":"ResourceName"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + }, "Tags":{"shape":"TagMap"} } }, @@ -1523,7 +1644,11 @@ "CalculatorName":{"shape":"ResourceName"}, "DataSource":{"shape":"String"}, "Description":{"shape":"ResourceDescription"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + }, "Tags":{"shape":"TagMap"} } }, @@ -1547,8 +1672,16 @@ "Description":{"shape":"ResourceDescription"}, "KmsKeyId":{"shape":"KmsKeyId"}, "PositionFiltering":{"shape":"PositionFiltering"}, - "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. No longer allowed." + }, "Tags":{"shape":"TagMap"}, "TrackerName":{"shape":"ResourceName"} } @@ -1670,7 +1803,6 @@ "CollectionName", "CreateTime", "Description", - "PricingPlan", "UpdateTime" ], "members":{ @@ -1679,8 +1811,16 @@ "CreateTime":{"shape":"Timestamp"}, "Description":{"shape":"ResourceDescription"}, "KmsKeyId":{"shape":"KmsKeyId"}, - "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. Unused." + }, "Tags":{"shape":"TagMap"}, "UpdateTime":{"shape":"Timestamp"} } @@ -1705,7 +1845,6 @@ "Description", "MapArn", "MapName", - "PricingPlan", "UpdateTime" ], "members":{ @@ -1715,7 +1854,11 @@ "Description":{"shape":"ResourceDescription"}, "MapArn":{"shape":"Arn"}, "MapName":{"shape":"ResourceName"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, "Tags":{"shape":"TagMap"}, "UpdateTime":{"shape":"Timestamp"} } @@ -1740,7 +1883,6 @@ "Description", "IndexArn", "IndexName", - "PricingPlan", "UpdateTime" ], "members":{ @@ -1750,7 +1892,11 @@ "Description":{"shape":"ResourceDescription"}, "IndexArn":{"shape":"Arn"}, "IndexName":{"shape":"ResourceName"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, "Tags":{"shape":"TagMap"}, "UpdateTime":{"shape":"Timestamp"} } @@ -1774,7 +1920,6 @@ "CreateTime", "DataSource", "Description", - "PricingPlan", "UpdateTime" ], "members":{ @@ -1783,7 +1928,11 @@ "CreateTime":{"shape":"Timestamp"}, "DataSource":{"shape":"String"}, "Description":{"shape":"ResourceDescription"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, "Tags":{"shape":"TagMap"}, "UpdateTime":{"shape":"Timestamp"} } @@ -1804,7 +1953,6 @@ "required":[ "CreateTime", "Description", - "PricingPlan", "TrackerArn", "TrackerName", "UpdateTime" @@ -1814,8 +1962,16 @@ "Description":{"shape":"ResourceDescription"}, "KmsKeyId":{"shape":"KmsKeyId"}, "PositionFiltering":{"shape":"PositionFiltering"}, - "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. Unused." + }, "Tags":{"shape":"TagMap"}, "TrackerArn":{"shape":"Arn"}, "TrackerName":{"shape":"ResourceName"}, @@ -2327,15 +2483,22 @@ "CollectionName", "CreateTime", "Description", - "PricingPlan", "UpdateTime" ], "members":{ "CollectionName":{"shape":"ResourceName"}, "CreateTime":{"shape":"Timestamp"}, "Description":{"shape":"ResourceDescription"}, - "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. Unused." + }, "UpdateTime":{"shape":"Timestamp"} } }, @@ -2412,7 +2575,6 @@ "DataSource", "Description", "MapName", - "PricingPlan", "UpdateTime" ], "members":{ @@ -2420,7 +2582,11 @@ "DataSource":{"shape":"String"}, "Description":{"shape":"ResourceDescription"}, "MapName":{"shape":"ResourceName"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, "UpdateTime":{"shape":"Timestamp"} } }, @@ -2456,7 +2622,6 @@ "DataSource", "Description", "IndexName", - "PricingPlan", "UpdateTime" ], "members":{ @@ -2464,7 +2629,11 @@ "DataSource":{"shape":"String"}, "Description":{"shape":"ResourceDescription"}, "IndexName":{"shape":"ResourceName"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, "UpdateTime":{"shape":"Timestamp"} } }, @@ -2500,7 +2669,6 @@ "CreateTime", "DataSource", "Description", - "PricingPlan", "UpdateTime" ], "members":{ @@ -2508,7 +2676,11 @@ "CreateTime":{"shape":"Timestamp"}, "DataSource":{"shape":"String"}, "Description":{"shape":"ResourceDescription"}, - "PricingPlan":{"shape":"PricingPlan"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, "UpdateTime":{"shape":"Timestamp"} } }, @@ -2586,15 +2758,22 @@ "required":[ "CreateTime", "Description", - "PricingPlan", "TrackerName", "UpdateTime" ], "members":{ "CreateTime":{"shape":"Timestamp"}, "Description":{"shape":"ResourceDescription"}, - "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. Unused." + }, "TrackerName":{"shape":"ResourceName"}, "UpdateTime":{"shape":"Timestamp"} } @@ -2759,6 +2938,51 @@ }, "exception":true }, + "RouteMatrix":{ + "type":"list", + "member":{"shape":"RouteMatrixRow"} + }, + "RouteMatrixEntry":{ + "type":"structure", + "members":{ + "Distance":{"shape":"RouteMatrixEntryDistanceDouble"}, + "DurationSeconds":{"shape":"RouteMatrixEntryDurationSecondsDouble"}, + "Error":{"shape":"RouteMatrixEntryError"} + } + }, + "RouteMatrixEntryDistanceDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "RouteMatrixEntryDurationSecondsDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "RouteMatrixEntryError":{ + "type":"structure", + "required":["Code"], + "members":{ + "Code":{"shape":"RouteMatrixErrorCode"}, + "Message":{"shape":"String"} + } + }, + "RouteMatrixErrorCode":{ + "type":"string", + "enum":[ + "RouteNotFound", + "RouteTooLong", + "PositionsNotFound", + "DestinationPositionNotFound", + "DeparturePositionNotFound", + "OtherValidationError" + ] + }, + "RouteMatrixRow":{ + "type":"list", + "member":{"shape":"RouteMatrixEntry"} + }, "SearchForPositionResult":{ "type":"structure", "required":[ @@ -3183,8 +3407,16 @@ "locationName":"CollectionName" }, "Description":{"shape":"ResourceDescription"}, - "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"} + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. No longer allowed." + } } }, "UpdateGeofenceCollectionResponse":{ @@ -3210,7 +3442,11 @@ "location":"uri", "locationName":"MapName" }, - "PricingPlan":{"shape":"PricingPlan"} + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + } } }, "UpdateMapResponse":{ @@ -3237,7 +3473,11 @@ "location":"uri", "locationName":"IndexName" }, - "PricingPlan":{"shape":"PricingPlan"} + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + } } }, "UpdatePlaceIndexResponse":{ @@ -3263,7 +3503,11 @@ "locationName":"CalculatorName" }, "Description":{"shape":"ResourceDescription"}, - "PricingPlan":{"shape":"PricingPlan"} + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + } } }, "UpdateRouteCalculatorResponse":{ @@ -3285,8 +3529,16 @@ "members":{ "Description":{"shape":"ResourceDescription"}, "PositionFiltering":{"shape":"PositionFiltering"}, - "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. No longer allowed." + }, "TrackerName":{ "shape":"ResourceName", "location":"uri", diff --git a/models/apis/location/2020-11-19/docs-2.json b/models/apis/location/2020-11-19/docs-2.json index 755da7e34f6..e6a0bbcefe5 100644 --- a/models/apis/location/2020-11-19/docs-2.json +++ b/models/apis/location/2020-11-19/docs-2.json @@ -9,11 +9,12 @@ "BatchGetDevicePosition": "Lists the latest device positions for requested devices.
", "BatchPutGeofence": "A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
", "BatchUpdateDevicePosition": "Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.
Position updates are handled based on the PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.
When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).
When PositionFiltering is set to AccuracyBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default value { \"Horizontal\": 0} when accuracy is not provided on a DevicePositionUpdate.
Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition. Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include:
Specifying a departure time using either DepartureTime or DepartureNow. This calculates a route based on predictive traffic data at the given time.
You can't specify both DepartureTime and DepartureNow in a single request. Specifying both parameters returns a validation error.
Specifying a travel mode using TravelMode. This lets you specify an additional route preference such as CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
", + "CalculateRoute": "
Calculates a route given the following required parameters: DeparturePosition and DestinationPosition. Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include:
Specifying a departure time using either DepartureTime or DepartNow. This calculates a route based on predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.
Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of DeparturePositions times the number of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.
Additional options include:
Specifying a departure time using either DepartureTime or DepartNow. This calculates routes based on predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.
Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
Creates a geofence collection, which manages and stores geofences.
", - "CreateMap": "Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
", - "CreatePlaceIndex": "Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.
Creates a route calculator resource in your AWS account.
You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
", + "CreateMap": "Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
Creates a route calculator resource in your AWS account.
You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
", "DeleteGeofenceCollection": "Deletes a geofence collection from your AWS account.
This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
Deletes a map resource from your AWS account.
This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.
Default Value: false
Valid Values: false | true
Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
Default Value: false
Valid Values: false | true
Set to include the geometry details in the result for each path between a pair of positions.
Default Value: false
Valid Values: false | true
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Contains details about additional route preferences for requests that specify TravelMode as Car.
Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car.
Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car.
The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.
Valid Values: [-180 to 180,-90 to 90]
The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.
Valid Values: [-180 to 180,-90 to 90]
Returns the result of the route matrix calculation.
", + "refs": { + } + }, + "CalculateRouteMatrixResponseSnappedDeparturePositionsList": { + "base": null, + "refs": { + "CalculateRouteMatrixResponse$SnappedDeparturePositions": "For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.
The list of destination positions for the route matrix used for calculation of the RouteMatrix.
A summary of the calculated route matrix.
", + "refs": { + "CalculateRouteMatrixResponse$Summary": "Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
" + } + }, + "CalculateRouteMatrixSummaryRouteCountInteger": { + "base": null, + "refs": { + "CalculateRouteMatrixSummary$RouteCount": "The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.
Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]
If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
Specifying more than 23 waypoints returns a 400 ValidationException error.
If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]
Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]
If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
Specifying more than 23 waypoints returns a 400 ValidationException error.
If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]
Contains details about additional route preferences for requests that specify TravelMode as Truck.
Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
Requirements: TravelMode must be specified as Truck.
Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
Requirements: TravelMode must be specified as Truck.
Set the unit system to specify the distance.
Default Value: Kilometers
The unit of measurement for route distances.
", "CalculateRouteRequest$DistanceUnit": "Set the unit system to specify the distance.
Default Value: Kilometers
The unit of measurement for route distances.
" } @@ -792,7 +850,7 @@ } }, "Leg": { - "base": "Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
The StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
The StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
The StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
The StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
The start position for the route. Defined in WGS 84 format: [longitude, latitude].
For example, [-123.115, 49.285]
If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]
The finish position for the route. Defined in WGS 84 format: [longitude, latitude].
For example, [-122.339, 47.615]
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
Valid Values: [-180 to 180,-90 to 90]
The start position for the route. Defined in WGS 84 format: [longitude, latitude].
For example, [-123.115, 49.285]
If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]
The finish position for the route. Defined in WGS 84 format: [longitude, latitude].
For example, [-122.339, 47.615]
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
Valid Values: [-180 to 180,-90 to 90]
The last known device position.
", "DevicePositionUpdate$Position": "The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].
The last known device position.
", - "Leg$EndPosition": "The terminating position of the leg. Follows the format [longitude,latitude].
If the EndPosition isn't located on a road, it's snapped to a nearby road.
The starting position of the leg. Follows the format [longitude,latitude].
If the StartPosition isn't located on a road, it's snapped to a nearby road.
The terminating position of the leg. Follows the format [longitude,latitude].
If the EndPosition isn't located on a road, it's snapped to a nearby road.
The starting position of the leg. Follows the format [longitude,latitude].
If the StartPosition isn't located on a road, it's snapped to a nearby road.
The last known device position. Empty if no positions currently stored.
", @@ -1141,26 +1203,26 @@ "PricingPlan": { "base": null, "refs": { - "CreateGeofenceCollectionRequest$PricingPlan": "Optionally specifies the pricing plan for the geofence collection. Defaults to RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", - "CreateMapRequest$PricingPlan": "Optionally specifies the pricing plan for the map resource. Defaults to RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "CreatePlaceIndexRequest$PricingPlan": "Optionally specifies the pricing plan for the place index resource. Defaults to RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "CreateRouteCalculatorRequest$PricingPlan": "Optionally specifies the pricing plan for the route calculator resource. Defaults to RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "CreateTrackerRequest$PricingPlan": "Optionally specifies the pricing plan for the tracker resource. Defaults to RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "DescribeGeofenceCollectionResponse$PricingPlan": "The pricing plan selected for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", - "DescribeMapResponse$PricingPlan": "The pricing plan selected for the specified map resource.
<p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p> The pricing plan selected for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "DescribeRouteCalculatorResponse$PricingPlan": "The pricing plan selected for the specified route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "DescribeTrackerResponse$PricingPlan": "The pricing plan selected for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "ListGeofenceCollectionsResponseEntry$PricingPlan": "The pricing plan for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", - "ListMapsResponseEntry$PricingPlan": "The pricing plan for the specified map resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "ListPlaceIndexesResponseEntry$PricingPlan": "The pricing plan for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "ListRouteCalculatorsResponseEntry$PricingPlan": "The pricing plan for the specified route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "ListTrackersResponseEntry$PricingPlan": "The pricing plan for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "UpdateGeofenceCollectionRequest$PricingPlan": "Updates the pricing plan for the geofence collection.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
", - "UpdateMapRequest$PricingPlan": "Updates the pricing plan for the map resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
", - "UpdatePlaceIndexRequest$PricingPlan": "Updates the pricing plan for the place index resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
", - "UpdateRouteCalculatorRequest$PricingPlan": "Updates the pricing plan for the route calculator resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
", - "UpdateTrackerRequest$PricingPlan": "Updates the pricing plan for the tracker resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
" + "CreateGeofenceCollectionRequest$PricingPlan": "No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. Always returns RequestBasedUsage.
No longer used. Always returns RequestBasedUsage.
No longer used. Always returns RequestBasedUsage.
Always returns RequestBasedUsage.
Always returns RequestBasedUsage.
No longer used. Always returns RequestBasedUsage.
No longer used. Always returns RequestBasedUsage.
No longer used. Always returns RequestBasedUsage.
Always returns RequestBasedUsage.
Always returns RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
The geofence collection used in evaluating the position of devices against its geofences.
", "BatchPutGeofenceRequest$CollectionName": "The geofence collection storing the geofences.
", "BatchUpdateDevicePositionRequest$TrackerName": "The name of the tracker resource to update.
", + "CalculateRouteMatrixRequest$CalculatorName": "The name of the route calculator resource that you want to use to calculate the route matrix.
", "CalculateRouteRequest$CalculatorName": "The name of the route calculator resource that you want to use to calculate the route.
", "CreateGeofenceCollectionRequest$CollectionName": "A custom name for the geofence collection.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique geofence collection name.
No spaces allowed. For example, ExampleGeofenceCollection.
The name for the geofence collection.
", @@ -1291,6 +1354,48 @@ "refs": { } }, + "RouteMatrix": { + "base": null, + "refs": { + "CalculateRouteMatrixResponse$RouteMatrix": "The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.
The result for one SnappedDeparturePosition SnappedDestinationPosition pair.
The total distance of travel for the route.
" + } + }, + "RouteMatrixEntryDurationSecondsDouble": { + "base": null, + "refs": { + "RouteMatrixEntry$DurationSeconds": "The expected duration of travel for the route.
" + } + }, + "RouteMatrixEntryError": { + "base": "An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.
The error code can be one of the following:
RouteNotFound - Unable to find a valid route with the given parameters.
RouteTooLong - Route calculation went beyond the maximum size of a route and was terminated before completion.
PositionsNotFound - One or more of the input positions were not found on the route network.
DestinationPositionNotFound - The destination position was not found on the route network.
DeparturePositionNotFound - The departure position was not found on the route network.
OtherValidationError - The given inputs were not valid or a route was not found. More information is given in the error Message
An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.
The type of error which occurred for the route calculation.
" + } + }, + "RouteMatrixRow": { + "base": null, + "refs": { + "RouteMatrix$member": null + } + }, "SearchForPositionResult": { "base": "Contains a search result from a position search query that is run on a place index resource.
", "refs": { @@ -1439,17 +1544,18 @@ "refs": { "AccessDeniedException$Message": null, "BatchItemError$Message": "A message with the reason for the batch request error.
", + "CalculateRouteMatrixSummary$DataSource": "The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
", "CalculateRouteSummary$DataSource": "The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
", "ConflictException$Message": null, - "CreateGeofenceCollectionRequest$PricingPlanDataSource": "Specifies the data provider for the geofence collection.
Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement
For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.
Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account or Region unless you move it.
Valid Values: Esri | Here
This parameter is no longer used.
", "CreatePlaceIndexRequest$DataSource": "Specifies the geospatial data provider for the new place index.
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
Valid values include:
Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.
Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.
If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
", "CreateRouteCalculatorRequest$DataSource": "Specifies the data provider of traffic and road network data.
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error. Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.
Valid values include:
Esri – For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.
Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
", - "CreateTrackerRequest$PricingPlanDataSource": "Specifies the data provider for the tracker resource.
Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement
For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.
Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.
Valid values: Esri | Here
The specified data provider for the geofence collection.
", + "CreateTrackerRequest$PricingPlanDataSource": "This parameter is no longer used.
", + "DescribeGeofenceCollectionResponse$PricingPlanDataSource": "No longer used. Always returns an empty string.
", "DescribeMapResponse$DataSource": "Specifies the data provider for the associated map tiles.
", "DescribePlaceIndexResponse$DataSource": "The data provider of geospatial data. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
", "DescribeRouteCalculatorResponse$DataSource": "The data provider of traffic and road network data. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
", - "DescribeTrackerResponse$PricingPlanDataSource": "The specified data provider for the tracker resource.
", + "DescribeTrackerResponse$PricingPlanDataSource": "No longer used. Always returns an empty string.
", "GetGeofenceResponse$Status": "Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.
PENDING — The geofence is being processed by the system.
FAILED — The geofence failed to be indexed by the system.
DELETED — The geofence has been deleted from the system index.
DELETING — The geofence is being deleted from the system index.
A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.
Valid fonts stacks for Esri styles:
VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold
VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold
VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold
Valid font stacks for HERE Technologies styles:
VectorHereBerlin – Fira GO Regular | Fira GO Bold
The map glyph content type. For example, application/octet-stream.
The style descriptor's content type. For example, application/json.
The map tile's content type. For example, application/vnd.mapbox-vector-tile.
The specified data provider for the geofence collection.
", + "ListGeofenceCollectionsResponseEntry$PricingPlanDataSource": "No longer used. Always returns an empty string.
", "ListGeofenceResponseEntry$Status": "Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.
PENDING — The geofence is being processed by the system.
FAILED — The geofence failed to be indexed by the system.
DELETED — The geofence has been deleted from the system index.
DELETING — The geofence is being deleted from the system index.
Specifies the data provider for the associated map tiles.
", "ListPlaceIndexesResponseEntry$DataSource": "The data provider of geospatial data. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
", "ListRouteCalculatorsResponseEntry$DataSource": "The data provider of traffic and road network data. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
", - "ListTrackersResponseEntry$PricingPlanDataSource": "The specified data provider for the tracker resource.
", + "ListTrackersResponseEntry$PricingPlanDataSource": "No longer used. Always returns an empty string.
", "Place$AddressNumber": "The numerical portion of an address, such as a building number.
", "Place$Country": "A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.
The name for a street or a road to identify a location. For example, Main Street.
A country, or an area that's part of a larger region. For example, Metro Vancouver.
A message about the error that occurred for the route calculation.
", "SearchForSuggestionsResult$Text": "The text of the place suggestion, typically formatted as an address string.
", "SearchPlaceIndexForPositionSummary$DataSource": "The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
", "SearchPlaceIndexForSuggestionsSummary$DataSource": "The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
", @@ -1481,8 +1588,8 @@ "TagKeys$member": null, "ThrottlingException$Message": null, "TimeZone$Name": "The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles.
Updates the data provider for the geofence collection.
A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement
For more information about data providers and pricing plans, see the Amazon Location Service product page.
This can only be updated when updating the PricingPlan in the same request.
Amazon Location Service uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.
Updates the data provider for the tracker resource.
A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement
For more information about data providers and pricing plans, see the Amazon Location Service product page
This can only be updated when updating the PricingPlan in the same request.
Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.
This parameter is no longer used.
", + "UpdateTrackerRequest$PricingPlanDataSource": "This parameter is no longer used.
", "ValidationException$Message": null, "ValidationExceptionField$Message": "A message with the reason for the validation exception error.
", "ValidationExceptionField$Name": "The field name where the invalid entry was detected.
" @@ -1575,6 +1682,7 @@ "BatchPutGeofenceSuccess$CreateTime": "The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.
Setting a departure time in the past returns a 400 ValidationException error.
In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
Setting a departure time in the past returns a 400 ValidationException error.
In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The TravelMode you specify determines how you specify route preferences:
If traveling by Car use the CarModeOptions parameter.
If traveling by Truck use the TruckModeOptions parameter.
Default Value: Car
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The TravelMode you specify also determines how you specify route preferences:
If traveling by Car use the CarModeOptions parameter.
If traveling by Truck use the TruckModeOptions parameter.
Default Value: Car
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The TravelMode you specify also determines how you specify route preferences:
If traveling by Car use the CarModeOptions parameter.
If traveling by Truck use the TruckModeOptions parameter.
Default Value: Car
Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.
Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.
", - "DeleteBandwidthRateLimit": "Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported for the stored volume, cached volume and tape gateway types.
", + "DeleteBandwidthRateLimit": "Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types.
", "DeleteChapCredentials": "Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.
", "DeleteFileShare": "Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.
", "DeleteGateway": "Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.
After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.
You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the Storage Gateway detail page.
Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.
", "DeleteVolume": "Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.
Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
", "DescribeAvailabilityMonitorTest": "Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
", - "DescribeBandwidthRateLimit": "Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported for the stored volume, cached volume, and tape gateway types.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", - "DescribeBandwidthRateLimitSchedule": "Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only in the volume and tape gateway types.
This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading
If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "DescribeBandwidthRateLimit": "Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.
This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "DescribeBandwidthRateLimitSchedule": "Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.
This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading
If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", "DescribeCache": "Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
", "DescribeCachediSCSIVolumes": "Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.
The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
", "DescribeChapCredentials": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
", @@ -78,8 +78,8 @@ "StartAvailabilityMonitorTest": "Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.
Starting this test will cause your gateway to go offline for a brief period.
Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
", "UpdateAutomaticTapeCreationPolicy": "Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
A gateway can have only one automatic tape creation policy.
Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported for the stored volume, cached volume, and tape gateway types.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
", - "UpdateBandwidthRateLimitSchedule": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported in the volume and tape gateway types.
", + "UpdateBandwidthRateLimit": "Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "UpdateBandwidthRateLimitSchedule": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.
", "UpdateChapCredentials": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
Updates a file system association. This operation is only supported in the FSx File Gateways.
", "UpdateGatewayInformation": "Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
For additional details and restrictions on each pricing plan option, - // see Amazon Location - // Service pricing.
+ // No longer used. Always returns RequestBasedUsage. // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` // Tags associated with the map resource. Tags map[string]*string `type:"map"` @@ -9294,13 +9743,10 @@ type DescribePlaceIndexOutput struct { // IndexName is a required field IndexName *string `min:"1" type:"string" required:"true"` - // The pricing plan selected for the specified place index resource. + // No longer used. Always returns RequestBasedUsage. // - // For additional details and restrictions on each pricing plan option, see - // Amazon Location Service pricing (https://aws.amazon.com/location/pricing/). - // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` // Tags associated with place index resource. Tags map[string]*string `type:"map"` @@ -9475,13 +9921,10 @@ type DescribeRouteCalculatorOutput struct { // Description is a required field Description *string `type:"string" required:"true"` - // The pricing plan selected for the specified route calculator resource. - // - // For additional details and restrictions on each pricing plan option, see - // Amazon Location Service pricing (https://aws.amazon.com/location/pricing/). + // Always returns RequestBasedUsage. // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` // Tags associated with route calculator resource. Tags map[string]*string `type:"map"` @@ -9631,16 +10074,15 @@ type DescribeTrackerOutput struct { // The position filtering method of the tracker resource. PositionFiltering *string `type:"string" enum:"PositionFiltering"` - // The pricing plan selected for the specified tracker resource. + // Always returns RequestBasedUsage. // - // For additional details and restrictions on each pricing plan option, see - // Amazon Location Service pricing (https://aws.amazon.com/location/pricing/). - // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` - // The specified data provider for the tracker resource. - PricingPlanDataSource *string `type:"string"` + // No longer used. Always returns an empty string. + // + // Deprecated: Deprecated. Unused. + PricingPlanDataSource *string `deprecated:"true" type:"string"` // The tags associated with the tracker resource. Tags map[string]*string `type:"map"` @@ -11137,7 +11579,7 @@ func (s *InternalServerException) RequestID() string { // of positions in the request. // // For example, a route with a departure position and destination position returns -// one leg with the positions snapped to a nearby road (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road): +// one leg with the positions snapped to a nearby road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html): // // * The StartPosition is the departure position. // @@ -11173,7 +11615,7 @@ type Leg struct { // The terminating position of the leg. Follows the format [longitude,latitude]. // // If the EndPosition isn't located on a road, it's snapped to a nearby road - // (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road). + // (https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html). // // EndPosition is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Leg's @@ -11188,7 +11630,7 @@ type Leg struct { // The starting position of the leg. Follows the format [longitude,latitude]. // // If the StartPosition isn't located on a road, it's snapped to a nearby road - // (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road). + // (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html). // // StartPosition is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Leg's @@ -11628,16 +12070,15 @@ type ListGeofenceCollectionsResponseEntry struct { // Description is a required field Description *string `type:"string" required:"true"` - // The pricing plan for the specified geofence collection. - // - // For additional details and restrictions on each pricing plan option, see - // the Amazon Location Service pricing page (https://aws.amazon.com/location/pricing/). + // No longer used. Always returns RequestBasedUsage. // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` - // The specified data provider for the geofence collection. - PricingPlanDataSource *string `type:"string"` + // No longer used. Always returns an empty string. + // + // Deprecated: Deprecated. Unused. + PricingPlanDataSource *string `deprecated:"true" type:"string"` // Specifies a timestamp for when the resource was last updated in ISO 8601 // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ @@ -12028,13 +12469,10 @@ type ListMapsResponseEntry struct { // MapName is a required field MapName *string `min:"1" type:"string" required:"true"` - // The pricing plan for the specified map resource. - // - // For additional details and restrictions on each pricing plan option, see - // Amazon Location Service pricing (https://aws.amazon.com/location/pricing/). + // No longer used. Always returns RequestBasedUsage. // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` // The timestamp for when the map resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) // format: YYYY-MM-DDThh:mm:ss.sssZ. @@ -12234,13 +12672,10 @@ type ListPlaceIndexesResponseEntry struct { // IndexName is a required field IndexName *string `min:"1" type:"string" required:"true"` - // The pricing plan for the specified place index resource. + // No longer used. Always returns RequestBasedUsage. // - // For additional details and restrictions on each pricing plan option, see - // Amazon Location Service pricing (https://aws.amazon.com/location/pricing/). - // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` // The timestamp for when the place index resource was last updated in ISO 8601 // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. @@ -12442,13 +12877,10 @@ type ListRouteCalculatorsResponseEntry struct { // Description is a required field Description *string `type:"string" required:"true"` - // The pricing plan for the specified route calculator resource. - // - // For additional details and restrictions on each pricing plan option, see - // Amazon Location Service pricing (https://aws.amazon.com/location/pricing/). + // Always returns RequestBasedUsage. // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` // The timestamp when the route calculator resource was last updated in ISO // 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. @@ -12839,16 +13271,15 @@ type ListTrackersResponseEntry struct { // Description is a required field Description *string `type:"string" required:"true"` - // The pricing plan for the specified tracker resource. + // Always returns RequestBasedUsage. // - // For additional details and restrictions on each pricing plan option, see - // Amazon Location Service pricing (https://aws.amazon.com/location/pricing/). - // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Deprecated: Deprecated. Always returns RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` - // The specified data provider for the tracker resource. - PricingPlanDataSource *string `type:"string"` + // No longer used. Always returns an empty string. + // + // Deprecated: Deprecated. Unused. + PricingPlanDataSource *string `deprecated:"true" type:"string"` // The name of the tracker resource. // @@ -13449,6 +13880,120 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } +// The result for one SnappedDeparturePosition SnappedDestinationPosition pair. +type RouteMatrixEntry struct { + _ struct{} `type:"structure"` + + // The total distance of travel for the route. + Distance *float64 `type:"double"` + + // The expected duration of travel for the route. + DurationSeconds *float64 `type:"double"` + + // An error corresponding to the calculation of a route between the DeparturePosition + // and DestinationPosition. + Error *RouteMatrixEntryError `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouteMatrixEntry) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouteMatrixEntry) GoString() string { + return s.String() +} + +// SetDistance sets the Distance field's value. +func (s *RouteMatrixEntry) SetDistance(v float64) *RouteMatrixEntry { + s.Distance = &v + return s +} + +// SetDurationSeconds sets the DurationSeconds field's value. +func (s *RouteMatrixEntry) SetDurationSeconds(v float64) *RouteMatrixEntry { + s.DurationSeconds = &v + return s +} + +// SetError sets the Error field's value. +func (s *RouteMatrixEntry) SetError(v *RouteMatrixEntryError) *RouteMatrixEntry { + s.Error = v + return s +} + +// An error corresponding to the calculation of a route between the DeparturePosition +// and DestinationPosition. +// +// The error code can be one of the following: +// +// * RouteNotFound - Unable to find a valid route with the given parameters. +// +// * RouteTooLong - Route calculation went beyond the maximum size of a route +// and was terminated before completion. +// +// * PositionsNotFound - One or more of the input positions were not found +// on the route network. +// +// * DestinationPositionNotFound - The destination position was not found +// on the route network. +// +// * DeparturePositionNotFound - The departure position was not found on +// the route network. +// +// * OtherValidationError - The given inputs were not valid or a route was +// not found. More information is given in the error Message +type RouteMatrixEntryError struct { + _ struct{} `type:"structure"` + + // The type of error which occurred for the route calculation. + // + // Code is a required field + Code *string `type:"string" required:"true" enum:"RouteMatrixErrorCode"` + + // A message about the error that occurred for the route calculation. + Message *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouteMatrixEntryError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouteMatrixEntryError) GoString() string { + return s.String() +} + +// SetCode sets the Code field's value. +func (s *RouteMatrixEntryError) SetCode(v string) *RouteMatrixEntryError { + s.Code = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *RouteMatrixEntryError) SetMessage(v string) *RouteMatrixEntryError { + s.Message = &v + return s +} + // Contains a search result from a position search query that is run on a place // index resource. type SearchForPositionResult struct { @@ -15132,26 +15677,15 @@ type UpdateGeofenceCollectionInput struct { // Updates the description for the geofence collection. Description *string `type:"string"` - // Updates the pricing plan for the geofence collection. + // No longer used. If included, the only allowed value is RequestBasedUsage. // - // For more information about each pricing plan option restrictions, see Amazon - // Location Service pricing (https://aws.amazon.com/location/pricing/). - PricingPlan *string `type:"string" enum:"PricingPlan"` + // Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` - // Updates the data provider for the geofence collection. - // - // A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement - // - // For more information about data providers (https://aws.amazon.com/location/data-providers/) - // and pricing plans (https://aws.amazon.com/location/pricing/), see the Amazon - // Location Service product page. + // This parameter is no longer used. // - // This can only be updated when updating the PricingPlan in the same request. - // - // Amazon Location Service uses PricingPlanDataSource to calculate billing for - // your geofence collection. Your data won't be shared with the data provider, - // and will remain in your AWS account and Region unless you move it. - PricingPlanDataSource *string `type:"string"` + // Deprecated: Deprecated. No longer allowed. + PricingPlanDataSource *string `deprecated:"true" type:"string"` } // String returns the string representation. @@ -15282,11 +15816,10 @@ type UpdateMapInput struct { // MapName is a required field MapName *string `location:"uri" locationName:"MapName" min:"1" type:"string" required:"true"` - // Updates the pricing plan for the map resource. + // No longer used. If included, the only allowed value is RequestBasedUsage. // - // For more information about each pricing plan option restrictions, see Amazon - // Location Service pricing (https://aws.amazon.com/location/pricing/). - PricingPlan *string `type:"string" enum:"PricingPlan"` + // Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` } // String returns the string representation. @@ -15414,11 +15947,10 @@ type UpdatePlaceIndexInput struct { // IndexName is a required field IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"` - // Updates the pricing plan for the place index resource. + // No longer used. If included, the only allowed value is RequestBasedUsage. // - // For more information about each pricing plan option restrictions, see Amazon - // Location Service pricing (https://aws.amazon.com/location/pricing/). - PricingPlan *string `type:"string" enum:"PricingPlan"` + // Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` } // String returns the string representation. @@ -15549,11 +16081,10 @@ type UpdateRouteCalculatorInput struct { // Updates the description for the route calculator resource. Description *string `type:"string"` - // Updates the pricing plan for the route calculator resource. + // No longer used. If included, the only allowed value is RequestBasedUsage. // - // For more information about each pricing plan option restrictions, see Amazon - // Location Service pricing (https://aws.amazon.com/location/pricing/). - PricingPlan *string `type:"string" enum:"PricingPlan"` + // Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` } // String returns the string representation. @@ -15700,26 +16231,15 @@ type UpdateTrackerInput struct { // evaluations. PositionFiltering *string `type:"string" enum:"PositionFiltering"` - // Updates the pricing plan for the tracker resource. + // No longer used. If included, the only allowed value is RequestBasedUsage. // - // For more information about each pricing plan option restrictions, see Amazon - // Location Service pricing (https://aws.amazon.com/location/pricing/). - PricingPlan *string `type:"string" enum:"PricingPlan"` + // Deprecated: Deprecated. If included, the only allowed value is RequestBasedUsage. + PricingPlan *string `deprecated:"true" type:"string" enum:"PricingPlan"` - // Updates the data provider for the tracker resource. - // - // A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement - // - // For more information about data providers (https://aws.amazon.com/location/data-providers/) - // and pricing plans (https://aws.amazon.com/location/pricing/), see the Amazon - // Location Service product page + // This parameter is no longer used. // - // This can only be updated when updating the PricingPlan in the same request. - // - // Amazon Location Service uses PricingPlanDataSource to calculate billing for - // your tracker resource. Your data won't be shared with the data provider, - // and will remain in your AWS account and Region unless you move it. - PricingPlanDataSource *string `type:"string"` + // Deprecated: Deprecated. No longer allowed. + PricingPlanDataSource *string `deprecated:"true" type:"string"` // The name of the tracker resource to update. // @@ -16090,6 +16610,38 @@ func PricingPlan_Values() []string { } } +const ( + // RouteMatrixErrorCodeRouteNotFound is a RouteMatrixErrorCode enum value + RouteMatrixErrorCodeRouteNotFound = "RouteNotFound" + + // RouteMatrixErrorCodeRouteTooLong is a RouteMatrixErrorCode enum value + RouteMatrixErrorCodeRouteTooLong = "RouteTooLong" + + // RouteMatrixErrorCodePositionsNotFound is a RouteMatrixErrorCode enum value + RouteMatrixErrorCodePositionsNotFound = "PositionsNotFound" + + // RouteMatrixErrorCodeDestinationPositionNotFound is a RouteMatrixErrorCode enum value + RouteMatrixErrorCodeDestinationPositionNotFound = "DestinationPositionNotFound" + + // RouteMatrixErrorCodeDeparturePositionNotFound is a RouteMatrixErrorCode enum value + RouteMatrixErrorCodeDeparturePositionNotFound = "DeparturePositionNotFound" + + // RouteMatrixErrorCodeOtherValidationError is a RouteMatrixErrorCode enum value + RouteMatrixErrorCodeOtherValidationError = "OtherValidationError" +) + +// RouteMatrixErrorCode_Values returns all elements of the RouteMatrixErrorCode enum +func RouteMatrixErrorCode_Values() []string { + return []string{ + RouteMatrixErrorCodeRouteNotFound, + RouteMatrixErrorCodeRouteTooLong, + RouteMatrixErrorCodePositionsNotFound, + RouteMatrixErrorCodeDestinationPositionNotFound, + RouteMatrixErrorCodeDeparturePositionNotFound, + RouteMatrixErrorCodeOtherValidationError, + } +} + const ( // TravelModeCar is a TravelMode enum value TravelModeCar = "Car" diff --git a/service/locationservice/locationserviceiface/interface.go b/service/locationservice/locationserviceiface/interface.go index 81324180f5f..f7a24db8b1c 100644 --- a/service/locationservice/locationserviceiface/interface.go +++ b/service/locationservice/locationserviceiface/interface.go @@ -92,6 +92,10 @@ type LocationServiceAPI interface { CalculateRouteWithContext(aws.Context, *locationservice.CalculateRouteInput, ...request.Option) (*locationservice.CalculateRouteOutput, error) CalculateRouteRequest(*locationservice.CalculateRouteInput) (*request.Request, *locationservice.CalculateRouteOutput) + CalculateRouteMatrix(*locationservice.CalculateRouteMatrixInput) (*locationservice.CalculateRouteMatrixOutput, error) + CalculateRouteMatrixWithContext(aws.Context, *locationservice.CalculateRouteMatrixInput, ...request.Option) (*locationservice.CalculateRouteMatrixOutput, error) + CalculateRouteMatrixRequest(*locationservice.CalculateRouteMatrixInput) (*request.Request, *locationservice.CalculateRouteMatrixOutput) + CreateGeofenceCollection(*locationservice.CreateGeofenceCollectionInput) (*locationservice.CreateGeofenceCollectionOutput, error) CreateGeofenceCollectionWithContext(aws.Context, *locationservice.CreateGeofenceCollectionInput, ...request.Option) (*locationservice.CreateGeofenceCollectionOutput, error) CreateGeofenceCollectionRequest(*locationservice.CreateGeofenceCollectionInput) (*request.Request, *locationservice.CreateGeofenceCollectionOutput) diff --git a/service/storagegateway/api.go b/service/storagegateway/api.go index 60845382194..1b45b30f0e8 100644 --- a/service/storagegateway/api.go +++ b/service/storagegateway/api.go @@ -1925,8 +1925,8 @@ func (c *StorageGateway) DeleteBandwidthRateLimitRequest(input *DeleteBandwidthR // upload and download bandwidth rate limit, or you can delete both. If you // delete only one of the limits, the other limit remains unchanged. To specify // which gateway to work with, use the Amazon Resource Name (ARN) of the gateway -// in your request. This operation is supported for the stored volume, cached -// volume and tape gateway types. +// in your request. This operation is supported only for the stored volume, +// cached volume, and tape gateway types. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2817,10 +2817,11 @@ func (c *StorageGateway) DescribeBandwidthRateLimitRequest(input *DescribeBandwi // // Returns the bandwidth rate limits of a gateway. By default, these limits // are not set, which means no bandwidth rate limiting is in effect. This operation -// is supported for the stored volume, cached volume, and tape gateway types. +// is supported only for the stored volume, cached volume, and tape gateway +// types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule. // -// This operation only returns a value for a bandwidth rate limit only if the -// limit is set. If no limits are set for the gateway, then this operation returns +// This operation returns a value for a bandwidth rate limit only if the limit +// is set. If no limits are set for the gateway, then this operation returns // only the gateway ARN in the response body. To specify which gateway to describe, // use the Amazon Resource Name (ARN) of the gateway in your request. // @@ -2909,7 +2910,8 @@ func (c *StorageGateway) DescribeBandwidthRateLimitScheduleRequest(input *Descri // Returns information about the bandwidth rate limit schedule of a gateway. // By default, gateways do not have bandwidth rate limit schedules, which means // no bandwidth rate limiting is in effect. This operation is supported only -// in the volume and tape gateway types. +// for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth +// rate limits. // // This operation returns information about a gateway's bandwidth rate limit // schedule. A bandwidth rate limit schedule consists of one or more bandwidth @@ -7602,7 +7604,8 @@ func (c *StorageGateway) UpdateBandwidthRateLimitRequest(input *UpdateBandwidthR // Updates the bandwidth rate limits of a gateway. You can update both the upload // and download bandwidth rate limit or specify only one of the two. If you // don't set a bandwidth rate limit, the existing rate limit remains. This operation -// is supported for the stored volume, cached volume, and tape gateway types. +// is supported only for the stored volume, cached volume, and tape gateway +// types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule. // // By default, a gateway's bandwidth rate limits are not set. If you don't set // any limit, the gateway does not have any limitations on its bandwidth usage @@ -7696,8 +7699,8 @@ func (c *StorageGateway) UpdateBandwidthRateLimitScheduleRequest(input *UpdateBa // Updates the bandwidth rate limit schedule for a specified gateway. By default, // gateways do not have bandwidth rate limit schedules, which means no bandwidth // rate limiting is in effect. Use this to initiate or update a gateway's bandwidth -// rate limit schedule. This operation is supported in the volume and tape gateway -// types. +// rate limit schedule. This operation is supported only for volume, tape and +// S3 file gateways. FSx file gateways do not support bandwidth rate limits. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about