Creates an endpoint for an Amazon EFS file system.
", "CreateLocationFsxWindows": "Creates an endpoint for an Amazon FSx for Windows File Server file system.
", "CreateLocationNfs": "Defines a file system on a Network File System (NFS) server that can be read from or written to.
", - "CreateLocationObjectStorage": "Creates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see create-object-location.
", + "CreateLocationObjectStorage": "Creates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a location for object storage.
", "CreateLocationS3": "Creates an endpoint for an Amazon S3 bucket.
For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli in the AWS DataSync User Guide.
", "CreateLocationSmb": "Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
", "CreateTask": "Creates a task.
A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.
When you create a task that transfers data between AWS services in different AWS Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.
You can transfer data between commercial AWS Regions except for China, or between AWS GovCloud (US-East and US-West) Regions.
When you use DataSync to copy files or objects between AWS Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.
Returns metadata, such as the path information about an Amazon EFS location.
", "DescribeLocationFsxWindows": "Returns metadata, such as the path information about an Amazon FSx for Windows File Server location.
", "DescribeLocationNfs": "Returns metadata, such as the path information, about an NFS location.
", - "DescribeLocationObjectStorage": "Returns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see create-object-location.
", + "DescribeLocationObjectStorage": "Returns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see Creating a location for object storage.
", "DescribeLocationS3": "Returns metadata, such as bucket name, about an Amazon S3 bucket location.
", "DescribeLocationSmb": "Returns metadata, such as the path and user information about an SMB location.
", "DescribeTask": "Returns metadata about a task.
", @@ -32,9 +32,9 @@ "TagResource": "Applies a key-value pair to an AWS resource.
", "UntagResource": "Removes a tag from an AWS resource.
", "UpdateAgent": "Updates the name of an agent.
", - "UpdateLocationNfs": "Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see create-nfs-location.
", - "UpdateLocationObjectStorage": "Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see create-object-location.
", - "UpdateLocationSmb": "Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see create-smb-location.
", + "UpdateLocationNfs": "Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
", + "UpdateLocationObjectStorage": "Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage.
", + "UpdateLocationSmb": "Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.
", "UpdateTask": "Updates the metadata associated with a task.
", "UpdateTaskExecution": "Updates execution of a task.
You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.
The only Option that can be modified by UpdateTaskExecution is BytesPerSecond .
The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
", - "CreateLocationS3Request$AgentArns": "If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an AWS Outpost, see outposts-agent.
", + "CreateLocationS3Request$AgentArns": "If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an AWS Outpost, see Deploy your DataSync agent on AWS Outposts.
", "CreateLocationSmbRequest$AgentArns": "The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
", "DescribeLocationObjectStorageResponse$AgentArns": "The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
", - "DescribeLocationS3Response$AgentArns": "If you are using DataSync on an AWS Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an AWS Outpost, see outposts-agent.
", + "DescribeLocationS3Response$AgentArns": "If you are using DataSync on an AWS Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an AWS Outpost, see Deploy your DataSync agent on AWS Outposts.
", "DescribeLocationSmbResponse$AgentArns": "The Amazon Resource Name (ARN) of the source SMB file system location that is created.
", "OnPremConfig$AgentArns": "ARNs of the agents to use for an NFS location.
", "UpdateLocationObjectStorageRequest$AgentArns": "The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
", @@ -78,7 +78,7 @@ } }, "AgentListEntry": { - "base": "Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents operation is called.
Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents operation is called.
Specifies which files, folders and objects to include or exclude when transferring files from source to destination.
", + "base": "Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
", "refs": { "FilterList$member": null } @@ -437,13 +437,13 @@ "Gid": { "base": null, "refs": { - "Options$Gid": "The group ID (GID) of the file's owners.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
NONE: Ignore UID and GID.
" + "Options$Gid": "The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
NONE: Ignore UID and GID.
" } }, "IamRoleArn": { "base": null, "refs": { - "S3Config$BucketAccessRoleArn": "The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.
" + "S3Config$BucketAccessRoleArn": "The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.
" } }, "InputTagList": { @@ -577,7 +577,7 @@ } }, "LocationListEntry": { - "base": "Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.
Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.
The URL of the source NFS location that was described.
", "DescribeLocationObjectStorageResponse$LocationUri": "The URL of the source self-managed object storage server location that was described.
", "DescribeLocationS3Response$LocationUri": "The URL of the Amazon S3 location that was described.
", - "DescribeLocationSmbResponse$LocationUri": "The URL of the source SBM location that was described.
", - "LocationListEntry$LocationUri": "Represents a list of URLs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.
Format: TYPE://GLOBAL_ID/SUBDIR.
TYPE designates the type of location. Valid values: NFS | EFS | S3.
GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).
SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.
" + "DescribeLocationSmbResponse$LocationUri": "The URL of the source SMB location that was described.
", + "LocationListEntry$LocationUri": "Represents a list of URLs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.
Format: TYPE://GLOBAL_ID/SUBDIR.
TYPE designates the type of location. Valid values: NFS | EFS | S3.
GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).
SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.
" } }, "LogGroupArn": { @@ -621,7 +621,7 @@ "Mtime": { "base": null, "refs": { - "Options$Mtime": "A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
Default value: PRESERVE.
PRESERVE: Preserve original Mtime (recommended)
NONE: Ignore Mtime.
If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
If Mtime is set to NONE, Atime must also be set to NONE.
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
Default value: PRESERVE.
PRESERVE: Preserve original Mtime (recommended)
NONE: Ignore Mtime.
If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
If Mtime is set to NONE, Atime must also be set to NONE.
The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.
The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see API filters for ListTasks and ListLocations.
The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see API filters for ListTasks and ListLocations.
Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.
A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.
Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.
A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.
The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.
For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the operation.
The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.
For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.
The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.
For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.
The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.
For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to StartTaskExecution operation.
A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
" + "Options$OverwriteMode": "A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the AWS DataSync User Guide.
" } }, "PLSecurityGroupArnList": { "base": null, "refs": { - "CreateAgentRequest$SecurityGroupArns": "The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.
", + "CreateAgentRequest$SecurityGroupArns": "The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
", "PrivateLinkConfig$SecurityGroupArns": "The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.
" } }, @@ -767,19 +767,19 @@ "PosixPermissions": { "base": null, "refs": { - "Options$PosixPermissions": "A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
" + "Options$PreserveDeletedFiles": "A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
" } }, "PreserveDevices": { "base": null, "refs": { - "Options$PreserveDevices": "A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
Default value: NONE.
NONE: Ignore special devices (recommended).
PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
" + "Options$PreserveDevices": "A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
Default value: NONE.
NONE: Ignore special devices (recommended).
PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
" } }, "PrivateLinkConfig": { @@ -804,8 +804,8 @@ "S3StorageClass": { "base": null, "refs": { - "CreateLocationS3Request$S3StorageClass": "The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in AWS Regions, the storage class defaults to Standard. For buckets on AWS Outposts, the storage class defaults to AWS S3 Outposts.
For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.
", - "DescribeLocationS3Response$S3StorageClass": "The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.
" + "CreateLocationS3Request$S3StorageClass": "The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in AWS Regions, the storage class defaults to Standard. For buckets on AWS Outposts, the storage class defaults to AWS S3 Outposts.
For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.
", + "DescribeLocationS3Response$S3StorageClass": "The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.
" } }, "S3Subdirectory": { @@ -856,6 +856,12 @@ "UpdateLocationSmbRequest$Password": "The password of the user who can mount the share has the permissions to access files and folders in the SMB share.
" } }, + "SmbSecurityDescriptorCopyFlags": { + "base": null, + "refs": { + "Options$SecurityDescriptorCopyFlags": "A value that determines which components of the SMB security descriptor are copied from source to destination objects.
This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
Default value: OWNER_DACL.
OWNER_DACL: For each copied object, DataSync copies the following metadata:
Object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
Object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
" + } + }, "SmbSubdirectory": { "base": null, "refs": { @@ -866,8 +872,8 @@ "SmbUser": { "base": null, "refs": { - "CreateLocationFsxWindowsRequest$User": "The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
", - "CreateLocationSmbRequest$User": "The user who can mount the share, has the permissions to access files and folders in the SMB share.
", + "CreateLocationFsxWindowsRequest$User": "The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
", + "CreateLocationSmbRequest$User": "The user who can mount the share, has the permissions to access files and folders in the SMB share.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
", "DescribeLocationFsxWindowsResponse$User": "The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
", "DescribeLocationSmbResponse$User": "The user who can mount the share, has the permissions to access files and folders in the SMB share.
", "UpdateLocationSmbRequest$User": "The user who can mount the share has the permissions to access files and folders in the SMB share.
" @@ -909,7 +915,7 @@ } }, "TagListEntry": { - "base": "Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.
Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.
Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when ListTaskExecutions operation is called.
Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when the ListTaskExecutions operation is called.
Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.
Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.
A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see queue-task-execution.
" + "Options$TaskQueueing": "A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
" } }, "TaskSchedule": { "base": "Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
", "refs": { - "CreateTaskRequest$Schedule": "Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see task-scheduling.
", + "CreateTaskRequest$Schedule": "Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.
", "DescribeTaskResponse$Schedule": "The schedule used to periodically transfer files from a source to a destination location.
", - "UpdateTaskRequest$Schedule": "Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see task-scheduling.
" + "UpdateTaskRequest$Schedule": "Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see Scheduling your task.
" } }, "TaskStatus": { @@ -1051,7 +1057,7 @@ "Time": { "base": null, "refs": { - "DescribeAgentResponse$LastConnectionTime": "The time that the agent last connected to DataSyc.
", + "DescribeAgentResponse$LastConnectionTime": "The time that the agent last connected to DataSync.
", "DescribeAgentResponse$CreationTime": "The time that the agent was activated (that is, created in your account).
", "DescribeLocationEfsResponse$CreationTime": "The time that the EFS location was created.
", "DescribeLocationFsxWindowsResponse$CreationTime": "The time that the FSx for Windows File Server location was created.
", @@ -1072,7 +1078,7 @@ "Uid": { "base": null, "refs": { - "Options$Uid": "The user ID (UID) of the file's owner.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
NONE: Ignore UID and GID.
" + "Options$Uid": "The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
NONE: Ignore UID and GID.
" } }, "UntagResourceRequest": { @@ -1148,7 +1154,7 @@ "VerifyMode": { "base": null, "refs": { - "Options$VerifyMode": "A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see create-task
Default value: POINT_IN_TIME_CONSISTENT.
ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
" + "Options$VerifyMode": "A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
Default value: POINT_IN_TIME_CONSISTENT.
ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
" } }, "VpcEndpointId": { diff --git a/models/apis/location/2020-11-19/api-2.json b/models/apis/location/2020-11-19/api-2.json index 7632c857829..df718e380e6 100644 --- a/models/apis/location/2020-11-19/api-2.json +++ b/models/apis/location/2020-11-19/api-2.json @@ -31,6 +31,24 @@ ], "endpoint":{"hostPrefix":"tracking."} }, + "BatchDeleteDevicePositionHistory":{ + "name":"BatchDeleteDevicePositionHistory", + "http":{ + "method":"POST", + "requestUri":"/tracking/v0/trackers/{TrackerName}/delete-positions", + "responseCode":200 + }, + "input":{"shape":"BatchDeleteDevicePositionHistoryRequest"}, + "output":{"shape":"BatchDeleteDevicePositionHistoryResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"tracking."} + }, "BatchDeleteGeofence":{ "name":"BatchDeleteGeofence", "http":{ @@ -121,6 +139,24 @@ ], "endpoint":{"hostPrefix":"tracking."} }, + "CalculateRoute":{ + "name":"CalculateRoute", + "http":{ + "method":"POST", + "requestUri":"/routes/v0/calculators/{CalculatorName}/calculate/route", + "responseCode":200 + }, + "input":{"shape":"CalculateRouteRequest"}, + "output":{"shape":"CalculateRouteResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"routes."} + }, "CreateGeofenceCollection":{ "name":"CreateGeofenceCollection", "http":{ @@ -178,6 +214,25 @@ "endpoint":{"hostPrefix":"places."}, "idempotent":true }, + "CreateRouteCalculator":{ + "name":"CreateRouteCalculator", + "http":{ + "method":"POST", + "requestUri":"/routes/v0/calculators", + "responseCode":200 + }, + "input":{"shape":"CreateRouteCalculatorRequest"}, + "output":{"shape":"CreateRouteCalculatorResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"routes."}, + "idempotent":true + }, "CreateTracker":{ "name":"CreateTracker", "http":{ @@ -254,6 +309,25 @@ "endpoint":{"hostPrefix":"places."}, "idempotent":true }, + "DeleteRouteCalculator":{ + "name":"DeleteRouteCalculator", + "http":{ + "method":"DELETE", + "requestUri":"/routes/v0/calculators/{CalculatorName}", + "responseCode":200 + }, + "input":{"shape":"DeleteRouteCalculatorRequest"}, + "output":{"shape":"DeleteRouteCalculatorResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"routes."}, + "idempotent":true + }, "DeleteTracker":{ "name":"DeleteTracker", "http":{ @@ -327,6 +401,24 @@ ], "endpoint":{"hostPrefix":"places."} }, + "DescribeRouteCalculator":{ + "name":"DescribeRouteCalculator", + "http":{ + "method":"GET", + "requestUri":"/routes/v0/calculators/{CalculatorName}", + "responseCode":200 + }, + "input":{"shape":"DescribeRouteCalculatorRequest"}, + "output":{"shape":"DescribeRouteCalculatorResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"routes."} + }, "DescribeTracker":{ "name":"DescribeTracker", "http":{ @@ -489,6 +581,23 @@ ], "endpoint":{"hostPrefix":"maps."} }, + "ListDevicePositions":{ + "name":"ListDevicePositions", + "http":{ + "method":"POST", + "requestUri":"/tracking/v0/trackers/{TrackerName}/list-positions", + "responseCode":200 + }, + "input":{"shape":"ListDevicePositionsRequest"}, + "output":{"shape":"ListDevicePositionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"tracking."} + }, "ListGeofenceCollections":{ "name":"ListGeofenceCollections", "http":{ @@ -558,6 +667,41 @@ ], "endpoint":{"hostPrefix":"places."} }, + "ListRouteCalculators":{ + "name":"ListRouteCalculators", + "http":{ + "method":"POST", + "requestUri":"/routes/v0/list-calculators", + "responseCode":200 + }, + "input":{"shape":"ListRouteCalculatorsRequest"}, + "output":{"shape":"ListRouteCalculatorsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"routes."} + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"metadata."} + }, "ListTrackerConsumers":{ "name":"ListTrackerConsumers", "http":{ @@ -647,6 +791,43 @@ {"shape":"ThrottlingException"} ], "endpoint":{"hostPrefix":"places."} + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"metadata."} + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"metadata."}, + "idempotent":true } }, "shapes":{ @@ -695,6 +876,49 @@ "members":{ } }, + "BatchDeleteDevicePositionHistoryError":{ + "type":"structure", + "required":[ + "DeviceId", + "Error" + ], + "members":{ + "DeviceId":{"shape":"Id"}, + "Error":{"shape":"BatchItemError"} + } + }, + "BatchDeleteDevicePositionHistoryErrorList":{ + "type":"list", + "member":{"shape":"BatchDeleteDevicePositionHistoryError"} + }, + "BatchDeleteDevicePositionHistoryRequest":{ + "type":"structure", + "required":[ + "DeviceIds", + "TrackerName" + ], + "members":{ + "DeviceIds":{"shape":"BatchDeleteDevicePositionHistoryRequestDeviceIdsList"}, + "TrackerName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"TrackerName" + } + } + }, + "BatchDeleteDevicePositionHistoryRequestDeviceIdsList":{ + "type":"list", + "member":{"shape":"Id"}, + "max":100, + "min":1 + }, + "BatchDeleteDevicePositionHistoryResponse":{ + "type":"structure", + "required":["Errors"], + "members":{ + "Errors":{"shape":"BatchDeleteDevicePositionHistoryErrorList"} + } + }, "BatchDeleteGeofenceError":{ "type":"structure", "required":[ @@ -974,13 +1198,102 @@ } }, "Blob":{"type":"blob"}, + "Boolean":{ + "type":"boolean", + "box":true + }, "BoundingBox":{ "type":"list", "member":{"shape":"Double"}, - "max":6, + "max":4, "min":4, "sensitive":true }, + "CalculateRouteCarModeOptions":{ + "type":"structure", + "members":{ + "AvoidFerries":{"shape":"Boolean"}, + "AvoidTolls":{"shape":"Boolean"} + } + }, + "CalculateRouteRequest":{ + "type":"structure", + "required":[ + "CalculatorName", + "DeparturePosition", + "DestinationPosition" + ], + "members":{ + "CalculatorName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"CalculatorName" + }, + "CarModeOptions":{"shape":"CalculateRouteCarModeOptions"}, + "DepartNow":{"shape":"Boolean"}, + "DeparturePosition":{"shape":"Position"}, + "DepartureTime":{"shape":"Timestamp"}, + "DestinationPosition":{"shape":"Position"}, + "DistanceUnit":{"shape":"DistanceUnit"}, + "IncludeLegGeometry":{"shape":"Boolean"}, + "TravelMode":{"shape":"TravelMode"}, + "TruckModeOptions":{"shape":"CalculateRouteTruckModeOptions"}, + "WaypointPositions":{"shape":"CalculateRouteRequestWaypointPositionsList"} + } + }, + "CalculateRouteRequestWaypointPositionsList":{ + "type":"list", + "member":{"shape":"Position"}, + "max":23, + "min":0 + }, + "CalculateRouteResponse":{ + "type":"structure", + "required":[ + "Legs", + "Summary" + ], + "members":{ + "Legs":{"shape":"LegList"}, + "Summary":{"shape":"CalculateRouteSummary"} + } + }, + "CalculateRouteSummary":{ + "type":"structure", + "required":[ + "DataSource", + "Distance", + "DistanceUnit", + "DurationSeconds", + "RouteBBox" + ], + "members":{ + "DataSource":{"shape":"String"}, + "Distance":{"shape":"CalculateRouteSummaryDistanceDouble"}, + "DistanceUnit":{"shape":"DistanceUnit"}, + "DurationSeconds":{"shape":"CalculateRouteSummaryDurationSecondsDouble"}, + "RouteBBox":{"shape":"BoundingBox"} + } + }, + "CalculateRouteSummaryDistanceDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "CalculateRouteSummaryDurationSecondsDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "CalculateRouteTruckModeOptions":{ + "type":"structure", + "members":{ + "AvoidFerries":{"shape":"Boolean"}, + "AvoidTolls":{"shape":"Boolean"}, + "Dimensions":{"shape":"TruckDimensions"}, + "Weight":{"shape":"TruckWeight"} + } + }, "ConflictException":{ "type":"structure", "required":["Message"], @@ -1015,8 +1328,10 @@ "members":{ "CollectionName":{"shape":"ResourceName"}, "Description":{"shape":"ResourceDescription"}, + "KmsKeyId":{"shape":"KmsKeyId"}, "PricingPlan":{"shape":"PricingPlan"}, - "PricingPlanDataSource":{"shape":"String"} + "PricingPlanDataSource":{"shape":"String"}, + "Tags":{"shape":"TagMap"} } }, "CreateGeofenceCollectionResponse":{ @@ -1043,7 +1358,8 @@ "Configuration":{"shape":"MapConfiguration"}, "Description":{"shape":"ResourceDescription"}, "MapName":{"shape":"ResourceName"}, - "PricingPlan":{"shape":"PricingPlan"} + "PricingPlan":{"shape":"PricingPlan"}, + "Tags":{"shape":"TagMap"} } }, "CreateMapResponse":{ @@ -1071,7 +1387,8 @@ "DataSourceConfiguration":{"shape":"DataSourceConfiguration"}, "Description":{"shape":"ResourceDescription"}, "IndexName":{"shape":"ResourceName"}, - "PricingPlan":{"shape":"PricingPlan"} + "PricingPlan":{"shape":"PricingPlan"}, + "Tags":{"shape":"TagMap"} } }, "CreatePlaceIndexResponse":{ @@ -1087,6 +1404,34 @@ "IndexName":{"shape":"ResourceName"} } }, + "CreateRouteCalculatorRequest":{ + "type":"structure", + "required":[ + "CalculatorName", + "DataSource", + "PricingPlan" + ], + "members":{ + "CalculatorName":{"shape":"ResourceName"}, + "DataSource":{"shape":"String"}, + "Description":{"shape":"ResourceDescription"}, + "PricingPlan":{"shape":"PricingPlan"}, + "Tags":{"shape":"TagMap"} + } + }, + "CreateRouteCalculatorResponse":{ + "type":"structure", + "required":[ + "CalculatorArn", + "CalculatorName", + "CreateTime" + ], + "members":{ + "CalculatorArn":{"shape":"Arn"}, + "CalculatorName":{"shape":"ResourceName"}, + "CreateTime":{"shape":"Timestamp"} + } + }, "CreateTrackerRequest":{ "type":"structure", "required":[ @@ -1095,8 +1440,10 @@ ], "members":{ "Description":{"shape":"ResourceDescription"}, + "KmsKeyId":{"shape":"KmsKeyId"}, "PricingPlan":{"shape":"PricingPlan"}, "PricingPlanDataSource":{"shape":"String"}, + "Tags":{"shape":"TagMap"}, "TrackerName":{"shape":"ResourceName"} } }, @@ -1167,6 +1514,22 @@ "members":{ } }, + "DeleteRouteCalculatorRequest":{ + "type":"structure", + "required":["CalculatorName"], + "members":{ + "CalculatorName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"CalculatorName" + } + } + }, + "DeleteRouteCalculatorResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteTrackerRequest":{ "type":"structure", "required":["TrackerName"], @@ -1209,8 +1572,10 @@ "CollectionName":{"shape":"ResourceName"}, "CreateTime":{"shape":"Timestamp"}, "Description":{"shape":"ResourceDescription"}, + "KmsKeyId":{"shape":"KmsKeyId"}, "PricingPlan":{"shape":"PricingPlan"}, "PricingPlanDataSource":{"shape":"String"}, + "Tags":{"shape":"TagMap"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -1245,6 +1610,7 @@ "MapArn":{"shape":"Arn"}, "MapName":{"shape":"ResourceName"}, "PricingPlan":{"shape":"PricingPlan"}, + "Tags":{"shape":"TagMap"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -1279,6 +1645,40 @@ "IndexArn":{"shape":"Arn"}, "IndexName":{"shape":"ResourceName"}, "PricingPlan":{"shape":"PricingPlan"}, + "Tags":{"shape":"TagMap"}, + "UpdateTime":{"shape":"Timestamp"} + } + }, + "DescribeRouteCalculatorRequest":{ + "type":"structure", + "required":["CalculatorName"], + "members":{ + "CalculatorName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"CalculatorName" + } + } + }, + "DescribeRouteCalculatorResponse":{ + "type":"structure", + "required":[ + "CalculatorArn", + "CalculatorName", + "CreateTime", + "DataSource", + "Description", + "PricingPlan", + "UpdateTime" + ], + "members":{ + "CalculatorArn":{"shape":"Arn"}, + "CalculatorName":{"shape":"ResourceName"}, + "CreateTime":{"shape":"Timestamp"}, + "DataSource":{"shape":"String"}, + "Description":{"shape":"ResourceDescription"}, + "PricingPlan":{"shape":"PricingPlan"}, + "Tags":{"shape":"TagMap"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -1306,8 +1706,10 @@ "members":{ "CreateTime":{"shape":"Timestamp"}, "Description":{"shape":"ResourceDescription"}, + "KmsKeyId":{"shape":"KmsKeyId"}, "PricingPlan":{"shape":"PricingPlan"}, "PricingPlanDataSource":{"shape":"String"}, + "Tags":{"shape":"TagMap"}, "TrackerArn":{"shape":"Arn"}, "TrackerName":{"shape":"ResourceName"}, "UpdateTime":{"shape":"Timestamp"} @@ -1344,6 +1746,13 @@ "SampleTime":{"shape":"Timestamp"} } }, + "DimensionUnit":{ + "type":"string", + "enum":[ + "Meters", + "Feet" + ] + }, "DisassociateTrackerConsumerRequest":{ "type":"structure", "required":[ @@ -1368,6 +1777,13 @@ "members":{ } }, + "DistanceUnit":{ + "type":"string", + "enum":[ + "Kilometers", + "Miles" + ] + }, "Double":{ "type":"double", "box":true @@ -1658,6 +2074,54 @@ "fault":true, "retryable":{"throttling":false} }, + "KmsKeyId":{ + "type":"string", + "max":2048, + "min":1 + }, + "Leg":{ + "type":"structure", + "required":[ + "Distance", + "DurationSeconds", + "EndPosition", + "StartPosition", + "Steps" + ], + "members":{ + "Distance":{"shape":"LegDistanceDouble"}, + "DurationSeconds":{"shape":"LegDurationSecondsDouble"}, + "EndPosition":{"shape":"Position"}, + "Geometry":{"shape":"LegGeometry"}, + "StartPosition":{"shape":"Position"}, + "Steps":{"shape":"StepList"} + } + }, + "LegDistanceDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "LegDurationSecondsDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "LegGeometry":{ + "type":"structure", + "members":{ + "LineString":{"shape":"LineString"} + } + }, + "LegList":{ + "type":"list", + "member":{"shape":"Leg"} + }, + "LineString":{ + "type":"list", + "member":{"shape":"Position"}, + "min":2 + }, "LinearRing":{ "type":"list", "member":{"shape":"Position"}, @@ -1668,6 +2132,50 @@ "member":{"shape":"LinearRing"}, "min":1 }, + "ListDevicePositionsRequest":{ + "type":"structure", + "required":["TrackerName"], + "members":{ + "MaxResults":{"shape":"ListDevicePositionsRequestMaxResultsInteger"}, + "NextToken":{"shape":"Token"}, + "TrackerName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"TrackerName" + } + } + }, + "ListDevicePositionsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListDevicePositionsResponse":{ + "type":"structure", + "required":["Entries"], + "members":{ + "Entries":{"shape":"ListDevicePositionsResponseEntryList"}, + "NextToken":{"shape":"Token"} + } + }, + "ListDevicePositionsResponseEntry":{ + "type":"structure", + "required":[ + "DeviceId", + "Position", + "SampleTime" + ], + "members":{ + "DeviceId":{"shape":"Id"}, + "Position":{"shape":"Position"}, + "SampleTime":{"shape":"Timestamp"} + } + }, + "ListDevicePositionsResponseEntryList":{ + "type":"list", + "member":{"shape":"ListDevicePositionsResponseEntry"} + }, "ListGeofenceCollectionsRequest":{ "type":"structure", "members":{ @@ -1840,6 +2348,67 @@ "type":"list", "member":{"shape":"ListPlaceIndexesResponseEntry"} }, + "ListRouteCalculatorsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{"shape":"ListRouteCalculatorsRequestMaxResultsInteger"}, + "NextToken":{"shape":"Token"} + } + }, + "ListRouteCalculatorsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListRouteCalculatorsResponse":{ + "type":"structure", + "required":["Entries"], + "members":{ + "Entries":{"shape":"ListRouteCalculatorsResponseEntryList"}, + "NextToken":{"shape":"Token"} + } + }, + "ListRouteCalculatorsResponseEntry":{ + "type":"structure", + "required":[ + "CalculatorName", + "CreateTime", + "DataSource", + "Description", + "PricingPlan", + "UpdateTime" + ], + "members":{ + "CalculatorName":{"shape":"ResourceName"}, + "CreateTime":{"shape":"Timestamp"}, + "DataSource":{"shape":"String"}, + "Description":{"shape":"ResourceDescription"}, + "PricingPlan":{"shape":"PricingPlan"}, + "UpdateTime":{"shape":"Timestamp"} + } + }, + "ListRouteCalculatorsResponseEntryList":{ + "type":"list", + "member":{"shape":"ListRouteCalculatorsResponseEntry"} + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{"shape":"TagMap"} + } + }, "ListTrackerConsumersRequest":{ "type":"structure", "required":["TrackerName"], @@ -1921,7 +2490,7 @@ "type":"string", "max":100, "min":1, - "pattern":"^[-._\\p{L}\\p{N}]+$" + "pattern":"^[-._\\w]+$" }, "Place":{ "type":"structure", @@ -2132,6 +2701,41 @@ "Text":{"shape":"SyntheticSearchPlaceIndexForTextSummaryString"} } }, + "Step":{ + "type":"structure", + "required":[ + "Distance", + "DurationSeconds", + "EndPosition", + "StartPosition" + ], + "members":{ + "Distance":{"shape":"StepDistanceDouble"}, + "DurationSeconds":{"shape":"StepDurationSecondsDouble"}, + "EndPosition":{"shape":"Position"}, + "GeometryOffset":{"shape":"StepGeometryOffsetInteger"}, + "StartPosition":{"shape":"Position"} + } + }, + "StepDistanceDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "StepDurationSecondsDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "StepGeometryOffsetInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "StepList":{ + "type":"list", + "member":{"shape":"Step"} + }, "String":{"type":"string"}, "SyntheticSearchPlaceIndexForTextRequestString":{ "type":"string", @@ -2143,6 +2747,51 @@ "type":"string", "sensitive":true }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"String"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{"shape":"TagMap"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^[A-Za-z0-9 _=@:.+-/]*$" + }, "ThrottlingException":{ "type":"structure", "required":["Message"], @@ -2168,6 +2817,74 @@ "max":2000, "min":1 }, + "TravelMode":{ + "type":"string", + "enum":[ + "Car", + "Truck", + "Walking" + ] + }, + "TruckDimensions":{ + "type":"structure", + "members":{ + "Height":{"shape":"TruckDimensionsHeightDouble"}, + "Length":{"shape":"TruckDimensionsLengthDouble"}, + "Unit":{"shape":"DimensionUnit"}, + "Width":{"shape":"TruckDimensionsWidthDouble"} + } + }, + "TruckDimensionsHeightDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "TruckDimensionsLengthDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "TruckDimensionsWidthDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "TruckWeight":{ + "type":"structure", + "members":{ + "Total":{"shape":"TruckWeightTotalDouble"}, + "Unit":{"shape":"VehicleWeightUnit"} + } + }, + "TruckWeightTotalDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeys", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "ValidationException":{ "type":"structure", "required":[ @@ -2225,6 +2942,13 @@ "FieldValidationFailed", "Other" ] + }, + "VehicleWeightUnit":{ + "type":"string", + "enum":[ + "Kilograms", + "Pounds" + ] } } } diff --git a/models/apis/location/2020-11-19/docs-2.json b/models/apis/location/2020-11-19/docs-2.json index 3b1d5b3d30a..0dd1647f2f0 100644 --- a/models/apis/location/2020-11-19/docs-2.json +++ b/models/apis/location/2020-11-19/docs-2.json @@ -1,42 +1,52 @@ { "version": "2.0", - "service": "Suite of geospatial services including Maps, Places, Tracking, and Geofencing
", + "service": "Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing
", "operations": { "AssociateTrackerConsumer": "Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
Deletes a batch of geofences from a geofence collection.
This action deletes the resource permanently. You can't undo this action.
Deletes the position history of one or more devices from a tracker resource.
", + "BatchDeleteGeofence": "Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
Evaluates device positions against the geofence geometries from a given geofence collection. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge.
The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update
A batch request to retrieve all device positions.
", - "BatchPutGeofence": "A batch request for storing geofence geometries into a given geofence collection.
", - "BatchUpdateDevicePosition": "Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history.
Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval, and retained for one year before it is deleted.
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 reporting the last known device position and position history.
Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval and retained for 30 days before it's deleted.
Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition. Requires that you first create aroute 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 an error message.
Specifying a travel mode using TravelMode. This lets you specify additional route preference such as CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
", "CreateGeofenceCollection": "
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.
By using Maps, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. For more information, see the AWS Service Terms for Amazon Location Service.
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
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, which supports functions with geospatial data sourced from your chosen data provider.
", + "CreateRouteCalculator": "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.
", "CreateTracker": "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 action deletes the resource permanently. You can't undo this action. 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 action deletes the resource permanently. You cannot undo this action. If the map is being used in an application, the map may not render.
Deletes a Place index resource from your AWS account.
This action deletes the resource permanently. You cannot undo this action.
Deletes a tracker resource from your AWS account.
This action deletes the resource permanently. You can't undo this action. If the tracker resource is in use, you may encounter an error. Make sure that the target resource is not a dependency for your applications.
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.
Deletes a place index resource from your AWS account.
This operation deletes the resource permanently.
Deletes a route calculator resource from your AWS account.
This operation deletes the resource permanently.
Deletes a tracker resource from your AWS account.
This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.
Retrieves the geofence collection details.
", "DescribeMap": "Retrieves the map resource details.
", - "DescribePlaceIndex": "Retrieves the Place index resource details.
", + "DescribePlaceIndex": "Retrieves the place index resource details.
", + "DescribeRouteCalculator": "Retrieves the route calculator resource details.
", "DescribeTracker": "Retrieves the tracker resource details.
", "DisassociateTrackerConsumer": "Removes the association between a tracker resource and a geofence collection.
Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after one year.
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 1 year.
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
Retrieves the geofence details from a geofence collection.
", "GetMapGlyphs": "Retrieves glyphs used to display labels on a map.
", "GetMapSprites": "Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
", "GetMapStyleDescriptor": "Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
", - "GetMapTile": "Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. They are addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
", + "GetMapTile": "Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
", + "ListDevicePositions": "Lists the latest device positions for requested devices.
", "ListGeofenceCollections": "Lists geofence collections in your AWS account.
", "ListGeofences": "Lists geofences stored in a given geofence collection.
", "ListMaps": "Lists map resources in your AWS account.
", - "ListPlaceIndexes": "Lists Place index resources in your AWS account.
", + "ListPlaceIndexes": "Lists place index resources in your AWS account.
", + "ListRouteCalculators": "Lists route calculator resources in your AWS account.
", + "ListTagsForResource": "Returns the tags for the specified Amazon Location Service resource.
", "ListTrackerConsumers": "Lists geofence collections currently associated to the given tracker resource.
", "ListTrackers": "Lists tracker resources in your AWS account.
", "PutGeofence": "Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
", - "SearchPlaceIndexForPosition": "Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Includes the option to apply additional parameters to narrow your list of results.
You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
", + "SearchPlaceIndexForText": "Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Includes the option to apply additional parameters to narrow your list of results.
You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
<p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate as many as 50 tags with a resource.</p> Removes one or more tags from the specified Amazon Location Service resource.
" }, "shapes": { "AccessDeniedException": { @@ -48,16 +58,21 @@ "base": null, "refs": { "ArnList$member": null, - "AssociateTrackerConsumerRequest$ConsumerArn": "The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
", - "CreateMapResponse$MapArn": "The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
The Amazon Resource Name (ARN) for the Place index resource. Used when you need to specify a resource across all AWS.
", - "CreateTrackerResponse$TrackerArn": "The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
", - "DescribeGeofenceCollectionResponse$CollectionArn": "The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
", - "DescribeMapResponse$MapArn": "The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
", - "DescribePlaceIndexResponse$IndexArn": "The Amazon Resource Name (ARN) for the Place index resource. Used when you need to specify a resource across all AWS.
", - "DescribeTrackerResponse$TrackerArn": "The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
", - "DisassociateTrackerConsumerRequest$ConsumerArn": "The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:maps/ExampleMap
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:maps/ExampleMap
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS.
Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
", + "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource whose tags you want to update.
", + "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource from which you want to remove tags.
" } }, "ArnList": { @@ -76,6 +91,34 @@ "refs": { } }, + "BatchDeleteDevicePositionHistoryError": { + "base": "Contains the tracker resource details.
", + "refs": { + "BatchDeleteDevicePositionHistoryErrorList$member": null + } + }, + "BatchDeleteDevicePositionHistoryErrorList": { + "base": null, + "refs": { + "BatchDeleteDevicePositionHistoryResponse$Errors": "Contains error details for each device history that failed to delete.
" + } + }, + "BatchDeleteDevicePositionHistoryRequest": { + "base": null, + "refs": { + } + }, + "BatchDeleteDevicePositionHistoryRequestDeviceIdsList": { + "base": null, + "refs": { + "BatchDeleteDevicePositionHistoryRequest$DeviceIds": "Devices whose position history you want to delete.
For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
Contains error details for each geofence that failed to delete from the geofence collection.
", "refs": { @@ -169,6 +212,7 @@ "BatchItemError": { "base": "Contains the batch request error details associated with the request.
", "refs": { + "BatchDeleteDevicePositionHistoryError$Error": null, "BatchDeleteGeofenceError$Error": "Contains details associated to the batch error.
", "BatchEvaluateGeofencesError$Error": "Contains details associated to the batch error.
", "BatchGetDevicePositionError$Error": "Contains details related to the error code.
", @@ -265,14 +309,72 @@ "GetMapTileResponse$Blob": "Contains Mapbox Vector Tile (MVT) data.
" } }, + "Boolean": { + "base": null, + "refs": { + "CalculateRouteCarModeOptions$AvoidFerries": "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 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
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y]
The first 2 bbox parameters describe the lower southwest corner:
The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.
The next 2 bbox parameters describe the upper northeast corner:
The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
Filters the results by returning only Places within the provided bounding box. An optional parameter.
The first 2 bbox parameters describe the lower southwest corner:
The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.
For example, bbox=xLongitudeSW&bbox=yLatitudeSW.
The next bbox parameters describe the upper northeast corner:
The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
For example, bbox=xLongitudeNE&bbox=yLatitudeNE
Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
", "SearchPlaceIndexForTextSummary$ResultBBox": "A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
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 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.
Valid Values: [-180 to 180,-90 to 90]
Returns the result of the route calculation. Metadata includes legs and route summary.
", + "refs": { + } + }, + "CalculateRouteSummary": { + "base": "A summary of the calculated route.
", + "refs": { + "CalculateRouteResponse$Summary": "Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds
The total distance covered by the route. The sum of the distance travelled between every stop on the route.
The route distance can't be greater than 250 km. If the route exceeds 250 km, the response returns a 400 RoutesValidationException error.
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
" + } + }, + "CalculateRouteTruckModeOptions": { + "base": "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.
The request was unsuccessful due to a conflict.
", "refs": { @@ -321,6 +423,16 @@ "refs": { } }, + "CreateRouteCalculatorRequest": { + "base": null, + "refs": { + } + }, + "CreateRouteCalculatorResponse": { + "base": null, + "refs": { + } + }, "CreateTrackerRequest": { "base": null, "refs": { @@ -332,7 +444,7 @@ } }, "DataSourceConfiguration": { - "base": "Specifies the data storage option chosen for requesting Places.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
Specifies the data storage option chosen for requesting Places.
", "refs": { "CreatePlaceIndexRequest$DataSourceConfiguration": "Specifies the data storage option for requesting Places.
", "DescribePlaceIndexResponse$DataSourceConfiguration": "The specified data storage option for requesting Places.
" @@ -368,6 +480,16 @@ "refs": { } }, + "DeleteRouteCalculatorRequest": { + "base": null, + "refs": { + } + }, + "DeleteRouteCalculatorResponse": { + "base": null, + "refs": { + } + }, "DeleteTrackerRequest": { "base": null, "refs": { @@ -408,6 +530,16 @@ "refs": { } }, + "DescribeRouteCalculatorRequest": { + "base": null, + "refs": { + } + }, + "DescribeRouteCalculatorResponse": { + "base": null, + "refs": { + } + }, "DescribeTrackerRequest": { "base": null, "refs": { @@ -438,6 +570,12 @@ "BatchUpdateDevicePositionRequestUpdatesList$member": null } }, + "DimensionUnit": { + "base": null, + "refs": { + "TruckDimensions$Unit": "Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
Set the unit system to specify the distance.
Default Value: Kilometers
The unit of measurement for the distance.
" + } + }, "Double": { "base": null, "refs": { @@ -456,7 +601,7 @@ } }, "GeofenceGeometry": { - "base": "Contains the geofence geometry details.
Amazon Location does not currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.
Contains the geofence geometry details.
Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.
Contains the polygon details to specify the position of the geofence.
Each geofence polygon can have a maximum of 1,000 vertices.
Contains the geofence geometry details describing a polygon.
", @@ -502,7 +647,7 @@ "GetMapGlyphsRequestFontUnicodeRangeString": { "base": null, "refs": { - "GetMapGlyphsRequest$FontUnicodeRange": "A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0-255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.
A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.
The ID of the device for this position.
", + "BatchDeleteDevicePositionHistoryRequestDeviceIdsList$member": null, "BatchDeleteGeofenceError$GeofenceId": "The geofence associated with the error message.
", "BatchDeleteGeofenceRequestGeofenceIdsList$member": null, "BatchEvaluateGeofencesError$DeviceId": "The device associated with the position evaluation error.
", @@ -583,6 +730,7 @@ "GetDevicePositionResponse$DeviceId": "The device whose position you retrieved.
", "GetGeofenceRequest$GeofenceId": "The geofence you're retrieving details for.
", "GetGeofenceResponse$GeofenceId": "The geofence identifier.
", + "ListDevicePositionsResponseEntry$DeviceId": "The ID of the device for this position.
", "ListGeofenceResponseEntry$GeofenceId": "The geofence identifier.
", "PutGeofenceRequest$GeofenceId": "An identifier for the geofence. For example, ExampleGeofence-1.
The geofence identifier entered in the request.
" @@ -591,7 +739,7 @@ "IntendedUse": { "base": null, "refs": { - "DataSourceConfiguration$IntendedUse": "Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.
Default value: SingleUse
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.
Place index resources using HERE as a data provider can't be configured to store results for locations in Japan when choosing Storage for the IntendedUse parameter.
Default value: SingleUse
A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
", + "CreateTrackerRequest$KmsKeyId": "A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
", + "DescribeGeofenceCollectionResponse$KmsKeyId": "A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource
", + "DescribeTrackerResponse$KmsKeyId": "A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
" + } + }, + "Leg": { + "base": "Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one less 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 distance between the leg's StartPosition and EndPosition along a calculated route.
The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.
Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.
", + "refs": { + "Leg$Geometry": "Contains the calculated route's path as a linestring geometry.
" + } + }, + "LegList": { + "base": null, + "refs": { + "CalculateRouteResponse$Legs": "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 less 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.
An ordered list of positions used to plot a route on a map.
The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.
For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
" } }, + "ListDevicePositionsRequest": { + "base": null, + "refs": { + } + }, + "ListDevicePositionsRequestMaxResultsInteger": { + "base": null, + "refs": { + "ListDevicePositionsRequest$MaxResults": "An optional limit for the number of entries returned in a single call.
Default value: 100
Contains the tracker resource details.
", + "refs": { + "ListDevicePositionsResponseEntryList$member": null + } + }, + "ListDevicePositionsResponseEntryList": { + "base": null, + "refs": { + "ListDevicePositionsResponse$Entries": "Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.
" + } + }, "ListGeofenceCollectionsRequest": { "base": null, "refs": { @@ -706,7 +927,7 @@ } }, "ListPlaceIndexesResponseEntry": { - "base": "A Place index resource listed in your AWS account.
", + "base": "A place index resource listed in your AWS account.
", "refs": { "ListPlaceIndexesResponseEntryList$member": null } @@ -714,7 +935,45 @@ "ListPlaceIndexesResponseEntryList": { "base": null, "refs": { - "ListPlaceIndexesResponse$Entries": "Lists the Place index resources that exist in your AWS account
" + "ListPlaceIndexesResponse$Entries": "Lists the place index resources that exist in your AWS account
" + } + }, + "ListRouteCalculatorsRequest": { + "base": null, + "refs": { + } + }, + "ListRouteCalculatorsRequestMaxResultsInteger": { + "base": null, + "refs": { + "ListRouteCalculatorsRequest$MaxResults": "An optional maximum number of results returned in a single call.
Default Value: 100
A route calculator resource listed in your AWS account.
", + "refs": { + "ListRouteCalculatorsResponseEntryList$member": null + } + }, + "ListRouteCalculatorsResponseEntryList": { + "base": null, + "refs": { + "ListRouteCalculatorsResponse$Entries": "Lists the route calculator resources that exist in your AWS account
" + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { } }, "ListTrackerConsumersRequest": { @@ -771,7 +1030,7 @@ "MapStyle": { "base": null, "refs": { - "MapConfiguration$Style": "Specifies the map style selected from an available data provider.
Valid styles: VectorEsriStreets, VectorEsriTopographic, VectorEsriNavigation, VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas, VectorHereBerlin.
When using HERE as your data provider, and selecting the Style VectorHereBerlin, you may not use HERE Maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
Specifies the map style selected from an available data provider.
Valid styles: RasterEsriImagery, VectorEsriStreets, VectorEsriTopographic, VectorEsriNavigation, VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas, VectorHereBerlin.
When using HERE as your data provider, and selecting the Style VectorHereBerlin, you may not use HERE Maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
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.
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 last known device position. Empty if no positions currently stored.
", "PlaceGeometry$Point": "A single point geometry specifies a location for a Place using WGS 84 coordinates:
x — Specifies the x coordinate or longitude.
y — Specifies the y coordinate or latitude.
Specifies a coordinate for the query defined by a longitude, and latitude.
The first position is the X coordinate, or longitude.
The second position is the Y coordinate, or latitude.
For example, position=xLongitude&position=yLatitude .
The position given in the reverse geocoding request.
", "SearchPlaceIndexForTextRequest$BiasPosition": "Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.
The first bias position is the X coordinate, or longitude.
The second bias position is the Y coordinate, or latitude.
For example, bias=xLongitude&bias=yLatitude.
Contains the coordinates for the bias position entered in the geocoding request.
" + "SearchPlaceIndexForTextSummary$BiasPosition": "Contains the coordinates for the bias position entered in the geocoding request.
", + "Step$EndPosition": "The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.
", + "Step$StartPosition": "The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.
" } }, "PricingPlan": { "base": null, "refs": { - "CreateGeofenceCollectionRequest$PricingPlan": "Specifies the pricing plan for your geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", + "CreateGeofenceCollectionRequest$PricingPlan": "Specifies the pricing plan for the geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", "CreateMapRequest$PricingPlan": "Specifies the pricing plan for your map resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", - "CreatePlaceIndexRequest$PricingPlan": "Specifies the pricing plan for your Place index resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", - "CreateTrackerRequest$PricingPlan": "Specifies the pricing plan for your tracker resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", + "CreatePlaceIndexRequest$PricingPlan": "Specifies the pricing plan for your place index resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", + "CreateRouteCalculatorRequest$PricingPlan": "Specifies the pricing plan for your route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", + "CreateTrackerRequest$PricingPlan": "Specifies the pricing plan for the tracker resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", "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 the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</p> The pricing plan selected for the specified Place index resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", + "DescribePlaceIndexResponse$PricingPlan": "The pricing plan selected for the specified place index resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", + "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 the Amazon Location Service pricing page.
", "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 the Amazon Location Service pricing page.
", - "ListPlaceIndexesResponseEntry$PricingPlan": "The pricing plan for the specified Place index resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", + "ListPlaceIndexesResponseEntry$PricingPlan": "The pricing plan for the specified place index resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
", + "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 the Amazon Location Service pricing page.
" } }, @@ -842,15 +1113,18 @@ "refs": { "CreateGeofenceCollectionRequest$Description": "An optional description for the geofence collection.
", "CreateMapRequest$Description": "An optional description for the map resource.
", - "CreatePlaceIndexRequest$Description": "The optional description for the Place index resource.
", + "CreatePlaceIndexRequest$Description": "The optional description for the place index resource.
", + "CreateRouteCalculatorRequest$Description": "The optional description for the route calculator resource.
", "CreateTrackerRequest$Description": "An optional description for the tracker resource.
", "DescribeGeofenceCollectionResponse$Description": "The optional description for the geofence collection.
", "DescribeMapResponse$Description": "The optional description for the map resource.
", - "DescribePlaceIndexResponse$Description": "The optional description for the Place index resource.
", + "DescribePlaceIndexResponse$Description": "The optional description for the place index resource.
", + "DescribeRouteCalculatorResponse$Description": "The optional description of the route calculator resource.
", "DescribeTrackerResponse$Description": "The optional description for the tracker resource.
", "ListGeofenceCollectionsResponseEntry$Description": "The description for the geofence collection
", "ListMapsResponseEntry$Description": "The description for the map resource.
", - "ListPlaceIndexesResponseEntry$Description": "The optional description for the Place index resource.
", + "ListPlaceIndexesResponseEntry$Description": "The optional description for the place index resource.
", + "ListRouteCalculatorsResponseEntry$Description": "The optional description of the route calculator resource.
", "ListTrackersResponseEntry$Description": "The description for the tracker resource.
" } }, @@ -858,28 +1132,35 @@ "base": null, "refs": { "AssociateTrackerConsumerRequest$TrackerName": "The name of the tracker resource to be associated with a geofence collection.
", + "BatchDeleteDevicePositionHistoryRequest$TrackerName": "The name of the tracker resource to delete the device position history from.
", "BatchDeleteGeofenceRequest$CollectionName": "The geofence collection storing the geofences to be deleted.
", "BatchEvaluateGeofencesRequest$CollectionName": "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.
", - "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 of the route calculator resource that you want to use to calculate a 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.
", "CreateMapRequest$MapName": "The name for the map resource.
Requirements:
Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique map resource name.
No spaces allowed. For example, ExampleMap.
The name of the map resource.
", - "CreatePlaceIndexRequest$IndexName": "The name of the Place index resource.
Requirements:
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
Must be a unique Place index resource name.
No spaces allowed. For example, ExamplePlaceIndex.
The name for the Place index resource.
", + "CreatePlaceIndexRequest$IndexName": "The name of the place index resource.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique place index resource name.
No spaces allowed. For example, ExamplePlaceIndex.
The name for the place index resource.
", + "CreateRouteCalculatorRequest$CalculatorName": "The name of the route calculator resource.
Requirements:
Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
Must be a unique Route calculator resource name.
No spaces allowed. For example, ExampleRouteCalculator.
The name of the route calculator resource.
For example, ExampleRouteCalculator.
The name for the tracker resource.
Requirements:
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
Must be a unique tracker resource name.
No spaces allowed. For example, ExampleTracker.
The name of the tracker resource.
", "DeleteGeofenceCollectionRequest$CollectionName": "The name of the geofence collection to be deleted.
", "DeleteMapRequest$MapName": "The name of the map resource to be deleted.
", - "DeletePlaceIndexRequest$IndexName": "The name of the Place index resource to be deleted.
", + "DeletePlaceIndexRequest$IndexName": "The name of the place index resource to be deleted.
", + "DeleteRouteCalculatorRequest$CalculatorName": "The name of the route calculator resource to be deleted.
", "DeleteTrackerRequest$TrackerName": "The name of the tracker resource to be deleted.
", "DescribeGeofenceCollectionRequest$CollectionName": "The name of the geofence collection.
", "DescribeGeofenceCollectionResponse$CollectionName": "The name of the geofence collection.
", "DescribeMapRequest$MapName": "The name of the map resource.
", "DescribeMapResponse$MapName": "The map style selected from an available provider.
", - "DescribePlaceIndexRequest$IndexName": "The name of the Place index resource.
", - "DescribePlaceIndexResponse$IndexName": "The name of the Place index resource being described.
", + "DescribePlaceIndexRequest$IndexName": "The name of the place index resource.
", + "DescribePlaceIndexResponse$IndexName": "The name of the place index resource being described.
", + "DescribeRouteCalculatorRequest$CalculatorName": "The name of the route calculator resource.
", + "DescribeRouteCalculatorResponse$CalculatorName": "The name of the route calculator resource being described.
", "DescribeTrackerRequest$TrackerName": "The name of the tracker resource.
", "DescribeTrackerResponse$TrackerName": "The name of the tracker resource.
", "DisassociateTrackerConsumerRequest$TrackerName": "The name of the tracker resource to be dissociated from the consumer.
", @@ -890,15 +1171,17 @@ "GetMapSpritesRequest$MapName": "The map resource associated with the sprite file.
", "GetMapStyleDescriptorRequest$MapName": "The map resource to retrieve the style descriptor from.
", "GetMapTileRequest$MapName": "The map resource to retrieve the map tiles from.
", + "ListDevicePositionsRequest$TrackerName": "The tracker resource containing the requested devices.
", "ListGeofenceCollectionsResponseEntry$CollectionName": "The name of the geofence collection.
", "ListGeofencesRequest$CollectionName": "The name of the geofence collection storing the list of geofences.
", "ListMapsResponseEntry$MapName": "The name of the associated map resource.
", - "ListPlaceIndexesResponseEntry$IndexName": "The name of the Place index resource.
", + "ListPlaceIndexesResponseEntry$IndexName": "The name of the place index resource.
", + "ListRouteCalculatorsResponseEntry$CalculatorName": "The name of the route calculator resource.
", "ListTrackerConsumersRequest$TrackerName": "The tracker resource whose associated geofence collections you want to list.
", "ListTrackersResponseEntry$TrackerName": "The name of the tracker resource.
", "PutGeofenceRequest$CollectionName": "The geofence collection to store the geofence in.
", - "SearchPlaceIndexForPositionRequest$IndexName": "The name of the Place index resource you want to use for the search.
", - "SearchPlaceIndexForTextRequest$IndexName": "The name of the Place index resource you want to use for the search.
" + "SearchPlaceIndexForPositionRequest$IndexName": "The name of the place index resource you want to use for the search.
", + "SearchPlaceIndexForTextRequest$IndexName": "The name of the place index resource you want to use for the search.
" } }, "ResourceNotFoundException": { @@ -907,7 +1190,7 @@ } }, "SearchForPositionResult": { - "base": "Specifies a single point of interest, or Place as a result of a search query obtained from a dataset configured in the Place index Resource.
", + "base": "Specifies a single point of interest, or Place as a result of a search query obtained from a dataset configured in the place index resource.
", "refs": { "SearchForPositionResultList$member": null } @@ -962,19 +1245,52 @@ "SearchPlaceIndexForTextResponse$Summary": "Contains a summary of the request. Contains the BiasPosition, DataSource, FilterBBox, FilterCountries, MaxResults, ResultBBox, and Text.
Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.
", + "refs": { + "StepList$member": null + } + }, + "StepDistanceDouble": { + "base": null, + "refs": { + "Step$Distance": "The travel distance between the step's StartPosition and EndPosition.
The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.
Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.
Included in the response for queries that set IncludeLegGeometry to True.
Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
" + } + }, "String": { "base": null, "refs": { "AccessDeniedException$Message": null, "BatchItemError$Message": "A message with the reason for the batch request error.
", + "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 plan data source. Required if the Mobile Asset Tracking (MAT) or the Mobile Asset Management (MAM) pricing plan is selected.
Billing is determined by the resource usage, the associated pricing plan, and the data source that was specified. For more information about each pricing plan option and restrictions, see the Amazon Location Service pricing page.
Valid Values: Esri | Here
Specifies the data provider of geospatial data.
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.
Valid values include:
Esri
Here
For additional details on data providers, see the Amazon Location Service data providers page.
", - "CreateTrackerRequest$PricingPlanDataSource": "Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) or the Mobile Asset Management (MAM) pricing plan is selected.
Billing is determined by the resource usage, the associated pricing plan, and data source that was specified. For more information about each pricing plan option and restrictions, see the Amazon Location Service pricing page.
Valid Values: Esri | Here
The data source selected for the geofence collection and associated pricing plan.
", + "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
Specifies the data provider of geospatial data.
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.
Valid values include:
Esri
Here
Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
For additional details on data providers, see the Amazon Location Service data providers page.
", + "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.
Valid Values: Esri | Here
For more information about data providers, see Amazon Location Service data providers.
", + "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.
", "DescribeMapResponse$DataSource": "Specifies the data provider for the associated map tiles.
", "DescribePlaceIndexResponse$DataSource": "The data provider of geospatial data. Indicates one of the available providers:
Esri
Here
For additional details on data providers, see the Amazon Location Service data providers page.
", - "DescribeTrackerResponse$PricingPlanDataSource": "The data source selected for the tracker resource and associated pricing plan.
", + "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.
", "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, Arial Unicode.
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 data source selected for the geofence collection and associated pricing plan.
", + "ListGeofenceCollectionsResponseEntry$PricingPlanDataSource": "The specified data provider for the geofence collection.
", "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. Indicates one of the available providers:
Esri
HERE
For additional details on data providers, see the Amazon Location Service data providers page.
", - "ListTrackersResponseEntry$PricingPlanDataSource": "The data source selected for the tracker resource and associated pricing plan.
", + "ListPlaceIndexesResponseEntry$DataSource": "The data provider of geospatial data. Indicates one of the available providers:
Esri
Here
For additional details on data providers, see the Amazon Location Service data providers page.
", + "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.
", "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 data provider of geospatial data. Indicates one of the available providers:
Esri
HERE
For additional details on data providers, see the Amazon Location Service data providers page.
", "SearchPlaceIndexForTextSummary$DataSource": "The data provider of geospatial data. Indicates one of the available providers:
Esri
HERE
For additional details on data providers, see the Amazon Location Service data providers page.
", + "TagKeys$member": null, "ThrottlingException$Message": null, "ValidationException$Message": null, "ValidationExceptionField$Message": "A message with the reason for the validation exception error.
", @@ -1017,6 +1335,51 @@ "SearchPlaceIndexForTextSummary$Text": "The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.
The list of tag keys to remove from the resource.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "CreateGeofenceCollectionRequest$Tags": "Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: \"key\" : \"value\"
Restrictions:
Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: \"key\" : \"value\"
Restrictions:
Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: \"key\" : \"value\"
Restrictions:
Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
For example: { \"tag1\" : \"value1\", \"tag2\" : \"value2\"}
Format: \"key\" : \"value\"
Restrictions:
Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: \"key\" : \"value\"
Restrictions:
Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Displays the key, value pairs of tags associated with this resource.
", + "DescribeMapResponse$Tags": "Tags associated with the map resource.
", + "DescribePlaceIndexResponse$Tags": "Tags associated with place index resource.
", + "DescribeRouteCalculatorResponse$Tags": "Tags associated with route calculator resource.
", + "DescribeTrackerResponse$Tags": "The tags associated with the tracker resource.
", + "ListTagsForResourceResponse$Tags": "The mapping from tag key to tag value for each tag associated with the specified resource.
", + "TagResourceRequest$Tags": "The mapping from tag key to tag value for each tag associated with the specified resource.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "TagMap$value": null + } + }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": { @@ -1029,16 +1392,20 @@ "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 a 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.
The timestamp for when the Place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
For example, 2020–07-2T12:15:20.000Z+01:00
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp for when the geofence collection was last updated 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.
The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the Place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the Place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
For example, 2020–07-2T12:15:20.000Z+01:00
The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
For example, 2020–07-2T12:15:20.000Z+01:00
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp for when the geofence collection 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.
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
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 for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the Place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the Place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
For example, 2020–07-2T12:15:20.000Z+01:00
The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
For example, 2020–07-2T12:15:20.000Z+01:00
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
", + "GetDevicePositionHistoryResponse$NextToken": "A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
", + "ListDevicePositionsRequest$NextToken": "The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
", "ListGeofenceCollectionsRequest$NextToken": "The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
", "ListGeofencesRequest$NextToken": "The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
", "ListPlaceIndexesRequest$NextToken": "The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
", + "ListRouteCalculatorsRequest$NextToken": "The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default Value: null
A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.
", "ListTrackerConsumersRequest$NextToken": "The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
", "ListTrackersRequest$NextToken": "The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
" } }, + "TravelMode": { + "base": null, + "refs": { + "CalculateRouteRequest$TravelMode": "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
Contains details about the truck dimensions in the unit of measurement that you specify. Used to filter out roads that can't support or allow the specified dimensions for requests that specify TravelMode as Truck.
Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
" + } + }, + "TruckDimensionsHeightDouble": { + "base": null, + "refs": { + "TruckDimensions$Height": "The height of the truck.
For example, 4.5.
The length of the truck.
For example, 15.5.
The width of the truck.
For example, 4.5.
Contains details about the truck's weight specifications. Used to avoid roads that can't support or allow the total weight for requests that specify TravelMode as Truck.
Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
" + } + }, + "TruckWeightTotalDouble": { + "base": null, + "refs": { + "TruckWeight$Total": "The total weight of the truck.
For example, 3500.
The input failed to meet the constraints specified by the AWS service.
", "refs": { @@ -1105,6 +1531,12 @@ "refs": { "ValidationException$Reason": "A message with the reason for the validation exception error.
" } + }, + "VehicleWeightUnit": { + "base": null, + "refs": { + "TruckWeight$Unit": "The unit of measurement to use for the truck weight.
Default Value: Kilograms
Tags can help you organize and categorize your resources. You can also +// use them to scope user permissions, by granting a user permission to access +// or change only resources with certain tag values.
Tags don't have +// any semantic meaning to AWS and are interpreted strictly as strings of +// characters.
You can use the TagResource action with
+// an Amazon Location Service resource that already has tags. If you specify
+// a new tag key for the resource, this tag is appended to the tags already
+// associated with the resource. If you specify a tag key that is already
+// associated with the resource, the new tag value that you specify replaces
+// the previous value for that tag.
You can associate as many as +// 50 tags with a resource.
+// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon Location Service's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request has failed to process because of an unknown server error, exception, +// or failure. +// +// * ResourceNotFoundException +// The resource that you've entered was not found in your AWS account. +// +// * AccessDeniedException +// The request was denied due to insufficient access or permission. Check with +// an administrator to verify your permissions. +// +// * ValidationException +// The input failed to meet the constraints specified by the AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResource +func (c *LocationService) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LocationService) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResource +func (c *LocationService) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("metadata.", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// UntagResource API operation for Amazon Location Service. +// +// Removes one or more tags from the specified Amazon Location Service resource. +// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon Location Service's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request has failed to process because of an unknown server error, exception, +// or failure. +// +// * ResourceNotFoundException +// The resource that you've entered was not found in your AWS account. +// +// * AccessDeniedException +// The request was denied due to insufficient access or permission. Check with +// an administrator to verify your permissions. +// +// * ValidationException +// The input failed to meet the constraints specified by the AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResource +func (c *LocationService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LocationService) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// The request was denied due to insufficient access or permission. Check with +// an administrator to verify your permissions. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +type AssociateTrackerConsumerInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the geofence collection to be associated + // to tracker resource. Used when you need to specify a resource across all + // AWS. + // + // * Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer + // + // ConsumerArn is a required field + ConsumerArn *string `type:"string" required:"true"` + + // The name of the tracker resource to be associated with a geofence collection. + // + // TrackerName is a required field + TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s AssociateTrackerConsumerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssociateTrackerConsumerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociateTrackerConsumerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociateTrackerConsumerInput"} + if s.ConsumerArn == nil { + invalidParams.Add(request.NewErrParamRequired("ConsumerArn")) + } + if s.TrackerName == nil { + invalidParams.Add(request.NewErrParamRequired("TrackerName")) + } + if s.TrackerName != nil && len(*s.TrackerName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConsumerArn sets the ConsumerArn field's value. +func (s *AssociateTrackerConsumerInput) SetConsumerArn(v string) *AssociateTrackerConsumerInput { + s.ConsumerArn = &v + return s +} + +// SetTrackerName sets the TrackerName field's value. +func (s *AssociateTrackerConsumerInput) SetTrackerName(v string) *AssociateTrackerConsumerInput { + s.TrackerName = &v + return s +} + +type AssociateTrackerConsumerOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s AssociateTrackerConsumerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssociateTrackerConsumerOutput) GoString() string { + return s.String() +} + +// Contains the tracker resource details. +type BatchDeleteDevicePositionHistoryError struct { + _ struct{} `type:"structure"` + + // The ID of the device for this position. + // + // DeviceId is a required field + DeviceId *string `min:"1" type:"string" required:"true"` + + // Contains the batch request error details associated with the request. + // + // Error is a required field + Error *BatchItemError `type:"structure" required:"true"` +} + +// String returns the string representation +func (s BatchDeleteDevicePositionHistoryError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDeleteDevicePositionHistoryError) GoString() string { + return s.String() +} + +// SetDeviceId sets the DeviceId field's value. +func (s *BatchDeleteDevicePositionHistoryError) SetDeviceId(v string) *BatchDeleteDevicePositionHistoryError { + s.DeviceId = &v + return s +} + +// SetError sets the Error field's value. +func (s *BatchDeleteDevicePositionHistoryError) SetError(v *BatchItemError) *BatchDeleteDevicePositionHistoryError { + s.Error = v + return s +} + +type BatchDeleteDevicePositionHistoryInput struct { + _ struct{} `type:"structure"` + + // Devices whose position history you want to delete. + // + // * For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2] + // + // DeviceIds is a required field + DeviceIds []*string `min:"1" type:"list" required:"true"` + + // The name of the tracker resource to delete the device position history from. + // + // TrackerName is a required field + TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s BatchDeleteDevicePositionHistoryInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDeleteDevicePositionHistoryInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDeleteDevicePositionHistoryInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDeleteDevicePositionHistoryInput"} + if s.DeviceIds == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceIds")) + } + if s.DeviceIds != nil && len(s.DeviceIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceIds", 1)) + } + if s.TrackerName == nil { + invalidParams.Add(request.NewErrParamRequired("TrackerName")) + } + if s.TrackerName != nil && len(*s.TrackerName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDeviceIds sets the DeviceIds field's value. +func (s *BatchDeleteDevicePositionHistoryInput) SetDeviceIds(v []*string) *BatchDeleteDevicePositionHistoryInput { + s.DeviceIds = v + return s +} + +// SetTrackerName sets the TrackerName field's value. +func (s *BatchDeleteDevicePositionHistoryInput) SetTrackerName(v string) *BatchDeleteDevicePositionHistoryInput { + s.TrackerName = &v + return s +} + +type BatchDeleteDevicePositionHistoryOutput struct { + _ struct{} `type:"structure"` + + // Contains error details for each device history that failed to delete. + // + // Errors is a required field + Errors []*BatchDeleteDevicePositionHistoryError `type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchDeleteDevicePositionHistoryOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDeleteDevicePositionHistoryOutput) GoString() string { + return s.String() +} + +// SetErrors sets the Errors field's value. +func (s *BatchDeleteDevicePositionHistoryOutput) SetErrors(v []*BatchDeleteDevicePositionHistoryError) *BatchDeleteDevicePositionHistoryOutput { + s.Errors = v + return s +} + +// Contains error details for each geofence that failed to delete from the geofence +// collection. +type BatchDeleteGeofenceError struct { + _ struct{} `type:"structure"` + + // Contains details associated to the batch error. + // + // Error is a required field + Error *BatchItemError `type:"structure" required:"true"` + + // The geofence associated with the error message. + // + // GeofenceId is a required field + GeofenceId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s BatchDeleteGeofenceError) String() string { + return awsutil.Prettify(s) } -// The request was denied due to insufficient access or permission. Check with -// an administrator to verify your permissions. -type AccessDeniedException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// GoString returns the string representation +func (s BatchDeleteGeofenceError) GoString() string { + return s.String() +} - Message_ *string `locationName:"message" type:"string"` +// SetError sets the Error field's value. +func (s *BatchDeleteGeofenceError) SetError(v *BatchItemError) *BatchDeleteGeofenceError { + s.Error = v + return s +} + +// SetGeofenceId sets the GeofenceId field's value. +func (s *BatchDeleteGeofenceError) SetGeofenceId(v string) *BatchDeleteGeofenceError { + s.GeofenceId = &v + return s +} + +type BatchDeleteGeofenceInput struct { + _ struct{} `type:"structure"` + + // The geofence collection storing the geofences to be deleted. + // + // CollectionName is a required field + CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"` + + // The batch of geofences to be deleted. + // + // GeofenceIds is a required field + GeofenceIds []*string `min:"1" type:"list" required:"true"` } // String returns the string representation -func (s AccessDeniedException) String() string { +func (s BatchDeleteGeofenceInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s AccessDeniedException) GoString() string { +func (s BatchDeleteGeofenceInput) GoString() string { return s.String() } -func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { - return &AccessDeniedException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDeleteGeofenceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDeleteGeofenceInput"} + if s.CollectionName == nil { + invalidParams.Add(request.NewErrParamRequired("CollectionName")) + } + if s.CollectionName != nil && len(*s.CollectionName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CollectionName", 1)) + } + if s.GeofenceIds == nil { + invalidParams.Add(request.NewErrParamRequired("GeofenceIds")) + } + if s.GeofenceIds != nil && len(s.GeofenceIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GeofenceIds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams } + return nil } -// Code returns the exception type name. -func (s *AccessDeniedException) Code() string { - return "AccessDeniedException" +// SetCollectionName sets the CollectionName field's value. +func (s *BatchDeleteGeofenceInput) SetCollectionName(v string) *BatchDeleteGeofenceInput { + s.CollectionName = &v + return s } -// Message returns the exception's message. -func (s *AccessDeniedException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetGeofenceIds sets the GeofenceIds field's value. +func (s *BatchDeleteGeofenceInput) SetGeofenceIds(v []*string) *BatchDeleteGeofenceInput { + s.GeofenceIds = v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *AccessDeniedException) OrigErr() error { - return nil +type BatchDeleteGeofenceOutput struct { + _ struct{} `type:"structure"` + + // Contains error details for each geofence that failed to delete. + // + // Errors is a required field + Errors []*BatchDeleteGeofenceError `type:"list" required:"true"` } -func (s *AccessDeniedException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// String returns the string representation +func (s BatchDeleteGeofenceOutput) String() string { + return awsutil.Prettify(s) } -// Status code returns the HTTP status code for the request's response error. -func (s *AccessDeniedException) StatusCode() int { - return s.RespMetadata.StatusCode +// GoString returns the string representation +func (s BatchDeleteGeofenceOutput) GoString() string { + return s.String() } -// RequestID returns the service's response RequestID for request. -func (s *AccessDeniedException) RequestID() string { - return s.RespMetadata.RequestID +// SetErrors sets the Errors field's value. +func (s *BatchDeleteGeofenceOutput) SetErrors(v []*BatchDeleteGeofenceError) *BatchDeleteGeofenceOutput { + s.Errors = v + return s } -type AssociateTrackerConsumerInput struct { +// Contains error details for each device that failed to evaluate its position +// against the geofences in a given geofence collection. +type BatchEvaluateGeofencesError struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) for the geofence collection to be associated - // to tracker resource. Used when you need to specify a resource across all - // AWS. + // The device associated with the position evaluation error. // - // * Format example: arn:partition:service:region:account-id:resource-type:resource-id + // DeviceId is a required field + DeviceId *string `min:"1" type:"string" required:"true"` + + // Contains details associated to the batch error. // - // ConsumerArn is a required field - ConsumerArn *string `type:"string" required:"true"` + // Error is a required field + Error *BatchItemError `type:"structure" required:"true"` - // The name of the tracker resource to be associated with a geofence collection. + // Specifies a timestamp for when the error occurred in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // - // TrackerName is a required field - TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` + // SampleTime is a required field + SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` } // String returns the string representation -func (s AssociateTrackerConsumerInput) String() string { +func (s BatchEvaluateGeofencesError) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s AssociateTrackerConsumerInput) GoString() string { +func (s BatchEvaluateGeofencesError) GoString() string { + return s.String() +} + +// SetDeviceId sets the DeviceId field's value. +func (s *BatchEvaluateGeofencesError) SetDeviceId(v string) *BatchEvaluateGeofencesError { + s.DeviceId = &v + return s +} + +// SetError sets the Error field's value. +func (s *BatchEvaluateGeofencesError) SetError(v *BatchItemError) *BatchEvaluateGeofencesError { + s.Error = v + return s +} + +// SetSampleTime sets the SampleTime field's value. +func (s *BatchEvaluateGeofencesError) SetSampleTime(v time.Time) *BatchEvaluateGeofencesError { + s.SampleTime = &v + return s +} + +type BatchEvaluateGeofencesInput struct { + _ struct{} `type:"structure"` + + // The geofence collection used in evaluating the position of devices against + // its geofences. + // + // CollectionName is a required field + CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"` + + // Contains device details for each device to be evaluated against the given + // geofence collection. + // + // DevicePositionUpdates is a required field + DevicePositionUpdates []*DevicePositionUpdate `min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchEvaluateGeofencesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchEvaluateGeofencesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *AssociateTrackerConsumerInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AssociateTrackerConsumerInput"} - if s.ConsumerArn == nil { - invalidParams.Add(request.NewErrParamRequired("ConsumerArn")) +func (s *BatchEvaluateGeofencesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchEvaluateGeofencesInput"} + if s.CollectionName == nil { + invalidParams.Add(request.NewErrParamRequired("CollectionName")) } - if s.TrackerName == nil { - invalidParams.Add(request.NewErrParamRequired("TrackerName")) + if s.CollectionName != nil && len(*s.CollectionName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CollectionName", 1)) } - if s.TrackerName != nil && len(*s.TrackerName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) + if s.DevicePositionUpdates == nil { + invalidParams.Add(request.NewErrParamRequired("DevicePositionUpdates")) + } + if s.DevicePositionUpdates != nil && len(s.DevicePositionUpdates) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DevicePositionUpdates", 1)) + } + if s.DevicePositionUpdates != nil { + for i, v := range s.DevicePositionUpdates { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DevicePositionUpdates", i), err.(request.ErrInvalidParams)) + } + } } if invalidParams.Len() > 0 { @@ -3946,108 +5394,121 @@ func (s *AssociateTrackerConsumerInput) Validate() error { return nil } -// SetConsumerArn sets the ConsumerArn field's value. -func (s *AssociateTrackerConsumerInput) SetConsumerArn(v string) *AssociateTrackerConsumerInput { - s.ConsumerArn = &v +// SetCollectionName sets the CollectionName field's value. +func (s *BatchEvaluateGeofencesInput) SetCollectionName(v string) *BatchEvaluateGeofencesInput { + s.CollectionName = &v return s } -// SetTrackerName sets the TrackerName field's value. -func (s *AssociateTrackerConsumerInput) SetTrackerName(v string) *AssociateTrackerConsumerInput { - s.TrackerName = &v +// SetDevicePositionUpdates sets the DevicePositionUpdates field's value. +func (s *BatchEvaluateGeofencesInput) SetDevicePositionUpdates(v []*DevicePositionUpdate) *BatchEvaluateGeofencesInput { + s.DevicePositionUpdates = v return s } -type AssociateTrackerConsumerOutput struct { +type BatchEvaluateGeofencesOutput struct { _ struct{} `type:"structure"` + + // Contains error details for each device that failed to evaluate its position + // against the given geofence collection. + // + // Errors is a required field + Errors []*BatchEvaluateGeofencesError `type:"list" required:"true"` } // String returns the string representation -func (s AssociateTrackerConsumerOutput) String() string { +func (s BatchEvaluateGeofencesOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s AssociateTrackerConsumerOutput) GoString() string { +func (s BatchEvaluateGeofencesOutput) GoString() string { return s.String() } -// Contains error details for each geofence that failed to delete from the geofence -// collection. -type BatchDeleteGeofenceError struct { +// SetErrors sets the Errors field's value. +func (s *BatchEvaluateGeofencesOutput) SetErrors(v []*BatchEvaluateGeofencesError) *BatchEvaluateGeofencesOutput { + s.Errors = v + return s +} + +// Contains error details for each device that didn't return a position. +type BatchGetDevicePositionError struct { _ struct{} `type:"structure"` - // Contains details associated to the batch error. + // The ID of the device that didn't return a position. // - // Error is a required field - Error *BatchItemError `type:"structure" required:"true"` + // DeviceId is a required field + DeviceId *string `min:"1" type:"string" required:"true"` - // The geofence associated with the error message. + // Contains details related to the error code. // - // GeofenceId is a required field - GeofenceId *string `min:"1" type:"string" required:"true"` + // Error is a required field + Error *BatchItemError `type:"structure" required:"true"` } // String returns the string representation -func (s BatchDeleteGeofenceError) String() string { +func (s BatchGetDevicePositionError) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchDeleteGeofenceError) GoString() string { +func (s BatchGetDevicePositionError) GoString() string { return s.String() } -// SetError sets the Error field's value. -func (s *BatchDeleteGeofenceError) SetError(v *BatchItemError) *BatchDeleteGeofenceError { - s.Error = v +// SetDeviceId sets the DeviceId field's value. +func (s *BatchGetDevicePositionError) SetDeviceId(v string) *BatchGetDevicePositionError { + s.DeviceId = &v return s } -// SetGeofenceId sets the GeofenceId field's value. -func (s *BatchDeleteGeofenceError) SetGeofenceId(v string) *BatchDeleteGeofenceError { - s.GeofenceId = &v +// SetError sets the Error field's value. +func (s *BatchGetDevicePositionError) SetError(v *BatchItemError) *BatchGetDevicePositionError { + s.Error = v return s } -type BatchDeleteGeofenceInput struct { +type BatchGetDevicePositionInput struct { _ struct{} `type:"structure"` - // The geofence collection storing the geofences to be deleted. + // Devices whose position you want to retrieve. // - // CollectionName is a required field - CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"` + // * For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2 + // + // DeviceIds is a required field + DeviceIds []*string `min:"1" type:"list" required:"true"` - // The batch of geofences to be deleted. + // The tracker resource retrieving the device position. // - // GeofenceIds is a required field - GeofenceIds []*string `min:"1" type:"list" required:"true"` + // TrackerName is a required field + TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s BatchDeleteGeofenceInput) String() string { +func (s BatchGetDevicePositionInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchDeleteGeofenceInput) GoString() string { +func (s BatchGetDevicePositionInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDeleteGeofenceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDeleteGeofenceInput"} - if s.CollectionName == nil { - invalidParams.Add(request.NewErrParamRequired("CollectionName")) +func (s *BatchGetDevicePositionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchGetDevicePositionInput"} + if s.DeviceIds == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceIds")) } - if s.CollectionName != nil && len(*s.CollectionName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("CollectionName", 1)) + if s.DeviceIds != nil && len(s.DeviceIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceIds", 1)) } - if s.GeofenceIds == nil { - invalidParams.Add(request.NewErrParamRequired("GeofenceIds")) + if s.TrackerName == nil { + invalidParams.Add(request.NewErrParamRequired("TrackerName")) } - if s.GeofenceIds != nil && len(s.GeofenceIds) < 1 { - invalidParams.Add(request.NewErrParamMinLen("GeofenceIds", 1)) + if s.TrackerName != nil && len(*s.TrackerName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) } if invalidParams.Len() > 0 { @@ -4056,266 +5517,276 @@ func (s *BatchDeleteGeofenceInput) Validate() error { return nil } -// SetCollectionName sets the CollectionName field's value. -func (s *BatchDeleteGeofenceInput) SetCollectionName(v string) *BatchDeleteGeofenceInput { - s.CollectionName = &v +// SetDeviceIds sets the DeviceIds field's value. +func (s *BatchGetDevicePositionInput) SetDeviceIds(v []*string) *BatchGetDevicePositionInput { + s.DeviceIds = v return s } -// SetGeofenceIds sets the GeofenceIds field's value. -func (s *BatchDeleteGeofenceInput) SetGeofenceIds(v []*string) *BatchDeleteGeofenceInput { - s.GeofenceIds = v +// SetTrackerName sets the TrackerName field's value. +func (s *BatchGetDevicePositionInput) SetTrackerName(v string) *BatchGetDevicePositionInput { + s.TrackerName = &v return s } -type BatchDeleteGeofenceOutput struct { +type BatchGetDevicePositionOutput struct { _ struct{} `type:"structure"` - // Contains error details for each geofence that failed to delete. + // Contains device position details such as the device ID, position, and timestamps + // for when the position was received and sampled. + // + // DevicePositions is a required field + DevicePositions []*DevicePosition `type:"list" required:"true"` + + // Contains error details for each device that failed to send its position to + // the tracker resource. // // Errors is a required field - Errors []*BatchDeleteGeofenceError `type:"list" required:"true"` + Errors []*BatchGetDevicePositionError `type:"list" required:"true"` } // String returns the string representation -func (s BatchDeleteGeofenceOutput) String() string { +func (s BatchGetDevicePositionOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchDeleteGeofenceOutput) GoString() string { +func (s BatchGetDevicePositionOutput) GoString() string { return s.String() } +// SetDevicePositions sets the DevicePositions field's value. +func (s *BatchGetDevicePositionOutput) SetDevicePositions(v []*DevicePosition) *BatchGetDevicePositionOutput { + s.DevicePositions = v + return s +} + // SetErrors sets the Errors field's value. -func (s *BatchDeleteGeofenceOutput) SetErrors(v []*BatchDeleteGeofenceError) *BatchDeleteGeofenceOutput { +func (s *BatchGetDevicePositionOutput) SetErrors(v []*BatchGetDevicePositionError) *BatchGetDevicePositionOutput { s.Errors = v return s } -// Contains error details for each device that failed to evaluate its position -// against the geofences in a given geofence collection. -type BatchEvaluateGeofencesError struct { +// Contains the batch request error details associated with the request. +type BatchItemError struct { _ struct{} `type:"structure"` - // The device associated with the position evaluation error. - // - // DeviceId is a required field - DeviceId *string `min:"1" type:"string" required:"true"` + // The error code associated with the batch request error. + Code *string `type:"string" enum:"BatchItemErrorCode"` + + // A message with the reason for the batch request error. + Message *string `type:"string"` +} + +// String returns the string representation +func (s BatchItemError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchItemError) GoString() string { + return s.String() +} + +// SetCode sets the Code field's value. +func (s *BatchItemError) SetCode(v string) *BatchItemError { + s.Code = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *BatchItemError) SetMessage(v string) *BatchItemError { + s.Message = &v + return s +} + +// Contains error details for each geofence that failed to be stored in a given +// geofence collection. +type BatchPutGeofenceError struct { + _ struct{} `type:"structure"` // Contains details associated to the batch error. // // Error is a required field Error *BatchItemError `type:"structure" required:"true"` - // Specifies a timestamp for when the error occurred in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) - // format: YYYY-MM-DDThh:mm:ss.sssZ + // The geofence associated with the error message. // - // SampleTime is a required field - SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + // GeofenceId is a required field + GeofenceId *string `min:"1" type:"string" required:"true"` } // String returns the string representation -func (s BatchEvaluateGeofencesError) String() string { +func (s BatchPutGeofenceError) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchEvaluateGeofencesError) GoString() string { +func (s BatchPutGeofenceError) GoString() string { return s.String() } -// SetDeviceId sets the DeviceId field's value. -func (s *BatchEvaluateGeofencesError) SetDeviceId(v string) *BatchEvaluateGeofencesError { - s.DeviceId = &v - return s -} - // SetError sets the Error field's value. -func (s *BatchEvaluateGeofencesError) SetError(v *BatchItemError) *BatchEvaluateGeofencesError { +func (s *BatchPutGeofenceError) SetError(v *BatchItemError) *BatchPutGeofenceError { s.Error = v return s } -// SetSampleTime sets the SampleTime field's value. -func (s *BatchEvaluateGeofencesError) SetSampleTime(v time.Time) *BatchEvaluateGeofencesError { - s.SampleTime = &v +// SetGeofenceId sets the GeofenceId field's value. +func (s *BatchPutGeofenceError) SetGeofenceId(v string) *BatchPutGeofenceError { + s.GeofenceId = &v return s } -type BatchEvaluateGeofencesInput struct { +type BatchPutGeofenceInput struct { _ struct{} `type:"structure"` - // The geofence collection used in evaluating the position of devices against - // its geofences. + // The geofence collection storing the geofences. // // CollectionName is a required field CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"` - // Contains device details for each device to be evaluated against the given - // geofence collection. + // The batch of geofences to be stored in a geofence collection. // - // DevicePositionUpdates is a required field - DevicePositionUpdates []*DevicePositionUpdate `min:"1" type:"list" required:"true"` + // Entries is a required field + Entries []*BatchPutGeofenceRequestEntry `min:"1" type:"list" required:"true"` } // String returns the string representation -func (s BatchEvaluateGeofencesInput) String() string { +func (s BatchPutGeofenceInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchEvaluateGeofencesInput) GoString() string { +func (s BatchPutGeofenceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchEvaluateGeofencesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchEvaluateGeofencesInput"} +func (s *BatchPutGeofenceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchPutGeofenceInput"} if s.CollectionName == nil { invalidParams.Add(request.NewErrParamRequired("CollectionName")) } if s.CollectionName != nil && len(*s.CollectionName) < 1 { invalidParams.Add(request.NewErrParamMinLen("CollectionName", 1)) } - if s.DevicePositionUpdates == nil { - invalidParams.Add(request.NewErrParamRequired("DevicePositionUpdates")) - } - if s.DevicePositionUpdates != nil && len(s.DevicePositionUpdates) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DevicePositionUpdates", 1)) - } - if s.DevicePositionUpdates != nil { - for i, v := range s.DevicePositionUpdates { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DevicePositionUpdates", i), err.(request.ErrInvalidParams)) - } - } + if s.Entries == nil { + invalidParams.Add(request.NewErrParamRequired("Entries")) } - - if invalidParams.Len() > 0 { - return invalidParams + if s.Entries != nil && len(s.Entries) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Entries", 1)) + } + if s.Entries != nil { + for i, v := range s.Entries { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Entries", i), err.(request.ErrInvalidParams)) + } + } } - return nil -} - -// SetCollectionName sets the CollectionName field's value. -func (s *BatchEvaluateGeofencesInput) SetCollectionName(v string) *BatchEvaluateGeofencesInput { - s.CollectionName = &v - return s -} - -// SetDevicePositionUpdates sets the DevicePositionUpdates field's value. -func (s *BatchEvaluateGeofencesInput) SetDevicePositionUpdates(v []*DevicePositionUpdate) *BatchEvaluateGeofencesInput { - s.DevicePositionUpdates = v - return s -} - -type BatchEvaluateGeofencesOutput struct { - _ struct{} `type:"structure"` - - // Contains error details for each device that failed to evaluate its position - // against the given geofence collection. - // - // Errors is a required field - Errors []*BatchEvaluateGeofencesError `type:"list" required:"true"` -} -// String returns the string representation -func (s BatchEvaluateGeofencesOutput) String() string { - return awsutil.Prettify(s) + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// GoString returns the string representation -func (s BatchEvaluateGeofencesOutput) GoString() string { - return s.String() +// SetCollectionName sets the CollectionName field's value. +func (s *BatchPutGeofenceInput) SetCollectionName(v string) *BatchPutGeofenceInput { + s.CollectionName = &v + return s } -// SetErrors sets the Errors field's value. -func (s *BatchEvaluateGeofencesOutput) SetErrors(v []*BatchEvaluateGeofencesError) *BatchEvaluateGeofencesOutput { - s.Errors = v +// SetEntries sets the Entries field's value. +func (s *BatchPutGeofenceInput) SetEntries(v []*BatchPutGeofenceRequestEntry) *BatchPutGeofenceInput { + s.Entries = v return s } -// Contains error details for each device that didn't return a position. -type BatchGetDevicePositionError struct { +type BatchPutGeofenceOutput struct { _ struct{} `type:"structure"` - // The ID of the device that didn't return a position. + // Contains additional error details for each geofence that failed to be stored + // in a geofence collection. // - // DeviceId is a required field - DeviceId *string `min:"1" type:"string" required:"true"` + // Errors is a required field + Errors []*BatchPutGeofenceError `type:"list" required:"true"` - // Contains details related to the error code. + // Contains each geofence that was successfully stored in a geofence collection. // - // Error is a required field - Error *BatchItemError `type:"structure" required:"true"` + // Successes is a required field + Successes []*BatchPutGeofenceSuccess `type:"list" required:"true"` } // String returns the string representation -func (s BatchGetDevicePositionError) String() string { +func (s BatchPutGeofenceOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchGetDevicePositionError) GoString() string { +func (s BatchPutGeofenceOutput) GoString() string { return s.String() } -// SetDeviceId sets the DeviceId field's value. -func (s *BatchGetDevicePositionError) SetDeviceId(v string) *BatchGetDevicePositionError { - s.DeviceId = &v +// SetErrors sets the Errors field's value. +func (s *BatchPutGeofenceOutput) SetErrors(v []*BatchPutGeofenceError) *BatchPutGeofenceOutput { + s.Errors = v return s } -// SetError sets the Error field's value. -func (s *BatchGetDevicePositionError) SetError(v *BatchItemError) *BatchGetDevicePositionError { - s.Error = v +// SetSuccesses sets the Successes field's value. +func (s *BatchPutGeofenceOutput) SetSuccesses(v []*BatchPutGeofenceSuccess) *BatchPutGeofenceOutput { + s.Successes = v return s } -type BatchGetDevicePositionInput struct { +// Contains geofence geometry details. +type BatchPutGeofenceRequestEntry struct { _ struct{} `type:"structure"` - // Devices whose position you want to retrieve. - // - // * For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2 + // The identifier for the geofence to be stored in a given geofence collection. // - // DeviceIds is a required field - DeviceIds []*string `min:"1" type:"list" required:"true"` + // GeofenceId is a required field + GeofenceId *string `min:"1" type:"string" required:"true"` - // The tracker resource retrieving the device position. + // Contains the polygon details to specify the position of the geofence. // - // TrackerName is a required field - TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` + // Each geofence polygon (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) + // can have a maximum of 1,000 vertices. + // + // Geometry is a required field + Geometry *GeofenceGeometry `type:"structure" required:"true"` } // String returns the string representation -func (s BatchGetDevicePositionInput) String() string { +func (s BatchPutGeofenceRequestEntry) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchGetDevicePositionInput) GoString() string { +func (s BatchPutGeofenceRequestEntry) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchGetDevicePositionInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchGetDevicePositionInput"} - if s.DeviceIds == nil { - invalidParams.Add(request.NewErrParamRequired("DeviceIds")) +func (s *BatchPutGeofenceRequestEntry) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchPutGeofenceRequestEntry"} + if s.GeofenceId == nil { + invalidParams.Add(request.NewErrParamRequired("GeofenceId")) } - if s.DeviceIds != nil && len(s.DeviceIds) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DeviceIds", 1)) + if s.GeofenceId != nil && len(*s.GeofenceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GeofenceId", 1)) } - if s.TrackerName == nil { - invalidParams.Add(request.NewErrParamRequired("TrackerName")) + if s.Geometry == nil { + invalidParams.Add(request.NewErrParamRequired("Geometry")) } - if s.TrackerName != nil && len(*s.TrackerName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) + if s.Geometry != nil { + if err := s.Geometry.Validate(); err != nil { + invalidParams.AddNested("Geometry", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -4324,173 +5795,166 @@ func (s *BatchGetDevicePositionInput) Validate() error { return nil } -// SetDeviceIds sets the DeviceIds field's value. -func (s *BatchGetDevicePositionInput) SetDeviceIds(v []*string) *BatchGetDevicePositionInput { - s.DeviceIds = v +// SetGeofenceId sets the GeofenceId field's value. +func (s *BatchPutGeofenceRequestEntry) SetGeofenceId(v string) *BatchPutGeofenceRequestEntry { + s.GeofenceId = &v return s } -// SetTrackerName sets the TrackerName field's value. -func (s *BatchGetDevicePositionInput) SetTrackerName(v string) *BatchGetDevicePositionInput { - s.TrackerName = &v +// SetGeometry sets the Geometry field's value. +func (s *BatchPutGeofenceRequestEntry) SetGeometry(v *GeofenceGeometry) *BatchPutGeofenceRequestEntry { + s.Geometry = v return s } -type BatchGetDevicePositionOutput struct { +// Contains a summary of each geofence that was successfully stored in a given +// geofence collection. +type BatchPutGeofenceSuccess struct { _ struct{} `type:"structure"` - // Contains device position details such as the device ID, position, and timestamps - // for when the position was received and sampled. + // The timestamp for when the geofence was stored in a geofence collection in + // ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: + // YYYY-MM-DDThh:mm:ss.sssZ // - // DevicePositions is a required field - DevicePositions []*DevicePosition `type:"list" required:"true"` + // CreateTime is a required field + CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Contains error details for each device that failed to send its position to - // the tracker resource. + // The geofence successfully stored in a geofence collection. // - // Errors is a required field - Errors []*BatchGetDevicePositionError `type:"list" required:"true"` + // GeofenceId is a required field + GeofenceId *string `min:"1" type:"string" required:"true"` + + // The timestamp for when the geofence was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ + // + // UpdateTime is a required field + UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` } // String returns the string representation -func (s BatchGetDevicePositionOutput) String() string { +func (s BatchPutGeofenceSuccess) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchGetDevicePositionOutput) GoString() string { +func (s BatchPutGeofenceSuccess) GoString() string { return s.String() } -// SetDevicePositions sets the DevicePositions field's value. -func (s *BatchGetDevicePositionOutput) SetDevicePositions(v []*DevicePosition) *BatchGetDevicePositionOutput { - s.DevicePositions = v - return s -} - -// SetErrors sets the Errors field's value. -func (s *BatchGetDevicePositionOutput) SetErrors(v []*BatchGetDevicePositionError) *BatchGetDevicePositionOutput { - s.Errors = v +// SetCreateTime sets the CreateTime field's value. +func (s *BatchPutGeofenceSuccess) SetCreateTime(v time.Time) *BatchPutGeofenceSuccess { + s.CreateTime = &v return s } -// Contains the batch request error details associated with the request. -type BatchItemError struct { - _ struct{} `type:"structure"` - - // The error code associated with the batch request error. - Code *string `type:"string" enum:"BatchItemErrorCode"` - - // A message with the reason for the batch request error. - Message *string `type:"string"` -} - -// String returns the string representation -func (s BatchItemError) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s BatchItemError) GoString() string { - return s.String() -} - -// SetCode sets the Code field's value. -func (s *BatchItemError) SetCode(v string) *BatchItemError { - s.Code = &v +// SetGeofenceId sets the GeofenceId field's value. +func (s *BatchPutGeofenceSuccess) SetGeofenceId(v string) *BatchPutGeofenceSuccess { + s.GeofenceId = &v return s } -// SetMessage sets the Message field's value. -func (s *BatchItemError) SetMessage(v string) *BatchItemError { - s.Message = &v +// SetUpdateTime sets the UpdateTime field's value. +func (s *BatchPutGeofenceSuccess) SetUpdateTime(v time.Time) *BatchPutGeofenceSuccess { + s.UpdateTime = &v return s } -// Contains error details for each geofence that failed to be stored in a given -// geofence collection. -type BatchPutGeofenceError struct { +// Contains error details for each device that failed to update its position. +type BatchUpdateDevicePositionError struct { _ struct{} `type:"structure"` - // Contains details associated to the batch error. + // The device associated with the failed location update. + // + // DeviceId is a required field + DeviceId *string `min:"1" type:"string" required:"true"` + + // Contains details related to the error code such as the error code and error + // message. // // Error is a required field Error *BatchItemError `type:"structure" required:"true"` - // The geofence associated with the error message. + // The timestamp at which the device position was determined. Uses ISO 8601 + // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. // - // GeofenceId is a required field - GeofenceId *string `min:"1" type:"string" required:"true"` + // SampleTime is a required field + SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` } // String returns the string representation -func (s BatchPutGeofenceError) String() string { +func (s BatchUpdateDevicePositionError) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchPutGeofenceError) GoString() string { +func (s BatchUpdateDevicePositionError) GoString() string { return s.String() } +// SetDeviceId sets the DeviceId field's value. +func (s *BatchUpdateDevicePositionError) SetDeviceId(v string) *BatchUpdateDevicePositionError { + s.DeviceId = &v + return s +} + // SetError sets the Error field's value. -func (s *BatchPutGeofenceError) SetError(v *BatchItemError) *BatchPutGeofenceError { +func (s *BatchUpdateDevicePositionError) SetError(v *BatchItemError) *BatchUpdateDevicePositionError { s.Error = v return s } -// SetGeofenceId sets the GeofenceId field's value. -func (s *BatchPutGeofenceError) SetGeofenceId(v string) *BatchPutGeofenceError { - s.GeofenceId = &v +// SetSampleTime sets the SampleTime field's value. +func (s *BatchUpdateDevicePositionError) SetSampleTime(v time.Time) *BatchUpdateDevicePositionError { + s.SampleTime = &v return s } -type BatchPutGeofenceInput struct { +type BatchUpdateDevicePositionInput struct { _ struct{} `type:"structure"` - // The geofence collection storing the geofences. + // The name of the tracker resource to update. // - // CollectionName is a required field - CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"` + // TrackerName is a required field + TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` - // The batch of geofences to be stored in a geofence collection. + // Contains the position update details for each device. // - // Entries is a required field - Entries []*BatchPutGeofenceRequestEntry `min:"1" type:"list" required:"true"` + // Updates is a required field + Updates []*DevicePositionUpdate `min:"1" type:"list" required:"true"` } // String returns the string representation -func (s BatchPutGeofenceInput) String() string { +func (s BatchUpdateDevicePositionInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchPutGeofenceInput) GoString() string { +func (s BatchUpdateDevicePositionInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchPutGeofenceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchPutGeofenceInput"} - if s.CollectionName == nil { - invalidParams.Add(request.NewErrParamRequired("CollectionName")) +func (s *BatchUpdateDevicePositionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchUpdateDevicePositionInput"} + if s.TrackerName == nil { + invalidParams.Add(request.NewErrParamRequired("TrackerName")) } - if s.CollectionName != nil && len(*s.CollectionName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("CollectionName", 1)) + if s.TrackerName != nil && len(*s.TrackerName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) } - if s.Entries == nil { - invalidParams.Add(request.NewErrParamRequired("Entries")) + if s.Updates == nil { + invalidParams.Add(request.NewErrParamRequired("Updates")) } - if s.Entries != nil && len(s.Entries) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Entries", 1)) + if s.Updates != nil && len(s.Updates) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Updates", 1)) } - if s.Entries != nil { - for i, v := range s.Entries { + if s.Updates != nil { + for i, v := range s.Updates { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Entries", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Updates", i), err.(request.ErrInvalidParams)) } } } @@ -4501,99 +5965,223 @@ func (s *BatchPutGeofenceInput) Validate() error { return nil } -// SetCollectionName sets the CollectionName field's value. -func (s *BatchPutGeofenceInput) SetCollectionName(v string) *BatchPutGeofenceInput { - s.CollectionName = &v +// SetTrackerName sets the TrackerName field's value. +func (s *BatchUpdateDevicePositionInput) SetTrackerName(v string) *BatchUpdateDevicePositionInput { + s.TrackerName = &v return s } -// SetEntries sets the Entries field's value. -func (s *BatchPutGeofenceInput) SetEntries(v []*BatchPutGeofenceRequestEntry) *BatchPutGeofenceInput { - s.Entries = v +// SetUpdates sets the Updates field's value. +func (s *BatchUpdateDevicePositionInput) SetUpdates(v []*DevicePositionUpdate) *BatchUpdateDevicePositionInput { + s.Updates = v return s } -type BatchPutGeofenceOutput struct { +type BatchUpdateDevicePositionOutput struct { _ struct{} `type:"structure"` - // Contains additional error details for each geofence that failed to be stored - // in a geofence collection. + // Contains error details for each device that failed to update its position. // // Errors is a required field - Errors []*BatchPutGeofenceError `type:"list" required:"true"` - - // Contains each geofence that was successfully stored in a geofence collection. - // - // Successes is a required field - Successes []*BatchPutGeofenceSuccess `type:"list" required:"true"` + Errors []*BatchUpdateDevicePositionError `type:"list" required:"true"` } // String returns the string representation -func (s BatchPutGeofenceOutput) String() string { +func (s BatchUpdateDevicePositionOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchPutGeofenceOutput) GoString() string { +func (s BatchUpdateDevicePositionOutput) GoString() string { return s.String() } // SetErrors sets the Errors field's value. -func (s *BatchPutGeofenceOutput) SetErrors(v []*BatchPutGeofenceError) *BatchPutGeofenceOutput { +func (s *BatchUpdateDevicePositionOutput) SetErrors(v []*BatchUpdateDevicePositionError) *BatchUpdateDevicePositionOutput { s.Errors = v return s } -// SetSuccesses sets the Successes field's value. -func (s *BatchPutGeofenceOutput) SetSuccesses(v []*BatchPutGeofenceSuccess) *BatchPutGeofenceOutput { - s.Successes = v +// Contains details about additional route preferences for requests that specify +// TravelMode as Car. +type CalculateRouteCarModeOptions struct { + _ struct{} `type:"structure"` + + // Avoids ferries when calculating routes. + // + // Default Value: false + // + // Valid Values: false | true + AvoidFerries *bool `type:"boolean"` + + // Avoids tolls when calculating routes. + // + // Default Value: false + // + // Valid Values: false | true + AvoidTolls *bool `type:"boolean"` +} + +// String returns the string representation +func (s CalculateRouteCarModeOptions) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CalculateRouteCarModeOptions) GoString() string { + return s.String() +} + +// SetAvoidFerries sets the AvoidFerries field's value. +func (s *CalculateRouteCarModeOptions) SetAvoidFerries(v bool) *CalculateRouteCarModeOptions { + s.AvoidFerries = &v return s } -// Contains geofence geometry details. -type BatchPutGeofenceRequestEntry struct { +// SetAvoidTolls sets the AvoidTolls field's value. +func (s *CalculateRouteCarModeOptions) SetAvoidTolls(v bool) *CalculateRouteCarModeOptions { + s.AvoidTolls = &v + return s +} + +type CalculateRouteInput struct { _ struct{} `type:"structure"` - // The identifier for the geofence to be stored in a given geofence collection. + // The name of the route calculator resource that you want to use to calculate + // a route. // - // GeofenceId is a required field - GeofenceId *string `min:"1" type:"string" required:"true"` + // CalculatorName is a required field + CalculatorName *string `location:"uri" locationName:"CalculatorName" min:"1" type:"string" required:"true"` - // Contains the polygon details to specify the position of the geofence. + // Specifies route preferences when traveling by Car, such as avoiding routes + // that use ferries or tolls. // - // Each geofence polygon (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) - // can have a maximum of 1,000 vertices. + // Requirements: TravelMode must be specified as Car. + CarModeOptions *CalculateRouteCarModeOptions `type:"structure"` + + // 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. // - // Geometry is a required field - Geometry *GeofenceGeometry `type:"structure" required:"true"` + // Default Value: false + // + // Valid Values: false | true + DepartNow *bool `type:"boolean"` + + // The start position for the route. Defined in WGS 84 (https://earth-info.nga.mil/GandG/wgs84/index.html) + // 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 (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road). + // + // Valid Values: [-180 to 180,-90 to 90] + // + // DeparturePosition is a required field + DeparturePosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` + + // Specifies the desired time of departure. Uses the given time to calculate + // a 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 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00 + DepartureTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` + + // The finish position for the route. Defined in WGS 84 (https://earth-info.nga.mil/GandG/wgs84/index.html) + // 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 (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road). + // + // Valid Values: [-180 to 180,-90 to 90] + // + // DestinationPosition is a required field + DestinationPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` + + // Set the unit system to specify the distance. + // + // Default Value: Kilometers + DistanceUnit *string `type:"string" enum:"DistanceUnit"` + + // Set to include the geometry details in the result for each path between a + // pair of positions. + // + // Default Value: false + // + // Valid Values: false | true + IncludeLegGeometry *bool `type:"boolean"` + + // 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 + TravelMode *string `type:"string" enum:"TravelMode"` + + // 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. + TruckModeOptions *CalculateRouteTruckModeOptions `type:"structure"` + + // 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 (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road). + // + // Specifying more than 23 waypoints returns a 400 ValidationException error. + // + // Valid Values: [-180 to 180,-90 to 90] + WaypointPositions [][]*float64 `type:"list"` } // String returns the string representation -func (s BatchPutGeofenceRequestEntry) String() string { +func (s CalculateRouteInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchPutGeofenceRequestEntry) GoString() string { +func (s CalculateRouteInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchPutGeofenceRequestEntry) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchPutGeofenceRequestEntry"} - if s.GeofenceId == nil { - invalidParams.Add(request.NewErrParamRequired("GeofenceId")) +func (s *CalculateRouteInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CalculateRouteInput"} + if s.CalculatorName == nil { + invalidParams.Add(request.NewErrParamRequired("CalculatorName")) } - if s.GeofenceId != nil && len(*s.GeofenceId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("GeofenceId", 1)) + if s.CalculatorName != nil && len(*s.CalculatorName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CalculatorName", 1)) } - if s.Geometry == nil { - invalidParams.Add(request.NewErrParamRequired("Geometry")) + if s.DeparturePosition == nil { + invalidParams.Add(request.NewErrParamRequired("DeparturePosition")) } - if s.Geometry != nil { - if err := s.Geometry.Validate(); err != nil { - invalidParams.AddNested("Geometry", err.(request.ErrInvalidParams)) - } + if s.DeparturePosition != nil && len(s.DeparturePosition) < 2 { + invalidParams.Add(request.NewErrParamMinLen("DeparturePosition", 2)) + } + if s.DestinationPosition == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationPosition")) + } + if s.DestinationPosition != nil && len(s.DestinationPosition) < 2 { + invalidParams.Add(request.NewErrParamMinLen("DestinationPosition", 2)) } if invalidParams.Len() > 0 { @@ -4602,210 +6190,290 @@ func (s *BatchPutGeofenceRequestEntry) Validate() error { return nil } -// SetGeofenceId sets the GeofenceId field's value. -func (s *BatchPutGeofenceRequestEntry) SetGeofenceId(v string) *BatchPutGeofenceRequestEntry { - s.GeofenceId = &v +// SetCalculatorName sets the CalculatorName field's value. +func (s *CalculateRouteInput) SetCalculatorName(v string) *CalculateRouteInput { + s.CalculatorName = &v return s } -// SetGeometry sets the Geometry field's value. -func (s *BatchPutGeofenceRequestEntry) SetGeometry(v *GeofenceGeometry) *BatchPutGeofenceRequestEntry { - s.Geometry = v +// SetCarModeOptions sets the CarModeOptions field's value. +func (s *CalculateRouteInput) SetCarModeOptions(v *CalculateRouteCarModeOptions) *CalculateRouteInput { + s.CarModeOptions = v return s } -// Contains a summary of each geofence that was successfully stored in a given -// geofence collection. -type BatchPutGeofenceSuccess struct { - _ struct{} `type:"structure"` +// SetDepartNow sets the DepartNow field's value. +func (s *CalculateRouteInput) SetDepartNow(v bool) *CalculateRouteInput { + s.DepartNow = &v + return s +} - // The timestamp for when the geofence was stored in a geofence collection in - // ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ - // - // CreateTime is a required field - CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` +// SetDeparturePosition sets the DeparturePosition field's value. +func (s *CalculateRouteInput) SetDeparturePosition(v []*float64) *CalculateRouteInput { + s.DeparturePosition = v + return s +} - // The geofence successfully stored in a geofence collection. - // - // GeofenceId is a required field - GeofenceId *string `min:"1" type:"string" required:"true"` +// SetDepartureTime sets the DepartureTime field's value. +func (s *CalculateRouteInput) SetDepartureTime(v time.Time) *CalculateRouteInput { + s.DepartureTime = &v + return s +} - // The timestamp for when the geofence was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) - // format: YYYY-MM-DDThh:mm:ss.sssZ - // - // UpdateTime is a required field - UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` +// SetDestinationPosition sets the DestinationPosition field's value. +func (s *CalculateRouteInput) SetDestinationPosition(v []*float64) *CalculateRouteInput { + s.DestinationPosition = v + return s } -// String returns the string representation -func (s BatchPutGeofenceSuccess) String() string { - return awsutil.Prettify(s) +// SetDistanceUnit sets the DistanceUnit field's value. +func (s *CalculateRouteInput) SetDistanceUnit(v string) *CalculateRouteInput { + s.DistanceUnit = &v + return s } -// GoString returns the string representation -func (s BatchPutGeofenceSuccess) GoString() string { - return s.String() +// SetIncludeLegGeometry sets the IncludeLegGeometry field's value. +func (s *CalculateRouteInput) SetIncludeLegGeometry(v bool) *CalculateRouteInput { + s.IncludeLegGeometry = &v + return s } -// SetCreateTime sets the CreateTime field's value. -func (s *BatchPutGeofenceSuccess) SetCreateTime(v time.Time) *BatchPutGeofenceSuccess { - s.CreateTime = &v +// SetTravelMode sets the TravelMode field's value. +func (s *CalculateRouteInput) SetTravelMode(v string) *CalculateRouteInput { + s.TravelMode = &v return s } -// SetGeofenceId sets the GeofenceId field's value. -func (s *BatchPutGeofenceSuccess) SetGeofenceId(v string) *BatchPutGeofenceSuccess { - s.GeofenceId = &v +// SetTruckModeOptions sets the TruckModeOptions field's value. +func (s *CalculateRouteInput) SetTruckModeOptions(v *CalculateRouteTruckModeOptions) *CalculateRouteInput { + s.TruckModeOptions = v return s } -// SetUpdateTime sets the UpdateTime field's value. -func (s *BatchPutGeofenceSuccess) SetUpdateTime(v time.Time) *BatchPutGeofenceSuccess { - s.UpdateTime = &v +// SetWaypointPositions sets the WaypointPositions field's value. +func (s *CalculateRouteInput) SetWaypointPositions(v [][]*float64) *CalculateRouteInput { + s.WaypointPositions = v return s } -// Contains error details for each device that failed to update its position. -type BatchUpdateDevicePositionError struct { +// Returns the result of the route calculation. Metadata includes legs and route +// summary. +type CalculateRouteOutput struct { _ struct{} `type:"structure"` - // The device associated with the failed location update. + // 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 less than the total + // number of positions in the request. // - // DeviceId is a required field - DeviceId *string `min:"1" type:"string" required:"true"` - - // Contains details related to the error code such as the error code and error - // message. + // 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): // - // Error is a required field - Error *BatchItemError `type:"structure" required:"true"` + // * 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. + // + // Legs is a required field + Legs []*Leg `type:"list" required:"true"` - // The timestamp at which the device position was determined. Uses ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. + // Contains information about the whole route, such as: RouteBBox, DataSource, + // Distance, DistanceUnit, and DurationSeconds // - // SampleTime is a required field - SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + // Summary is a required field + Summary *CalculateRouteSummary `type:"structure" required:"true"` } // String returns the string representation -func (s BatchUpdateDevicePositionError) String() string { +func (s CalculateRouteOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchUpdateDevicePositionError) GoString() string { +func (s CalculateRouteOutput) GoString() string { return s.String() } -// SetDeviceId sets the DeviceId field's value. -func (s *BatchUpdateDevicePositionError) SetDeviceId(v string) *BatchUpdateDevicePositionError { - s.DeviceId = &v - return s -} - -// SetError sets the Error field's value. -func (s *BatchUpdateDevicePositionError) SetError(v *BatchItemError) *BatchUpdateDevicePositionError { - s.Error = v +// SetLegs sets the Legs field's value. +func (s *CalculateRouteOutput) SetLegs(v []*Leg) *CalculateRouteOutput { + s.Legs = v return s } -// SetSampleTime sets the SampleTime field's value. -func (s *BatchUpdateDevicePositionError) SetSampleTime(v time.Time) *BatchUpdateDevicePositionError { - s.SampleTime = &v +// SetSummary sets the Summary field's value. +func (s *CalculateRouteOutput) SetSummary(v *CalculateRouteSummary) *CalculateRouteOutput { + s.Summary = v return s } -type BatchUpdateDevicePositionInput struct { +// A summary of the calculated route. +type CalculateRouteSummary struct { _ struct{} `type:"structure"` - // The name of the tracker resource to update. + // The data provider of traffic and road network data used to calculate the + // route. Indicates one of the available providers: // - // TrackerName is a required field - TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` + // * Esri + // + // * Here + // + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // + // DataSource is a required field + DataSource *string `type:"string" required:"true"` - // Contains the position update details for each device. + // The total distance covered by the route. The sum of the distance travelled + // between every stop on the route. // - // Updates is a required field - Updates []*DevicePositionUpdate `min:"1" type:"list" required:"true"` + // The route distance can't be greater than 250 km. If the route exceeds 250 + // km, the response returns a 400 RoutesValidationException error. + // + // Distance is a required field + Distance *float64 `type:"double" required:"true"` + + // The unit of measurement for the distance. + // + // DistanceUnit is a required field + DistanceUnit *string `type:"string" required:"true" enum:"DistanceUnit"` + + // The total travel time for the route measured in seconds. The sum of the travel + // time between every stop on the route. + // + // DurationSeconds is a required field + DurationSeconds *float64 `type:"double" required:"true"` + + // Specifies a geographical box surrounding a route. Used to zoom into a route + // when displaying it in a map. For example, [min x, min y, max x, max y] + // + // The first 2 bbox parameters describe the lower southwest corner: + // + // * The first bbox position is the X coordinate or longitude of the lower + // southwest corner. + // + // * The second bbox position is the Y coordinate or latitude of the lower + // southwest corner. + // + // The next 2 bbox parameters describe the upper northeast corner: + // + // * The third bbox position is the X coordinate, or longitude of the upper + // northeast corner. + // + // * The fourth bbox position is the Y coordinate, or longitude of the upper + // northeast corner. + // + // RouteBBox is a required field + RouteBBox []*float64 `min:"4" type:"list" required:"true" sensitive:"true"` } // String returns the string representation -func (s BatchUpdateDevicePositionInput) String() string { +func (s CalculateRouteSummary) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchUpdateDevicePositionInput) GoString() string { +func (s CalculateRouteSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *BatchUpdateDevicePositionInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchUpdateDevicePositionInput"} - if s.TrackerName == nil { - invalidParams.Add(request.NewErrParamRequired("TrackerName")) - } - if s.TrackerName != nil && len(*s.TrackerName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) - } - if s.Updates == nil { - invalidParams.Add(request.NewErrParamRequired("Updates")) - } - if s.Updates != nil && len(s.Updates) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Updates", 1)) - } - if s.Updates != nil { - for i, v := range s.Updates { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Updates", i), err.(request.ErrInvalidParams)) - } - } - } +// SetDataSource sets the DataSource field's value. +func (s *CalculateRouteSummary) SetDataSource(v string) *CalculateRouteSummary { + s.DataSource = &v + return s +} + +// SetDistance sets the Distance field's value. +func (s *CalculateRouteSummary) SetDistance(v float64) *CalculateRouteSummary { + s.Distance = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDistanceUnit sets the DistanceUnit field's value. +func (s *CalculateRouteSummary) SetDistanceUnit(v string) *CalculateRouteSummary { + s.DistanceUnit = &v + return s } -// SetTrackerName sets the TrackerName field's value. -func (s *BatchUpdateDevicePositionInput) SetTrackerName(v string) *BatchUpdateDevicePositionInput { - s.TrackerName = &v +// SetDurationSeconds sets the DurationSeconds field's value. +func (s *CalculateRouteSummary) SetDurationSeconds(v float64) *CalculateRouteSummary { + s.DurationSeconds = &v return s } -// SetUpdates sets the Updates field's value. -func (s *BatchUpdateDevicePositionInput) SetUpdates(v []*DevicePositionUpdate) *BatchUpdateDevicePositionInput { - s.Updates = v +// SetRouteBBox sets the RouteBBox field's value. +func (s *CalculateRouteSummary) SetRouteBBox(v []*float64) *CalculateRouteSummary { + s.RouteBBox = v return s } -type BatchUpdateDevicePositionOutput struct { +// Contains details about additional route preferences for requests that specify +// TravelMode as Truck. +type CalculateRouteTruckModeOptions struct { _ struct{} `type:"structure"` - // Contains error details for each device that failed to update its position. + // Avoids ferries when calculating routes. // - // Errors is a required field - Errors []*BatchUpdateDevicePositionError `type:"list" required:"true"` + // Default Value: false + // + // Valid Values: false | true + AvoidFerries *bool `type:"boolean"` + + // Avoids ferries when calculating routes. + // + // Default Value: false + // + // Valid Values: false | true + AvoidTolls *bool `type:"boolean"` + + // Specifies the truck's dimension specifications including length, height, + // width, and unit of measurement. Used to avoid roads that can't support the + // truck's dimensions. + Dimensions *TruckDimensions `type:"structure"` + + // Specifies the truck's weight specifications including total weight and unit + // of measurement. Used to avoid roads that can't support the truck's weight. + Weight *TruckWeight `type:"structure"` } // String returns the string representation -func (s BatchUpdateDevicePositionOutput) String() string { +func (s CalculateRouteTruckModeOptions) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchUpdateDevicePositionOutput) GoString() string { +func (s CalculateRouteTruckModeOptions) GoString() string { return s.String() } -// SetErrors sets the Errors field's value. -func (s *BatchUpdateDevicePositionOutput) SetErrors(v []*BatchUpdateDevicePositionError) *BatchUpdateDevicePositionOutput { - s.Errors = v +// SetAvoidFerries sets the AvoidFerries field's value. +func (s *CalculateRouteTruckModeOptions) SetAvoidFerries(v bool) *CalculateRouteTruckModeOptions { + s.AvoidFerries = &v + return s +} + +// SetAvoidTolls sets the AvoidTolls field's value. +func (s *CalculateRouteTruckModeOptions) SetAvoidTolls(v bool) *CalculateRouteTruckModeOptions { + s.AvoidTolls = &v + return s +} + +// SetDimensions sets the Dimensions field's value. +func (s *CalculateRouteTruckModeOptions) SetDimensions(v *TruckDimensions) *CalculateRouteTruckModeOptions { + s.Dimensions = v + return s +} + +// SetWeight sets the Weight field's value. +func (s *CalculateRouteTruckModeOptions) SetWeight(v *TruckWeight) *CalculateRouteTruckModeOptions { + s.Weight = v return s } @@ -4872,8 +6540,8 @@ type CreateGeofenceCollectionInput struct { // // Requirements: // - // * Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), - // periods (.), and underscores (_). + // * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens + // (-), periods (.), and underscores (_). // // * Must be a unique geofence collection name. // @@ -4885,7 +6553,11 @@ type CreateGeofenceCollectionInput struct { // An optional description for the geofence collection. Description *string `type:"string"` - // Specifies the pricing plan for your geofence collection. + // A key identifier for an AWS KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). + // Enter a key ID, key ARN, alias name, or alias ARN. + KmsKeyId *string `min:"1" type:"string"` + + // Specifies the pricing plan for the 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/). @@ -4893,16 +6565,41 @@ type CreateGeofenceCollectionInput struct { // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` - // Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) - // or the Mobile Asset Management (MAM) pricing plan is selected. + // Specifies the data provider for the geofence collection. + // + // * Required value for the following pricing plans: MobileAssetTracking + // | MobileAssetManagement // - // Billing is determined by the resource usage, the associated pricing plan, - // and the data source that was specified. For more information about each pricing - // plan option and restrictions, see the Amazon Location Service pricing page - // (https://aws.amazon.com/location/pricing/). + // 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. + // + // 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 PricingPlanDataSource *string `type:"string"` + + // Applies one or more tags to the geofence collection. A tag is a key-value + // pair helps manage, identify, search, and filter your resources by labelling + // them. + // + // Format: "key" : "value" + // + // Restrictions: + // + // * Maximum 50 tags per resource + // + // * Each resource tag must be unique with a maximum of one value. + // + // * Maximum key length: 128 Unicode characters in UTF-8 + // + // * Maximum value length: 256 Unicode characters in UTF-8 + // + // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + Tags map[string]*string `type:"map"` } // String returns the string representation @@ -4924,6 +6621,9 @@ func (s *CreateGeofenceCollectionInput) Validate() error { if s.CollectionName != nil && len(*s.CollectionName) < 1 { invalidParams.Add(request.NewErrParamMinLen("CollectionName", 1)) } + if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KmsKeyId", 1)) + } if s.PricingPlan == nil { invalidParams.Add(request.NewErrParamRequired("PricingPlan")) } @@ -4946,6 +6646,12 @@ func (s *CreateGeofenceCollectionInput) SetDescription(v string) *CreateGeofence return s } +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *CreateGeofenceCollectionInput) SetKmsKeyId(v string) *CreateGeofenceCollectionInput { + s.KmsKeyId = &v + return s +} + // SetPricingPlan sets the PricingPlan field's value. func (s *CreateGeofenceCollectionInput) SetPricingPlan(v string) *CreateGeofenceCollectionInput { s.PricingPlan = &v @@ -4958,12 +6664,20 @@ func (s *CreateGeofenceCollectionInput) SetPricingPlanDataSource(v string) *Crea return s } +// SetTags sets the Tags field's value. +func (s *CreateGeofenceCollectionInput) SetTags(v map[string]*string) *CreateGeofenceCollectionInput { + s.Tags = v + return s +} + type CreateGeofenceCollectionOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) for the geofence collection resource. Used // when you need to specify a resource across all AWS. // + // * Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection + // // CollectionArn is a required field CollectionArn *string `type:"string" required:"true"` @@ -5039,6 +6753,25 @@ type CreateMapInput struct { // // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + + // Applies one or more tags to the map resource. A tag is a key-value pair helps + // manage, identify, search, and filter your resources by labelling them. + // + // Format: "key" : "value" + // + // Restrictions: + // + // * Maximum 50 tags per resource + // + // * Each resource tag must be unique with a maximum of one value. + // + // * Maximum key length: 128 Unicode characters in UTF-8 + // + // * Maximum value length: 256 Unicode characters in UTF-8 + // + // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + Tags map[string]*string `type:"map"` } // String returns the string representation @@ -5102,6 +6835,12 @@ func (s *CreateMapInput) SetPricingPlan(v string) *CreateMapInput { return s } +// SetTags sets the Tags field's value. +func (s *CreateMapInput) SetTags(v map[string]*string) *CreateMapInput { + s.Tags = v + return s +} + type CreateMapOutput struct { _ struct{} `type:"structure"` @@ -5114,7 +6853,7 @@ type CreateMapOutput struct { // The Amazon Resource Name (ARN) for the map resource. Used when you need to // specify a resource across all AWS. // - // * Format example: arn:partition:service:region:account-id:resource-type:resource-id + // * Format example: arn:aws:geo:region:account-id:maps/ExampleMap // // MapArn is a required field MapArn *string `type:"string" required:"true"` @@ -5165,7 +6904,10 @@ type CreatePlaceIndexInput struct { // // * Esri // - // * Here + // * Here Place index resources using HERE as a data provider can't be used + // to store (https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) + // results for locations in Japan. For more information, see the AWS Service + // Terms (https://aws.amazon.com/service-terms/) for Amazon Location Service. // // For additional details on data providers, see the Amazon Location Service // data providers page (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). @@ -5176,53 +6918,256 @@ type CreatePlaceIndexInput struct { // Specifies the data storage option for requesting Places. DataSourceConfiguration *DataSourceConfiguration `type:"structure"` - // The optional description for the Place index resource. + // The optional description for the place index resource. Description *string `type:"string"` - // The name of the Place index resource. + // The name of the place index resource. // // Requirements: // - // * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), - // periods (.), and underscores (_). + // * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens + // (-), periods (.), and underscores (_). // - // * Must be a unique Place index resource name. + // * Must be a unique place index resource name. // // * No spaces allowed. For example, ExamplePlaceIndex. // // IndexName is a required field IndexName *string `min:"1" type:"string" required:"true"` - // Specifies the pricing plan for your Place index resource. + // Specifies the pricing plan for your place index resource. // // For additional details and restrictions on each pricing plan option, see // the Amazon Location Service pricing page (https://aws.amazon.com/location/pricing/). // // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + + // Applies one or more tags to the place index resource. A tag is a key-value + // pair helps manage, identify, search, and filter your resources by labelling + // them. + // + // Format: "key" : "value" + // + // Restrictions: + // + // * Maximum 50 tags per resource + // + // * Each resource tag must be unique with a maximum of one value. + // + // * Maximum key length: 128 Unicode characters in UTF-8 + // + // * Maximum value length: 256 Unicode characters in UTF-8 + // + // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + Tags map[string]*string `type:"map"` +} + +// String returns the string representation +func (s CreatePlaceIndexInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreatePlaceIndexInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatePlaceIndexInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatePlaceIndexInput"} + if s.DataSource == nil { + invalidParams.Add(request.NewErrParamRequired("DataSource")) + } + if s.IndexName == nil { + invalidParams.Add(request.NewErrParamRequired("IndexName")) + } + if s.IndexName != nil && len(*s.IndexName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IndexName", 1)) + } + if s.PricingPlan == nil { + invalidParams.Add(request.NewErrParamRequired("PricingPlan")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSource sets the DataSource field's value. +func (s *CreatePlaceIndexInput) SetDataSource(v string) *CreatePlaceIndexInput { + s.DataSource = &v + return s +} + +// SetDataSourceConfiguration sets the DataSourceConfiguration field's value. +func (s *CreatePlaceIndexInput) SetDataSourceConfiguration(v *DataSourceConfiguration) *CreatePlaceIndexInput { + s.DataSourceConfiguration = v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreatePlaceIndexInput) SetDescription(v string) *CreatePlaceIndexInput { + s.Description = &v + return s +} + +// SetIndexName sets the IndexName field's value. +func (s *CreatePlaceIndexInput) SetIndexName(v string) *CreatePlaceIndexInput { + s.IndexName = &v + return s +} + +// SetPricingPlan sets the PricingPlan field's value. +func (s *CreatePlaceIndexInput) SetPricingPlan(v string) *CreatePlaceIndexInput { + s.PricingPlan = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreatePlaceIndexInput) SetTags(v map[string]*string) *CreatePlaceIndexInput { + s.Tags = v + return s +} + +type CreatePlaceIndexOutput struct { + _ struct{} `type:"structure"` + + // The timestamp for when the place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ. + // + // CreateTime is a required field + CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The Amazon Resource Name (ARN) for the place index resource. Used to specify + // a resource across all AWS. + // + // * Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex + // + // IndexArn is a required field + IndexArn *string `type:"string" required:"true"` + + // The name for the place index resource. + // + // IndexName is a required field + IndexName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CreatePlaceIndexOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreatePlaceIndexOutput) GoString() string { + return s.String() +} + +// SetCreateTime sets the CreateTime field's value. +func (s *CreatePlaceIndexOutput) SetCreateTime(v time.Time) *CreatePlaceIndexOutput { + s.CreateTime = &v + return s +} + +// SetIndexArn sets the IndexArn field's value. +func (s *CreatePlaceIndexOutput) SetIndexArn(v string) *CreatePlaceIndexOutput { + s.IndexArn = &v + return s +} + +// SetIndexName sets the IndexName field's value. +func (s *CreatePlaceIndexOutput) SetIndexName(v string) *CreatePlaceIndexOutput { + s.IndexName = &v + return s +} + +type CreateRouteCalculatorInput struct { + _ struct{} `type:"structure"` + + // The name of the route calculator resource. + // + // Requirements: + // + // * Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), + // periods (.), and underscores (_). + // + // * Must be a unique Route calculator resource name. + // + // * No spaces allowed. For example, ExampleRouteCalculator. + // + // CalculatorName is a required field + CalculatorName *string `min:"1" type:"string" required:"true"` + + // 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. + // + // Valid Values: Esri | Here + // + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // + // DataSource is a required field + DataSource *string `type:"string" required:"true"` + + // The optional description for the route calculator resource. + Description *string `type:"string"` + + // Specifies the pricing plan for your route calculator resource. + // + // 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"` + + // Applies one or more tags to the route calculator resource. A tag is a key-value + // pair helps manage, identify, search, and filter your resources by labelling + // them. + // + // * For example: { "tag1" : "value1", "tag2" : "value2"} + // + // Format: "key" : "value" + // + // Restrictions: + // + // * Maximum 50 tags per resource + // + // * Each resource tag must be unique with a maximum of one value. + // + // * Maximum key length: 128 Unicode characters in UTF-8 + // + // * Maximum value length: 256 Unicode characters in UTF-8 + // + // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + Tags map[string]*string `type:"map"` } // String returns the string representation -func (s CreatePlaceIndexInput) String() string { +func (s CreateRouteCalculatorInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreatePlaceIndexInput) GoString() string { +func (s CreateRouteCalculatorInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreatePlaceIndexInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreatePlaceIndexInput"} - if s.DataSource == nil { - invalidParams.Add(request.NewErrParamRequired("DataSource")) +func (s *CreateRouteCalculatorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRouteCalculatorInput"} + if s.CalculatorName == nil { + invalidParams.Add(request.NewErrParamRequired("CalculatorName")) } - if s.IndexName == nil { - invalidParams.Add(request.NewErrParamRequired("IndexName")) + if s.CalculatorName != nil && len(*s.CalculatorName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CalculatorName", 1)) } - if s.IndexName != nil && len(*s.IndexName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IndexName", 1)) + if s.DataSource == nil { + invalidParams.Add(request.NewErrParamRequired("DataSource")) } if s.PricingPlan == nil { invalidParams.Add(request.NewErrParamRequired("PricingPlan")) @@ -5234,82 +7179,88 @@ func (s *CreatePlaceIndexInput) Validate() error { return nil } -// SetDataSource sets the DataSource field's value. -func (s *CreatePlaceIndexInput) SetDataSource(v string) *CreatePlaceIndexInput { - s.DataSource = &v +// SetCalculatorName sets the CalculatorName field's value. +func (s *CreateRouteCalculatorInput) SetCalculatorName(v string) *CreateRouteCalculatorInput { + s.CalculatorName = &v return s } -// SetDataSourceConfiguration sets the DataSourceConfiguration field's value. -func (s *CreatePlaceIndexInput) SetDataSourceConfiguration(v *DataSourceConfiguration) *CreatePlaceIndexInput { - s.DataSourceConfiguration = v +// SetDataSource sets the DataSource field's value. +func (s *CreateRouteCalculatorInput) SetDataSource(v string) *CreateRouteCalculatorInput { + s.DataSource = &v return s } // SetDescription sets the Description field's value. -func (s *CreatePlaceIndexInput) SetDescription(v string) *CreatePlaceIndexInput { +func (s *CreateRouteCalculatorInput) SetDescription(v string) *CreateRouteCalculatorInput { s.Description = &v return s } -// SetIndexName sets the IndexName field's value. -func (s *CreatePlaceIndexInput) SetIndexName(v string) *CreatePlaceIndexInput { - s.IndexName = &v +// SetPricingPlan sets the PricingPlan field's value. +func (s *CreateRouteCalculatorInput) SetPricingPlan(v string) *CreateRouteCalculatorInput { + s.PricingPlan = &v return s } -// SetPricingPlan sets the PricingPlan field's value. -func (s *CreatePlaceIndexInput) SetPricingPlan(v string) *CreatePlaceIndexInput { - s.PricingPlan = &v +// SetTags sets the Tags field's value. +func (s *CreateRouteCalculatorInput) SetTags(v map[string]*string) *CreateRouteCalculatorInput { + s.Tags = v return s } -type CreatePlaceIndexOutput struct { +type CreateRouteCalculatorOutput struct { _ struct{} `type:"structure"` - // The timestamp for when the Place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) - // format: YYYY-MM-DDThh:mm:ss.sssZ. + // The Amazon Resource Name (ARN) for the route calculator resource. Use the + // ARN when you specify a resource across all AWS. // - // CreateTime is a required field - CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + // * Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator + // + // CalculatorArn is a required field + CalculatorArn *string `type:"string" required:"true"` - // The Amazon Resource Name (ARN) for the Place index resource. Used when you - // need to specify a resource across all AWS. + // The name of the route calculator resource. // - // IndexArn is a required field - IndexArn *string `type:"string" required:"true"` + // * For example, ExampleRouteCalculator. + // + // CalculatorName is a required field + CalculatorName *string `min:"1" type:"string" required:"true"` - // The name for the Place index resource. + // The timestamp when the route calculator resource was created in ISO 8601 + // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. // - // IndexName is a required field - IndexName *string `min:"1" type:"string" required:"true"` + // * For example, 2020–07-2T12:15:20.000Z+01:00 + // + // CreateTime is a required field + CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` } // String returns the string representation -func (s CreatePlaceIndexOutput) String() string { +func (s CreateRouteCalculatorOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreatePlaceIndexOutput) GoString() string { +func (s CreateRouteCalculatorOutput) GoString() string { return s.String() } -// SetCreateTime sets the CreateTime field's value. -func (s *CreatePlaceIndexOutput) SetCreateTime(v time.Time) *CreatePlaceIndexOutput { - s.CreateTime = &v +// SetCalculatorArn sets the CalculatorArn field's value. +func (s *CreateRouteCalculatorOutput) SetCalculatorArn(v string) *CreateRouteCalculatorOutput { + s.CalculatorArn = &v return s } -// SetIndexArn sets the IndexArn field's value. -func (s *CreatePlaceIndexOutput) SetIndexArn(v string) *CreatePlaceIndexOutput { - s.IndexArn = &v +// SetCalculatorName sets the CalculatorName field's value. +func (s *CreateRouteCalculatorOutput) SetCalculatorName(v string) *CreateRouteCalculatorOutput { + s.CalculatorName = &v return s } -// SetIndexName sets the IndexName field's value. -func (s *CreatePlaceIndexOutput) SetIndexName(v string) *CreatePlaceIndexOutput { - s.IndexName = &v +// SetCreateTime sets the CreateTime field's value. +func (s *CreateRouteCalculatorOutput) SetCreateTime(v time.Time) *CreateRouteCalculatorOutput { + s.CreateTime = &v return s } @@ -5319,7 +7270,11 @@ type CreateTrackerInput struct { // An optional description for the tracker resource. Description *string `type:"string"` - // Specifies the pricing plan for your tracker resource. + // A key identifier for an AWS KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). + // Enter a key ID, key ARN, alias name, or alias ARN. + KmsKeyId *string `min:"1" type:"string"` + + // Specifies the pricing plan for the tracker resource. // // For additional details and restrictions on each pricing plan option, see // the Amazon Location Service pricing page (https://aws.amazon.com/location/pricing/). @@ -5327,17 +7282,41 @@ type CreateTrackerInput struct { // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` - // Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) - // or the Mobile Asset Management (MAM) pricing plan is selected. + // Specifies the data provider for the tracker resource. + // + // * Required value for the following pricing plans: MobileAssetTracking + // | MobileAssetManagement // - // Billing is determined by the resource usage, the associated pricing plan, - // and data source that was specified. For more information about each pricing - // plan option and restrictions, see the Amazon Location Service pricing page - // (https://aws.amazon.com/location/pricing/). + // 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. + // + // 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 PricingPlanDataSource *string `type:"string"` + // Applies one or more tags to the tracker resource. A tag is a key-value pair + // helps manage, identify, search, and filter your resources by labelling them. + // + // Format: "key" : "value" + // + // Restrictions: + // + // * Maximum 50 tags per resource + // + // * Each resource tag must be unique with a maximum of one value. + // + // * Maximum key length: 128 Unicode characters in UTF-8 + // + // * Maximum value length: 256 Unicode characters in UTF-8 + // + // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + Tags map[string]*string `type:"map"` + // The name for the tracker resource. // // Requirements: @@ -5366,6 +7345,9 @@ func (s CreateTrackerInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateTrackerInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateTrackerInput"} + if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KmsKeyId", 1)) + } if s.PricingPlan == nil { invalidParams.Add(request.NewErrParamRequired("PricingPlan")) } @@ -5388,6 +7370,12 @@ func (s *CreateTrackerInput) SetDescription(v string) *CreateTrackerInput { return s } +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *CreateTrackerInput) SetKmsKeyId(v string) *CreateTrackerInput { + s.KmsKeyId = &v + return s +} + // SetPricingPlan sets the PricingPlan field's value. func (s *CreateTrackerInput) SetPricingPlan(v string) *CreateTrackerInput { s.PricingPlan = &v @@ -5400,6 +7388,12 @@ func (s *CreateTrackerInput) SetPricingPlanDataSource(v string) *CreateTrackerIn return s } +// SetTags sets the Tags field's value. +func (s *CreateTrackerInput) SetTags(v map[string]*string) *CreateTrackerInput { + s.Tags = v + return s +} + // SetTrackerName sets the TrackerName field's value. func (s *CreateTrackerInput) SetTrackerName(v string) *CreateTrackerInput { s.TrackerName = &v @@ -5418,6 +7412,8 @@ type CreateTrackerOutput struct { // The Amazon Resource Name (ARN) for the tracker resource. Used when you need // to specify a resource across all AWS. // + // * Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker + // // TrackerArn is a required field TrackerArn *string `type:"string" required:"true"` @@ -5456,16 +7452,6 @@ func (s *CreateTrackerOutput) SetTrackerName(v string) *CreateTrackerOutput { } // Specifies the data storage option chosen for requesting Places. -// -// By using Places, you agree that AWS may transmit your API queries to your -// selected third party provider for processing, which may be outside the AWS -// region you are currently using. -// -// Also, when using HERE as your data provider, you may not (a) use HERE Places -// for Asset Management, or (b) select the Storage option for the IntendedUse -// parameter when requesting Places in Japan. For more information, see the -// AWS Service Terms (https://aws.amazon.com/service-terms/) for Amazon Location -// Service. type DataSourceConfiguration struct { _ struct{} `type:"structure"` @@ -5476,6 +7462,9 @@ type DataSourceConfiguration struct { // * SingleUse specifies that the results won't be stored. // // * Storage specifies that the result can be cached or stored in a database. + // Place index resources using HERE as a data provider can't be configured + // to store results for locations in Japan when choosing Storage for the + // IntendedUse parameter. // // Default value: SingleUse IntendedUse *string `type:"string" enum:"IntendedUse"` @@ -5610,7 +7599,7 @@ func (s DeleteMapOutput) GoString() string { type DeletePlaceIndexInput struct { _ struct{} `type:"structure"` - // The name of the Place index resource to be deleted. + // The name of the place index resource to be deleted. // // IndexName is a required field IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"` @@ -5662,6 +7651,61 @@ func (s DeletePlaceIndexOutput) GoString() string { return s.String() } +type DeleteRouteCalculatorInput struct { + _ struct{} `type:"structure"` + + // The name of the route calculator resource to be deleted. + // + // CalculatorName is a required field + CalculatorName *string `location:"uri" locationName:"CalculatorName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteRouteCalculatorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteRouteCalculatorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteRouteCalculatorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteRouteCalculatorInput"} + if s.CalculatorName == nil { + invalidParams.Add(request.NewErrParamRequired("CalculatorName")) + } + if s.CalculatorName != nil && len(*s.CalculatorName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CalculatorName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCalculatorName sets the CalculatorName field's value. +func (s *DeleteRouteCalculatorInput) SetCalculatorName(v string) *DeleteRouteCalculatorInput { + s.CalculatorName = &v + return s +} + +type DeleteRouteCalculatorOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeleteRouteCalculatorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteRouteCalculatorOutput) GoString() string { + return s.String() +} + type DeleteTrackerInput struct { _ struct{} `type:"structure"` @@ -5764,6 +7808,8 @@ type DescribeGeofenceCollectionOutput struct { // The Amazon Resource Name (ARN) for the geofence collection resource. Used // when you need to specify a resource across all AWS. // + // * Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection + // // CollectionArn is a required field CollectionArn *string `type:"string" required:"true"` @@ -5783,6 +7829,10 @@ type DescribeGeofenceCollectionOutput struct { // Description is a required field Description *string `type:"string" required:"true"` + // A key identifier for an AWS KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) + // assigned to the Amazon Location resource + KmsKeyId *string `min:"1" type:"string"` + // The pricing plan selected for the specified geofence collection. // // For additional details and restrictions on each pricing plan option, see @@ -5791,10 +7841,12 @@ type DescribeGeofenceCollectionOutput struct { // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` - // The data source selected for the geofence collection and associated pricing - // plan. + // The specified data provider for the geofence collection. PricingPlanDataSource *string `type:"string"` + // Displays the key, value pairs of tags associated with this resource. + Tags map[string]*string `type:"map"` + // The timestamp for when the geofence collection was last updated in ISO 8601 // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ // @@ -5836,6 +7888,12 @@ func (s *DescribeGeofenceCollectionOutput) SetDescription(v string) *DescribeGeo return s } +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *DescribeGeofenceCollectionOutput) SetKmsKeyId(v string) *DescribeGeofenceCollectionOutput { + s.KmsKeyId = &v + return s +} + // SetPricingPlan sets the PricingPlan field's value. func (s *DescribeGeofenceCollectionOutput) SetPricingPlan(v string) *DescribeGeofenceCollectionOutput { s.PricingPlan = &v @@ -5848,6 +7906,12 @@ func (s *DescribeGeofenceCollectionOutput) SetPricingPlanDataSource(v string) *D return s } +// SetTags sets the Tags field's value. +func (s *DescribeGeofenceCollectionOutput) SetTags(v map[string]*string) *DescribeGeofenceCollectionOutput { + s.Tags = v + return s +} + // SetUpdateTime sets the UpdateTime field's value. func (s *DescribeGeofenceCollectionOutput) SetUpdateTime(v time.Time) *DescribeGeofenceCollectionOutput { s.UpdateTime = &v @@ -5922,6 +7986,8 @@ type DescribeMapOutput struct { // The Amazon Resource Name (ARN) for the map resource. Used when you need to // specify a resource across all AWS. // + // * Format example: arn:aws:geo:region:account-id:maps/ExampleMap + // // MapArn is a required field MapArn *string `type:"string" required:"true"` @@ -5939,6 +8005,9 @@ type DescribeMapOutput struct { // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // Tags associated with the map resource. + Tags map[string]*string `type:"map"` + // The timestamp for when the map resource was last update in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) // format: YYYY-MM-DDThh:mm:ss.sssZ. // @@ -5998,6 +8067,12 @@ func (s *DescribeMapOutput) SetPricingPlan(v string) *DescribeMapOutput { return s } +// SetTags sets the Tags field's value. +func (s *DescribeMapOutput) SetTags(v map[string]*string) *DescribeMapOutput { + s.Tags = v + return s +} + // SetUpdateTime sets the UpdateTime field's value. func (s *DescribeMapOutput) SetUpdateTime(v time.Time) *DescribeMapOutput { s.UpdateTime = &v @@ -6007,7 +8082,7 @@ func (s *DescribeMapOutput) SetUpdateTime(v time.Time) *DescribeMapOutput { type DescribePlaceIndexInput struct { _ struct{} `type:"structure"` - // The name of the Place index resource. + // The name of the place index resource. // // IndexName is a required field IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"` @@ -6048,7 +8123,7 @@ func (s *DescribePlaceIndexInput) SetIndexName(v string) *DescribePlaceIndexInpu type DescribePlaceIndexOutput struct { _ struct{} `type:"structure"` - // The timestamp for when the Place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // The timestamp for when the place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) // format: YYYY-MM-DDThh:mm:ss.sssZ. // // CreateTime is a required field @@ -6071,23 +8146,25 @@ type DescribePlaceIndexOutput struct { // DataSourceConfiguration is a required field DataSourceConfiguration *DataSourceConfiguration `type:"structure" required:"true"` - // The optional description for the Place index resource. + // The optional description for the place index resource. // // Description is a required field Description *string `type:"string" required:"true"` - // The Amazon Resource Name (ARN) for the Place index resource. Used when you - // need to specify a resource across all AWS. + // The Amazon Resource Name (ARN) for the place index resource. Used to specify + // a resource across all AWS. + // + // * Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex // // IndexArn is a required field IndexArn *string `type:"string" required:"true"` - // The name of the Place index resource being described. + // The name of the place index resource being described. // // IndexName is a required field IndexName *string `min:"1" type:"string" required:"true"` - // The pricing plan selected for the specified Place index resource. + // The pricing plan selected for the specified place index resource. // // For additional details and restrictions on each pricing plan option, see // the Amazon Location Service pricing page (https://aws.amazon.com/location/pricing/). @@ -6095,67 +8172,237 @@ type DescribePlaceIndexOutput struct { // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" 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. + // Tags associated with place index resource. + Tags map[string]*string `type:"map"` + + // 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. + // + // UpdateTime is a required field + UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` +} + +// String returns the string representation +func (s DescribePlaceIndexOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribePlaceIndexOutput) GoString() string { + return s.String() +} + +// SetCreateTime sets the CreateTime field's value. +func (s *DescribePlaceIndexOutput) SetCreateTime(v time.Time) *DescribePlaceIndexOutput { + s.CreateTime = &v + return s +} + +// SetDataSource sets the DataSource field's value. +func (s *DescribePlaceIndexOutput) SetDataSource(v string) *DescribePlaceIndexOutput { + s.DataSource = &v + return s +} + +// SetDataSourceConfiguration sets the DataSourceConfiguration field's value. +func (s *DescribePlaceIndexOutput) SetDataSourceConfiguration(v *DataSourceConfiguration) *DescribePlaceIndexOutput { + s.DataSourceConfiguration = v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribePlaceIndexOutput) SetDescription(v string) *DescribePlaceIndexOutput { + s.Description = &v + return s +} + +// SetIndexArn sets the IndexArn field's value. +func (s *DescribePlaceIndexOutput) SetIndexArn(v string) *DescribePlaceIndexOutput { + s.IndexArn = &v + return s +} + +// SetIndexName sets the IndexName field's value. +func (s *DescribePlaceIndexOutput) SetIndexName(v string) *DescribePlaceIndexOutput { + s.IndexName = &v + return s +} + +// SetPricingPlan sets the PricingPlan field's value. +func (s *DescribePlaceIndexOutput) SetPricingPlan(v string) *DescribePlaceIndexOutput { + s.PricingPlan = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribePlaceIndexOutput) SetTags(v map[string]*string) *DescribePlaceIndexOutput { + s.Tags = v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *DescribePlaceIndexOutput) SetUpdateTime(v time.Time) *DescribePlaceIndexOutput { + s.UpdateTime = &v + return s +} + +type DescribeRouteCalculatorInput struct { + _ struct{} `type:"structure"` + + // The name of the route calculator resource. + // + // CalculatorName is a required field + CalculatorName *string `location:"uri" locationName:"CalculatorName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeRouteCalculatorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeRouteCalculatorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeRouteCalculatorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeRouteCalculatorInput"} + if s.CalculatorName == nil { + invalidParams.Add(request.NewErrParamRequired("CalculatorName")) + } + if s.CalculatorName != nil && len(*s.CalculatorName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CalculatorName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCalculatorName sets the CalculatorName field's value. +func (s *DescribeRouteCalculatorInput) SetCalculatorName(v string) *DescribeRouteCalculatorInput { + s.CalculatorName = &v + return s +} + +type DescribeRouteCalculatorOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the Route calculator resource. Use the + // ARN when you specify a resource across AWS. + // + // * Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator + // + // CalculatorArn is a required field + CalculatorArn *string `type:"string" required:"true"` + + // The name of the route calculator resource being described. + // + // CalculatorName is a required field + CalculatorName *string `min:"1" type:"string" required:"true"` + + // The timestamp when the route calculator resource was created in ISO 8601 + // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. + // + // * For example, 2020–07-2T12:15:20.000Z+01:00 + // + // CreateTime is a required field + CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // 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 (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // + // DataSource is a required field + DataSource *string `type:"string" required:"true"` + + // The optional description of the route calculator resource. + // + // 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/). + // + // PricingPlan is a required field + PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + + // Tags associated with route calculator resource. + Tags map[string]*string `type:"map"` + + // 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. + // + // * For example, 2020–07-2T12:15:20.000Z+01:00 // // UpdateTime is a required field UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` } // String returns the string representation -func (s DescribePlaceIndexOutput) String() string { +func (s DescribeRouteCalculatorOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribePlaceIndexOutput) GoString() string { +func (s DescribeRouteCalculatorOutput) GoString() string { return s.String() } -// SetCreateTime sets the CreateTime field's value. -func (s *DescribePlaceIndexOutput) SetCreateTime(v time.Time) *DescribePlaceIndexOutput { - s.CreateTime = &v +// SetCalculatorArn sets the CalculatorArn field's value. +func (s *DescribeRouteCalculatorOutput) SetCalculatorArn(v string) *DescribeRouteCalculatorOutput { + s.CalculatorArn = &v return s } -// SetDataSource sets the DataSource field's value. -func (s *DescribePlaceIndexOutput) SetDataSource(v string) *DescribePlaceIndexOutput { - s.DataSource = &v +// SetCalculatorName sets the CalculatorName field's value. +func (s *DescribeRouteCalculatorOutput) SetCalculatorName(v string) *DescribeRouteCalculatorOutput { + s.CalculatorName = &v return s } -// SetDataSourceConfiguration sets the DataSourceConfiguration field's value. -func (s *DescribePlaceIndexOutput) SetDataSourceConfiguration(v *DataSourceConfiguration) *DescribePlaceIndexOutput { - s.DataSourceConfiguration = v +// SetCreateTime sets the CreateTime field's value. +func (s *DescribeRouteCalculatorOutput) SetCreateTime(v time.Time) *DescribeRouteCalculatorOutput { + s.CreateTime = &v return s } -// SetDescription sets the Description field's value. -func (s *DescribePlaceIndexOutput) SetDescription(v string) *DescribePlaceIndexOutput { - s.Description = &v +// SetDataSource sets the DataSource field's value. +func (s *DescribeRouteCalculatorOutput) SetDataSource(v string) *DescribeRouteCalculatorOutput { + s.DataSource = &v return s } -// SetIndexArn sets the IndexArn field's value. -func (s *DescribePlaceIndexOutput) SetIndexArn(v string) *DescribePlaceIndexOutput { - s.IndexArn = &v +// SetDescription sets the Description field's value. +func (s *DescribeRouteCalculatorOutput) SetDescription(v string) *DescribeRouteCalculatorOutput { + s.Description = &v return s } -// SetIndexName sets the IndexName field's value. -func (s *DescribePlaceIndexOutput) SetIndexName(v string) *DescribePlaceIndexOutput { - s.IndexName = &v +// SetPricingPlan sets the PricingPlan field's value. +func (s *DescribeRouteCalculatorOutput) SetPricingPlan(v string) *DescribeRouteCalculatorOutput { + s.PricingPlan = &v return s } -// SetPricingPlan sets the PricingPlan field's value. -func (s *DescribePlaceIndexOutput) SetPricingPlan(v string) *DescribePlaceIndexOutput { - s.PricingPlan = &v +// SetTags sets the Tags field's value. +func (s *DescribeRouteCalculatorOutput) SetTags(v map[string]*string) *DescribeRouteCalculatorOutput { + s.Tags = v return s } // SetUpdateTime sets the UpdateTime field's value. -func (s *DescribePlaceIndexOutput) SetUpdateTime(v time.Time) *DescribePlaceIndexOutput { +func (s *DescribeRouteCalculatorOutput) SetUpdateTime(v time.Time) *DescribeRouteCalculatorOutput { s.UpdateTime = &v return s } @@ -6215,6 +8462,10 @@ type DescribeTrackerOutput struct { // Description is a required field Description *string `type:"string" required:"true"` + // A key identifier for an AWS KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) + // assigned to the Amazon Location resource. + KmsKeyId *string `min:"1" type:"string"` + // The pricing plan selected for the specified tracker resource. // // For additional details and restrictions on each pricing plan option, see @@ -6223,13 +8474,17 @@ type DescribeTrackerOutput struct { // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` - // The data source selected for the tracker resource and associated pricing - // plan. + // The specified data provider for the tracker resource. PricingPlanDataSource *string `type:"string"` + // The tags associated with the tracker resource. + Tags map[string]*string `type:"map"` + // The Amazon Resource Name (ARN) for the tracker resource. Used when you need // to specify a resource across all AWS. // + // * Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker + // // TrackerArn is a required field TrackerArn *string `type:"string" required:"true"` @@ -6267,6 +8522,12 @@ func (s *DescribeTrackerOutput) SetDescription(v string) *DescribeTrackerOutput return s } +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *DescribeTrackerOutput) SetKmsKeyId(v string) *DescribeTrackerOutput { + s.KmsKeyId = &v + return s +} + // SetPricingPlan sets the PricingPlan field's value. func (s *DescribeTrackerOutput) SetPricingPlan(v string) *DescribeTrackerOutput { s.PricingPlan = &v @@ -6279,6 +8540,12 @@ func (s *DescribeTrackerOutput) SetPricingPlanDataSource(v string) *DescribeTrac return s } +// SetTags sets the Tags field's value. +func (s *DescribeTrackerOutput) SetTags(v map[string]*string) *DescribeTrackerOutput { + s.Tags = v + return s +} + // SetTrackerArn sets the TrackerArn field's value. func (s *DescribeTrackerOutput) SetTrackerArn(v string) *DescribeTrackerOutput { s.TrackerArn = &v @@ -6439,7 +8706,7 @@ type DisassociateTrackerConsumerInput struct { // from the tracker resource. Used when you need to specify a resource across // all AWS. // - // * Format example: arn:partition:service:region:account-id:resource-type:resource-id + // * Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer // // ConsumerArn is a required field ConsumerArn *string `location:"uri" locationName:"ConsumerArn" type:"string" required:"true"` @@ -6510,7 +8777,7 @@ func (s DisassociateTrackerConsumerOutput) GoString() string { // Contains the geofence geometry details. // -// Amazon Location does not currently support polygons with holes, multipolygons, +// Amazon Location doesn't currently support polygons with holes, multipolygons, // polygons that are wound clockwise, or that cross the antimeridian. type GeofenceGeometry struct { _ struct{} `type:"structure"` @@ -6962,8 +9229,8 @@ type GetMapGlyphsInput struct { FontStack *string `location:"uri" locationName:"FontStack" type:"string" required:"true"` // A Unicode range of characters to download glyphs for. Each response will - // contain 256 characters. For example, 0-255 includes all characters from range - // U+0000 to 00FF. Must be aligned to multiples of 256. + // contain 256 characters. For example, 0–255 includes all characters from + // range U+0000 to 00FF. Must be aligned to multiples of 256. // // FontUnicodeRange is a required field FontUnicodeRange *string `location:"uri" locationName:"FontUnicodeRange" type:"string" required:"true"` @@ -7367,55 +9634,353 @@ type InternalServerException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - Message_ *string `locationName:"message" type:"string"` + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s InternalServerException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s InternalServerException) GoString() string { + return s.String() +} + +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" +} + +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil +} + +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Contains the calculated route's details for each path between a pair of positions. +// The number of legs returned corresponds to one less 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 (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-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. +type Leg struct { + _ struct{} `type:"structure"` + + // The distance between the leg's StartPosition and EndPosition along a calculated + // route. + // + // * The default measurement is Kilometers unless the request specifies a + // DistanceUnit of Miles. + // + // Distance is a required field + Distance *float64 `type:"double" required:"true"` + + // The estimated travel time between the leg's StartPosition and EndPosition. + // The travel mode and departure time that you specify in the request determines + // the calculated time. + // + // DurationSeconds is a required field + DurationSeconds *float64 `type:"double" required:"true"` + + // 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). + // + // EndPosition is a required field + EndPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` + + // Contains the calculated route's path as a linestring geometry. + Geometry *LegGeometry `type:"structure"` + + // 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). + // + // StartPosition is a required field + StartPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` + + // Contains a list of steps, which represent subsections of a leg. Each step + // provides instructions for how to move to the next step in the leg such as + // the step's start position, end position, travel distance, travel duration, + // and geometry offset. + // + // Steps is a required field + Steps []*Step `type:"list" required:"true"` +} + +// String returns the string representation +func (s Leg) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Leg) GoString() string { + return s.String() +} + +// SetDistance sets the Distance field's value. +func (s *Leg) SetDistance(v float64) *Leg { + s.Distance = &v + return s +} + +// SetDurationSeconds sets the DurationSeconds field's value. +func (s *Leg) SetDurationSeconds(v float64) *Leg { + s.DurationSeconds = &v + return s +} + +// SetEndPosition sets the EndPosition field's value. +func (s *Leg) SetEndPosition(v []*float64) *Leg { + s.EndPosition = v + return s +} + +// SetGeometry sets the Geometry field's value. +func (s *Leg) SetGeometry(v *LegGeometry) *Leg { + s.Geometry = v + return s +} + +// SetStartPosition sets the StartPosition field's value. +func (s *Leg) SetStartPosition(v []*float64) *Leg { + s.StartPosition = v + return s +} + +// SetSteps sets the Steps field's value. +func (s *Leg) SetSteps(v []*Step) *Leg { + s.Steps = v + return s +} + +// Contains the geometry details for each path between a pair of positions. +// Used in plotting a route leg on a map. +type LegGeometry struct { + _ struct{} `type:"structure"` + + // An ordered list of positions used to plot a route on a map. + // + // The first position is closest to the start position for the leg, and the + // last position is the closest to the end position for the leg. + // + // * For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]] + LineString [][]*float64 `min:"2" type:"list"` +} + +// String returns the string representation +func (s LegGeometry) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s LegGeometry) GoString() string { + return s.String() +} + +// SetLineString sets the LineString field's value. +func (s *LegGeometry) SetLineString(v [][]*float64) *LegGeometry { + s.LineString = v + return s +} + +type ListDevicePositionsInput struct { + _ struct{} `type:"structure"` + + // An optional limit for the number of entries returned in a single call. + // + // Default value: 100 + MaxResults *int64 `min:"1" type:"integer"` + + // The pagination token specifying which page of results to return in the response. + // If no token is provided, the default page is the first page. + // + // Default value: null + NextToken *string `min:"1" type:"string"` + + // The tracker resource containing the requested devices. + // + // TrackerName is a required field + TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListDevicePositionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListDevicePositionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDevicePositionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDevicePositionsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.TrackerName == nil { + invalidParams.Add(request.NewErrParamRequired("TrackerName")) + } + if s.TrackerName != nil && len(*s.TrackerName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDevicePositionsInput) SetMaxResults(v int64) *ListDevicePositionsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDevicePositionsInput) SetNextToken(v string) *ListDevicePositionsInput { + s.NextToken = &v + return s +} + +// SetTrackerName sets the TrackerName field's value. +func (s *ListDevicePositionsInput) SetTrackerName(v string) *ListDevicePositionsInput { + s.TrackerName = &v + return s +} + +type ListDevicePositionsOutput struct { + _ struct{} `type:"structure"` + + // Contains details about each device's last known position. These details includes + // the device ID, the time when the position was sampled on the device, the + // time that the service received the update, and the most recent coordinates. + // + // Entries is a required field + Entries []*ListDevicePositionsResponseEntry `type:"list" required:"true"` + + // A pagination token indicating there are additional pages available. You can + // use the token in a following request to fetch the next set of results. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s ListDevicePositionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListDevicePositionsOutput) GoString() string { + return s.String() +} + +// SetEntries sets the Entries field's value. +func (s *ListDevicePositionsOutput) SetEntries(v []*ListDevicePositionsResponseEntry) *ListDevicePositionsOutput { + s.Entries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDevicePositionsOutput) SetNextToken(v string) *ListDevicePositionsOutput { + s.NextToken = &v + return s +} + +// Contains the tracker resource details. +type ListDevicePositionsResponseEntry struct { + _ struct{} `type:"structure"` + + // The ID of the device for this position. + // + // DeviceId is a required field + DeviceId *string `min:"1" type:"string" required:"true"` + + // The last known device position. Empty if no positions currently stored. + // + // Position is a required field + Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` + + // The timestamp at which the device position was determined. Uses ISO 8601 + // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. + // + // SampleTime is a required field + SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` } // String returns the string representation -func (s InternalServerException) String() string { +func (s ListDevicePositionsResponseEntry) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s InternalServerException) GoString() string { +func (s ListDevicePositionsResponseEntry) GoString() string { return s.String() } -func newErrorInternalServerException(v protocol.ResponseMetadata) error { - return &InternalServerException{ - RespMetadata: v, - } -} - -// Code returns the exception type name. -func (s *InternalServerException) Code() string { - return "InternalServerException" -} - -// Message returns the exception's message. -func (s *InternalServerException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" -} - -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InternalServerException) OrigErr() error { - return nil -} - -func (s *InternalServerException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetDeviceId sets the DeviceId field's value. +func (s *ListDevicePositionsResponseEntry) SetDeviceId(v string) *ListDevicePositionsResponseEntry { + s.DeviceId = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *InternalServerException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetPosition sets the Position field's value. +func (s *ListDevicePositionsResponseEntry) SetPosition(v []*float64) *ListDevicePositionsResponseEntry { + s.Position = v + return s } -// RequestID returns the service's response RequestID for request. -func (s *InternalServerException) RequestID() string { - return s.RespMetadata.RequestID +// SetSampleTime sets the SampleTime field's value. +func (s *ListDevicePositionsResponseEntry) SetSampleTime(v time.Time) *ListDevicePositionsResponseEntry { + s.SampleTime = &v + return s } type ListGeofenceCollectionsInput struct { @@ -7534,8 +10099,7 @@ type ListGeofenceCollectionsResponseEntry struct { // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` - // The data source selected for the geofence collection and associated pricing - // plan. + // The specified data provider for the geofence collection. PricingPlanDataSource *string `type:"string"` // Specifies a timestamp for when the resource was last updated in ISO 8601 @@ -7997,7 +10561,7 @@ func (s *ListPlaceIndexesInput) SetNextToken(v string) *ListPlaceIndexesInput { type ListPlaceIndexesOutput struct { _ struct{} `type:"structure"` - // Lists the Place index resources that exist in your AWS account + // Lists the place index resources that exist in your AWS account // // Entries is a required field Entries []*ListPlaceIndexesResponseEntry `type:"list" required:"true"` @@ -8029,11 +10593,11 @@ func (s *ListPlaceIndexesOutput) SetNextToken(v string) *ListPlaceIndexesOutput return s } -// A Place index resource listed in your AWS account. +// A place index resource listed in your AWS account. type ListPlaceIndexesResponseEntry struct { _ struct{} `type:"structure"` - // The timestamp for when the Place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // The timestamp for when the place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) // format: YYYY-MM-DDThh:mm:ss.sssZ. // // CreateTime is a required field @@ -8043,7 +10607,7 @@ type ListPlaceIndexesResponseEntry struct { // // * Esri // - // * HERE + // * Here // // For additional details on data providers, see the Amazon Location Service // data providers page (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). @@ -8051,74 +10615,325 @@ type ListPlaceIndexesResponseEntry struct { // DataSource is a required field DataSource *string `type:"string" required:"true"` - // The optional description for the Place index resource. + // The optional description for the place index resource. // // Description is a required field Description *string `type:"string" required:"true"` - // The name of the Place index resource. + // The name of the place index resource. // // IndexName is a required field IndexName *string `min:"1" type:"string" required:"true"` - // The pricing plan for the specified Place index resource. - // - // For additional details and restrictions on each pricing plan option, see - // the Amazon Location Service pricing page (https://aws.amazon.com/location/pricing/). - // - // PricingPlan is a required field - PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` + // The pricing plan for the specified place index resource. + // + // For additional details and restrictions on each pricing plan option, see + // the Amazon Location Service pricing page (https://aws.amazon.com/location/pricing/). + // + // PricingPlan is a required field + PricingPlan *string `type:"string" required:"true" 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. + // + // UpdateTime is a required field + UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` +} + +// String returns the string representation +func (s ListPlaceIndexesResponseEntry) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListPlaceIndexesResponseEntry) GoString() string { + return s.String() +} + +// SetCreateTime sets the CreateTime field's value. +func (s *ListPlaceIndexesResponseEntry) SetCreateTime(v time.Time) *ListPlaceIndexesResponseEntry { + s.CreateTime = &v + return s +} + +// SetDataSource sets the DataSource field's value. +func (s *ListPlaceIndexesResponseEntry) SetDataSource(v string) *ListPlaceIndexesResponseEntry { + s.DataSource = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ListPlaceIndexesResponseEntry) SetDescription(v string) *ListPlaceIndexesResponseEntry { + s.Description = &v + return s +} + +// SetIndexName sets the IndexName field's value. +func (s *ListPlaceIndexesResponseEntry) SetIndexName(v string) *ListPlaceIndexesResponseEntry { + s.IndexName = &v + return s +} + +// SetPricingPlan sets the PricingPlan field's value. +func (s *ListPlaceIndexesResponseEntry) SetPricingPlan(v string) *ListPlaceIndexesResponseEntry { + s.PricingPlan = &v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *ListPlaceIndexesResponseEntry) SetUpdateTime(v time.Time) *ListPlaceIndexesResponseEntry { + s.UpdateTime = &v + return s +} + +type ListRouteCalculatorsInput struct { + _ struct{} `type:"structure"` + + // An optional maximum number of results returned in a single call. + // + // Default Value: 100 + MaxResults *int64 `min:"1" type:"integer"` + + // The pagination token specifying which page of results to return in the response. + // If no token is provided, the default page is the first page. + // + // Default Value: null + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s ListRouteCalculatorsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListRouteCalculatorsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListRouteCalculatorsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRouteCalculatorsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListRouteCalculatorsInput) SetMaxResults(v int64) *ListRouteCalculatorsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRouteCalculatorsInput) SetNextToken(v string) *ListRouteCalculatorsInput { + s.NextToken = &v + return s +} + +type ListRouteCalculatorsOutput struct { + _ struct{} `type:"structure"` + + // Lists the route calculator resources that exist in your AWS account + // + // Entries is a required field + Entries []*ListRouteCalculatorsResponseEntry `type:"list" required:"true"` + + // A pagination token indicating there are additional pages available. You can + // use the token in a subsequent request to fetch the next set of results. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s ListRouteCalculatorsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListRouteCalculatorsOutput) GoString() string { + return s.String() +} + +// SetEntries sets the Entries field's value. +func (s *ListRouteCalculatorsOutput) SetEntries(v []*ListRouteCalculatorsResponseEntry) *ListRouteCalculatorsOutput { + s.Entries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRouteCalculatorsOutput) SetNextToken(v string) *ListRouteCalculatorsOutput { + s.NextToken = &v + return s +} + +// A route calculator resource listed in your AWS account. +type ListRouteCalculatorsResponseEntry struct { + _ struct{} `type:"structure"` + + // The name of the route calculator resource. + // + // CalculatorName is a required field + CalculatorName *string `min:"1" type:"string" required:"true"` + + // The timestamp when the route calculator resource was created in ISO 8601 + // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. + // + // * For example, 2020–07-2T12:15:20.000Z+01:00 + // + // CreateTime is a required field + CreateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // 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 (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // + // DataSource is a required field + DataSource *string `type:"string" required:"true"` + + // The optional description of the route calculator resource. + // + // 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/). + // + // PricingPlan is a required field + PricingPlan *string `type:"string" required:"true" 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. + // + // * For example, 2020–07-2T12:15:20.000Z+01:00 + // + // UpdateTime is a required field + UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` +} + +// String returns the string representation +func (s ListRouteCalculatorsResponseEntry) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListRouteCalculatorsResponseEntry) GoString() string { + return s.String() +} + +// SetCalculatorName sets the CalculatorName field's value. +func (s *ListRouteCalculatorsResponseEntry) SetCalculatorName(v string) *ListRouteCalculatorsResponseEntry { + s.CalculatorName = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *ListRouteCalculatorsResponseEntry) SetCreateTime(v time.Time) *ListRouteCalculatorsResponseEntry { + s.CreateTime = &v + return s +} + +// SetDataSource sets the DataSource field's value. +func (s *ListRouteCalculatorsResponseEntry) SetDataSource(v string) *ListRouteCalculatorsResponseEntry { + s.DataSource = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ListRouteCalculatorsResponseEntry) SetDescription(v string) *ListRouteCalculatorsResponseEntry { + s.Description = &v + return s +} + +// SetPricingPlan sets the PricingPlan field's value. +func (s *ListRouteCalculatorsResponseEntry) SetPricingPlan(v string) *ListRouteCalculatorsResponseEntry { + s.PricingPlan = &v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *ListRouteCalculatorsResponseEntry) SetUpdateTime(v time.Time) *ListRouteCalculatorsResponseEntry { + s.UpdateTime = &v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` - // 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. + // The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. // - // UpdateTime is a required field - UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` } // String returns the string representation -func (s ListPlaceIndexesResponseEntry) String() string { +func (s ListTagsForResourceInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListPlaceIndexesResponseEntry) GoString() string { +func (s ListTagsForResourceInput) GoString() string { return s.String() } -// SetCreateTime sets the CreateTime field's value. -func (s *ListPlaceIndexesResponseEntry) SetCreateTime(v time.Time) *ListPlaceIndexesResponseEntry { - s.CreateTime = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDataSource sets the DataSource field's value. -func (s *ListPlaceIndexesResponseEntry) SetDataSource(v string) *ListPlaceIndexesResponseEntry { - s.DataSource = &v +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v return s } -// SetDescription sets the Description field's value. -func (s *ListPlaceIndexesResponseEntry) SetDescription(v string) *ListPlaceIndexesResponseEntry { - s.Description = &v - return s +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The mapping from tag key to tag value for each tag associated with the specified + // resource. + Tags map[string]*string `type:"map"` } -// SetIndexName sets the IndexName field's value. -func (s *ListPlaceIndexesResponseEntry) SetIndexName(v string) *ListPlaceIndexesResponseEntry { - s.IndexName = &v - return s +// String returns the string representation +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) } -// SetPricingPlan sets the PricingPlan field's value. -func (s *ListPlaceIndexesResponseEntry) SetPricingPlan(v string) *ListPlaceIndexesResponseEntry { - s.PricingPlan = &v - return s +// GoString returns the string representation +func (s ListTagsForResourceOutput) GoString() string { + return s.String() } -// SetUpdateTime sets the UpdateTime field's value. -func (s *ListPlaceIndexesResponseEntry) SetUpdateTime(v time.Time) *ListPlaceIndexesResponseEntry { - s.UpdateTime = &v +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v return s } @@ -8339,8 +11154,7 @@ type ListTrackersResponseEntry struct { // PricingPlan is a required field PricingPlan *string `type:"string" required:"true" enum:"PricingPlan"` - // The data source selected for the tracker resource and associated pricing - // plan. + // The specified data provider for the tracker resource. PricingPlanDataSource *string `type:"string"` // The name of the tracker resource. @@ -8407,8 +11221,9 @@ type MapConfiguration struct { // Specifies the map style selected from an available data provider. // - // Valid styles: VectorEsriStreets, VectorEsriTopographic, VectorEsriNavigation, - // VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas, VectorHereBerlin. + // Valid styles: RasterEsriImagery, VectorEsriStreets, VectorEsriTopographic, + // VectorEsriNavigation, VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas, + // VectorHereBerlin. // // When using HERE as your data provider, and selecting the Style VectorHereBerlin, // you may not use HERE Maps for Asset Management. See the AWS Service Terms @@ -8779,7 +11594,7 @@ func (s *ResourceNotFoundException) RequestID() string { } // Specifies a single point of interest, or Place as a result of a search query -// obtained from a dataset configured in the Place index Resource. +// obtained from a dataset configured in the place index resource. type SearchForPositionResult struct { _ struct{} `type:"structure"` @@ -8834,7 +11649,7 @@ func (s *SearchForTextResult) SetPlace(v *Place) *SearchForTextResult { type SearchPlaceIndexForPositionInput struct { _ struct{} `type:"structure"` - // The name of the Place index resource you want to use for the search. + // The name of the place index resource you want to use for the search. // // IndexName is a required field IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"` @@ -9045,7 +11860,7 @@ type SearchPlaceIndexForTextInput struct { // AUS. FilterCountries []*string `min:"1" type:"list"` - // The name of the Place index resource you want to use for the search. + // The name of the place index resource you want to use for the search. // // IndexName is a required field IndexName *string `location:"uri" locationName:"IndexName" min:"1" type:"string" required:"true"` @@ -9272,6 +12087,153 @@ func (s *SearchPlaceIndexForTextSummary) SetText(v string) *SearchPlaceIndexForT return s } +// Represents an element of a leg within a route. A step contains instructions +// for how to move to the next step in the leg. +type Step struct { + _ struct{} `type:"structure"` + + // The travel distance between the step's StartPosition and EndPosition. + // + // Distance is a required field + Distance *float64 `type:"double" required:"true"` + + // The estimated travel time, in seconds, from the step's StartPosition to the + // EndPosition. . The travel mode and departure time that you specify in the + // request determines the calculated time. + // + // DurationSeconds is a required field + DurationSeconds *float64 `type:"double" required:"true"` + + // The end position of a step. If the position the last step in the leg, this + // position is the same as the end position of the leg. + // + // EndPosition is a required field + EndPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` + + // Represents the start position, or index, in a sequence of steps within the + // leg's line string geometry. For example, the index of the first step in a + // leg geometry is 0. + // + // Included in the response for queries that set IncludeLegGeometry to True. + GeometryOffset *int64 `type:"integer"` + + // The starting position of a step. If the position is the first step in the + // leg, this position is the same as the start position of the leg. + // + // StartPosition is a required field + StartPosition []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` +} + +// String returns the string representation +func (s Step) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Step) GoString() string { + return s.String() +} + +// SetDistance sets the Distance field's value. +func (s *Step) SetDistance(v float64) *Step { + s.Distance = &v + return s +} + +// SetDurationSeconds sets the DurationSeconds field's value. +func (s *Step) SetDurationSeconds(v float64) *Step { + s.DurationSeconds = &v + return s +} + +// SetEndPosition sets the EndPosition field's value. +func (s *Step) SetEndPosition(v []*float64) *Step { + s.EndPosition = v + return s +} + +// SetGeometryOffset sets the GeometryOffset field's value. +func (s *Step) SetGeometryOffset(v int64) *Step { + s.GeometryOffset = &v + return s +} + +// SetStartPosition sets the StartPosition field's value. +func (s *Step) SetStartPosition(v []*float64) *Step { + s.StartPosition = v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource whose tags you want to update. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` + + // The mapping from tag key to tag value for each tag associated with the specified + // resource. + // + // Tags is a required field + Tags map[string]*string `type:"map" required:"true"` +} + +// String returns the string representation +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceOutput) GoString() string { + return s.String() +} + // The request was denied due to request throttling. type ThrottlingException struct { _ struct{} `type:"structure"` @@ -9328,6 +12290,179 @@ func (s *ThrottlingException) RequestID() string { return s.RespMetadata.RequestID } +// Contains details about the truck dimensions in the unit of measurement that +// you specify. Used to filter out roads that can't support or allow the specified +// dimensions for requests that specify TravelMode as Truck. +type TruckDimensions struct { + _ struct{} `type:"structure"` + + // The height of the truck. + // + // * For example, 4.5. + Height *float64 `type:"double"` + + // The length of the truck. + // + // * For example, 15.5. + Length *float64 `type:"double"` + + // Specifies the unit of measurement for the truck dimensions. + // + // Default Value: Meters + Unit *string `type:"string" enum:"DimensionUnit"` + + // The width of the truck. + // + // * For example, 4.5. + Width *float64 `type:"double"` +} + +// String returns the string representation +func (s TruckDimensions) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TruckDimensions) GoString() string { + return s.String() +} + +// SetHeight sets the Height field's value. +func (s *TruckDimensions) SetHeight(v float64) *TruckDimensions { + s.Height = &v + return s +} + +// SetLength sets the Length field's value. +func (s *TruckDimensions) SetLength(v float64) *TruckDimensions { + s.Length = &v + return s +} + +// SetUnit sets the Unit field's value. +func (s *TruckDimensions) SetUnit(v string) *TruckDimensions { + s.Unit = &v + return s +} + +// SetWidth sets the Width field's value. +func (s *TruckDimensions) SetWidth(v float64) *TruckDimensions { + s.Width = &v + return s +} + +// Contains details about the truck's weight specifications. Used to avoid roads +// that can't support or allow the total weight for requests that specify TravelMode +// as Truck. +type TruckWeight struct { + _ struct{} `type:"structure"` + + // The total weight of the truck. + // + // * For example, 3500. + Total *float64 `type:"double"` + + // The unit of measurement to use for the truck weight. + // + // Default Value: Kilograms + Unit *string `type:"string" enum:"VehicleWeightUnit"` +} + +// String returns the string representation +func (s TruckWeight) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TruckWeight) GoString() string { + return s.String() +} + +// SetTotal sets the Total field's value. +func (s *TruckWeight) SetTotal(v float64) *TruckWeight { + s.Total = &v + return s +} + +// SetUnit sets the Unit field's value. +func (s *TruckWeight) SetUnit(v string) *TruckWeight { + s.Unit = &v + return s +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource from which you want to remove + // tags. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` + + // The list of tag keys to remove from the resource. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + if s.TagKeys != nil && len(s.TagKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceOutput) GoString() string { + return s.String() +} + // The input failed to meet the constraints specified by the AWS service. type ValidationException struct { _ struct{} `type:"structure"` @@ -9464,6 +12599,38 @@ func BatchItemErrorCode_Values() []string { } } +const ( + // DimensionUnitMeters is a DimensionUnit enum value + DimensionUnitMeters = "Meters" + + // DimensionUnitFeet is a DimensionUnit enum value + DimensionUnitFeet = "Feet" +) + +// DimensionUnit_Values returns all elements of the DimensionUnit enum +func DimensionUnit_Values() []string { + return []string{ + DimensionUnitMeters, + DimensionUnitFeet, + } +} + +const ( + // DistanceUnitKilometers is a DistanceUnit enum value + DistanceUnitKilometers = "Kilometers" + + // DistanceUnitMiles is a DistanceUnit enum value + DistanceUnitMiles = "Miles" +) + +// DistanceUnit_Values returns all elements of the DistanceUnit enum +func DistanceUnit_Values() []string { + return []string{ + DistanceUnitKilometers, + DistanceUnitMiles, + } +} + const ( // IntendedUseSingleUse is a IntendedUse enum value IntendedUseSingleUse = "SingleUse" @@ -9500,6 +12667,26 @@ func PricingPlan_Values() []string { } } +const ( + // TravelModeCar is a TravelMode enum value + TravelModeCar = "Car" + + // TravelModeTruck is a TravelMode enum value + TravelModeTruck = "Truck" + + // TravelModeWalking is a TravelMode enum value + TravelModeWalking = "Walking" +) + +// TravelMode_Values returns all elements of the TravelMode enum +func TravelMode_Values() []string { + return []string{ + TravelModeCar, + TravelModeTruck, + TravelModeWalking, + } +} + const ( // ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value ValidationExceptionReasonUnknownOperation = "UnknownOperation" @@ -9527,3 +12714,19 @@ func ValidationExceptionReason_Values() []string { ValidationExceptionReasonOther, } } + +const ( + // VehicleWeightUnitKilograms is a VehicleWeightUnit enum value + VehicleWeightUnitKilograms = "Kilograms" + + // VehicleWeightUnitPounds is a VehicleWeightUnit enum value + VehicleWeightUnitPounds = "Pounds" +) + +// VehicleWeightUnit_Values returns all elements of the VehicleWeightUnit enum +func VehicleWeightUnit_Values() []string { + return []string{ + VehicleWeightUnitKilograms, + VehicleWeightUnitPounds, + } +} diff --git a/service/locationservice/doc.go b/service/locationservice/doc.go index 806497e2e6e..1e8efd97ed4 100644 --- a/service/locationservice/doc.go +++ b/service/locationservice/doc.go @@ -3,7 +3,8 @@ // Package locationservice provides the client and types for making API // requests to Amazon Location Service. // -// Suite of geospatial services including Maps, Places, Tracking, and Geofencing +// Suite of geospatial services including Maps, Places, Routes, Tracking, and +// Geofencing // // See https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19 for more information on this service. // diff --git a/service/locationservice/locationserviceiface/interface.go b/service/locationservice/locationserviceiface/interface.go index fabd3c87359..522fb3abc2f 100644 --- a/service/locationservice/locationserviceiface/interface.go +++ b/service/locationservice/locationserviceiface/interface.go @@ -64,6 +64,10 @@ type LocationServiceAPI interface { AssociateTrackerConsumerWithContext(aws.Context, *locationservice.AssociateTrackerConsumerInput, ...request.Option) (*locationservice.AssociateTrackerConsumerOutput, error) AssociateTrackerConsumerRequest(*locationservice.AssociateTrackerConsumerInput) (*request.Request, *locationservice.AssociateTrackerConsumerOutput) + BatchDeleteDevicePositionHistory(*locationservice.BatchDeleteDevicePositionHistoryInput) (*locationservice.BatchDeleteDevicePositionHistoryOutput, error) + BatchDeleteDevicePositionHistoryWithContext(aws.Context, *locationservice.BatchDeleteDevicePositionHistoryInput, ...request.Option) (*locationservice.BatchDeleteDevicePositionHistoryOutput, error) + BatchDeleteDevicePositionHistoryRequest(*locationservice.BatchDeleteDevicePositionHistoryInput) (*request.Request, *locationservice.BatchDeleteDevicePositionHistoryOutput) + BatchDeleteGeofence(*locationservice.BatchDeleteGeofenceInput) (*locationservice.BatchDeleteGeofenceOutput, error) BatchDeleteGeofenceWithContext(aws.Context, *locationservice.BatchDeleteGeofenceInput, ...request.Option) (*locationservice.BatchDeleteGeofenceOutput, error) BatchDeleteGeofenceRequest(*locationservice.BatchDeleteGeofenceInput) (*request.Request, *locationservice.BatchDeleteGeofenceOutput) @@ -84,6 +88,10 @@ type LocationServiceAPI interface { BatchUpdateDevicePositionWithContext(aws.Context, *locationservice.BatchUpdateDevicePositionInput, ...request.Option) (*locationservice.BatchUpdateDevicePositionOutput, error) BatchUpdateDevicePositionRequest(*locationservice.BatchUpdateDevicePositionInput) (*request.Request, *locationservice.BatchUpdateDevicePositionOutput) + CalculateRoute(*locationservice.CalculateRouteInput) (*locationservice.CalculateRouteOutput, error) + CalculateRouteWithContext(aws.Context, *locationservice.CalculateRouteInput, ...request.Option) (*locationservice.CalculateRouteOutput, error) + CalculateRouteRequest(*locationservice.CalculateRouteInput) (*request.Request, *locationservice.CalculateRouteOutput) + CreateGeofenceCollection(*locationservice.CreateGeofenceCollectionInput) (*locationservice.CreateGeofenceCollectionOutput, error) CreateGeofenceCollectionWithContext(aws.Context, *locationservice.CreateGeofenceCollectionInput, ...request.Option) (*locationservice.CreateGeofenceCollectionOutput, error) CreateGeofenceCollectionRequest(*locationservice.CreateGeofenceCollectionInput) (*request.Request, *locationservice.CreateGeofenceCollectionOutput) @@ -96,6 +104,10 @@ type LocationServiceAPI interface { CreatePlaceIndexWithContext(aws.Context, *locationservice.CreatePlaceIndexInput, ...request.Option) (*locationservice.CreatePlaceIndexOutput, error) CreatePlaceIndexRequest(*locationservice.CreatePlaceIndexInput) (*request.Request, *locationservice.CreatePlaceIndexOutput) + CreateRouteCalculator(*locationservice.CreateRouteCalculatorInput) (*locationservice.CreateRouteCalculatorOutput, error) + CreateRouteCalculatorWithContext(aws.Context, *locationservice.CreateRouteCalculatorInput, ...request.Option) (*locationservice.CreateRouteCalculatorOutput, error) + CreateRouteCalculatorRequest(*locationservice.CreateRouteCalculatorInput) (*request.Request, *locationservice.CreateRouteCalculatorOutput) + CreateTracker(*locationservice.CreateTrackerInput) (*locationservice.CreateTrackerOutput, error) CreateTrackerWithContext(aws.Context, *locationservice.CreateTrackerInput, ...request.Option) (*locationservice.CreateTrackerOutput, error) CreateTrackerRequest(*locationservice.CreateTrackerInput) (*request.Request, *locationservice.CreateTrackerOutput) @@ -112,6 +124,10 @@ type LocationServiceAPI interface { DeletePlaceIndexWithContext(aws.Context, *locationservice.DeletePlaceIndexInput, ...request.Option) (*locationservice.DeletePlaceIndexOutput, error) DeletePlaceIndexRequest(*locationservice.DeletePlaceIndexInput) (*request.Request, *locationservice.DeletePlaceIndexOutput) + DeleteRouteCalculator(*locationservice.DeleteRouteCalculatorInput) (*locationservice.DeleteRouteCalculatorOutput, error) + DeleteRouteCalculatorWithContext(aws.Context, *locationservice.DeleteRouteCalculatorInput, ...request.Option) (*locationservice.DeleteRouteCalculatorOutput, error) + DeleteRouteCalculatorRequest(*locationservice.DeleteRouteCalculatorInput) (*request.Request, *locationservice.DeleteRouteCalculatorOutput) + DeleteTracker(*locationservice.DeleteTrackerInput) (*locationservice.DeleteTrackerOutput, error) DeleteTrackerWithContext(aws.Context, *locationservice.DeleteTrackerInput, ...request.Option) (*locationservice.DeleteTrackerOutput, error) DeleteTrackerRequest(*locationservice.DeleteTrackerInput) (*request.Request, *locationservice.DeleteTrackerOutput) @@ -128,6 +144,10 @@ type LocationServiceAPI interface { DescribePlaceIndexWithContext(aws.Context, *locationservice.DescribePlaceIndexInput, ...request.Option) (*locationservice.DescribePlaceIndexOutput, error) DescribePlaceIndexRequest(*locationservice.DescribePlaceIndexInput) (*request.Request, *locationservice.DescribePlaceIndexOutput) + DescribeRouteCalculator(*locationservice.DescribeRouteCalculatorInput) (*locationservice.DescribeRouteCalculatorOutput, error) + DescribeRouteCalculatorWithContext(aws.Context, *locationservice.DescribeRouteCalculatorInput, ...request.Option) (*locationservice.DescribeRouteCalculatorOutput, error) + DescribeRouteCalculatorRequest(*locationservice.DescribeRouteCalculatorInput) (*request.Request, *locationservice.DescribeRouteCalculatorOutput) + DescribeTracker(*locationservice.DescribeTrackerInput) (*locationservice.DescribeTrackerOutput, error) DescribeTrackerWithContext(aws.Context, *locationservice.DescribeTrackerInput, ...request.Option) (*locationservice.DescribeTrackerOutput, error) DescribeTrackerRequest(*locationservice.DescribeTrackerInput) (*request.Request, *locationservice.DescribeTrackerOutput) @@ -167,6 +187,13 @@ type LocationServiceAPI interface { GetMapTileWithContext(aws.Context, *locationservice.GetMapTileInput, ...request.Option) (*locationservice.GetMapTileOutput, error) GetMapTileRequest(*locationservice.GetMapTileInput) (*request.Request, *locationservice.GetMapTileOutput) + ListDevicePositions(*locationservice.ListDevicePositionsInput) (*locationservice.ListDevicePositionsOutput, error) + ListDevicePositionsWithContext(aws.Context, *locationservice.ListDevicePositionsInput, ...request.Option) (*locationservice.ListDevicePositionsOutput, error) + ListDevicePositionsRequest(*locationservice.ListDevicePositionsInput) (*request.Request, *locationservice.ListDevicePositionsOutput) + + ListDevicePositionsPages(*locationservice.ListDevicePositionsInput, func(*locationservice.ListDevicePositionsOutput, bool) bool) error + ListDevicePositionsPagesWithContext(aws.Context, *locationservice.ListDevicePositionsInput, func(*locationservice.ListDevicePositionsOutput, bool) bool, ...request.Option) error + ListGeofenceCollections(*locationservice.ListGeofenceCollectionsInput) (*locationservice.ListGeofenceCollectionsOutput, error) ListGeofenceCollectionsWithContext(aws.Context, *locationservice.ListGeofenceCollectionsInput, ...request.Option) (*locationservice.ListGeofenceCollectionsOutput, error) ListGeofenceCollectionsRequest(*locationservice.ListGeofenceCollectionsInput) (*request.Request, *locationservice.ListGeofenceCollectionsOutput) @@ -195,6 +222,17 @@ type LocationServiceAPI interface { ListPlaceIndexesPages(*locationservice.ListPlaceIndexesInput, func(*locationservice.ListPlaceIndexesOutput, bool) bool) error ListPlaceIndexesPagesWithContext(aws.Context, *locationservice.ListPlaceIndexesInput, func(*locationservice.ListPlaceIndexesOutput, bool) bool, ...request.Option) error + ListRouteCalculators(*locationservice.ListRouteCalculatorsInput) (*locationservice.ListRouteCalculatorsOutput, error) + ListRouteCalculatorsWithContext(aws.Context, *locationservice.ListRouteCalculatorsInput, ...request.Option) (*locationservice.ListRouteCalculatorsOutput, error) + ListRouteCalculatorsRequest(*locationservice.ListRouteCalculatorsInput) (*request.Request, *locationservice.ListRouteCalculatorsOutput) + + ListRouteCalculatorsPages(*locationservice.ListRouteCalculatorsInput, func(*locationservice.ListRouteCalculatorsOutput, bool) bool) error + ListRouteCalculatorsPagesWithContext(aws.Context, *locationservice.ListRouteCalculatorsInput, func(*locationservice.ListRouteCalculatorsOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*locationservice.ListTagsForResourceInput) (*locationservice.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *locationservice.ListTagsForResourceInput, ...request.Option) (*locationservice.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*locationservice.ListTagsForResourceInput) (*request.Request, *locationservice.ListTagsForResourceOutput) + ListTrackerConsumers(*locationservice.ListTrackerConsumersInput) (*locationservice.ListTrackerConsumersOutput, error) ListTrackerConsumersWithContext(aws.Context, *locationservice.ListTrackerConsumersInput, ...request.Option) (*locationservice.ListTrackerConsumersOutput, error) ListTrackerConsumersRequest(*locationservice.ListTrackerConsumersInput) (*request.Request, *locationservice.ListTrackerConsumersOutput) @@ -220,6 +258,14 @@ type LocationServiceAPI interface { SearchPlaceIndexForText(*locationservice.SearchPlaceIndexForTextInput) (*locationservice.SearchPlaceIndexForTextOutput, error) SearchPlaceIndexForTextWithContext(aws.Context, *locationservice.SearchPlaceIndexForTextInput, ...request.Option) (*locationservice.SearchPlaceIndexForTextOutput, error) SearchPlaceIndexForTextRequest(*locationservice.SearchPlaceIndexForTextInput) (*request.Request, *locationservice.SearchPlaceIndexForTextOutput) + + TagResource(*locationservice.TagResourceInput) (*locationservice.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *locationservice.TagResourceInput, ...request.Option) (*locationservice.TagResourceOutput, error) + TagResourceRequest(*locationservice.TagResourceInput) (*request.Request, *locationservice.TagResourceOutput) + + UntagResource(*locationservice.UntagResourceInput) (*locationservice.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *locationservice.UntagResourceInput, ...request.Option) (*locationservice.UntagResourceOutput, error) + UntagResourceRequest(*locationservice.UntagResourceInput) (*request.Request, *locationservice.UntagResourceOutput) } var _ LocationServiceAPI = (*locationservice.LocationService)(nil)