Evaluates device positions against the geofence geometries from a given geofence\n collection.
\nThis operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:
\n\n ENTER if Amazon Location determines that the tracked device has entered\n a geofenced area.
\n EXIT if Amazon Location determines that the tracked device has exited a\n geofenced area.
The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.
\nGeofence evaluation uses the given device position. It does not account for the \n optional Accuracy of a DevicePositionUpdate.
Evaluates device positions against the geofence geometries from a given geofence\n collection.
\nThis operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:
\n\n ENTER if Amazon Location determines that the tracked device has entered\n a geofenced area.
\n EXIT if Amazon Location determines that the tracked device has exited a\n geofenced area.
The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.
\nGeofence evaluation uses the given device position. It does not account for the\n optional Accuracy of a DevicePositionUpdate.
The DeviceID is used as a string to represent the device. You do not\n need to have a Tracker associated with the DeviceID.
\n Calculates a route given the following required parameters:\n DeparturePosition and DestinationPosition. Requires that\n you first create a\n route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.
\nAdditional options include:
\n\n Specifying a departure time using either DepartureTime\n or DepartNow. This calculates a route based on predictive traffic\n data at the given time.
You can't specify both DepartureTime and\n DepartNow in a single request. Specifying both parameters\n returns a validation error.
\n Specifying a travel mode using TravelMode sets the transportation\n mode used to calculate the routes. This also lets you specify additional route\n preferences in CarModeOptions if traveling by Car, or\n TruckModeOptions if traveling by Truck.
\n Calculates a route given the following required parameters:\n DeparturePosition and DestinationPosition. Requires that\n you first create a\n route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.
\nAdditional options include:
\n\n Specifying a\n departure time using either DepartureTime or\n DepartNow. This calculates a route based on predictive traffic\n data at the given time.
You can't specify both DepartureTime and\n DepartNow in a single request. Specifying both parameters\n returns a validation error.
\n Specifying a travel\n mode using TravelMode sets the transportation mode used to calculate\n the routes. This also lets you specify additional route preferences in\n CarModeOptions if traveling by Car, or\n TruckModeOptions if traveling by Truck.
\n Calculates a\n route matrix given the following required parameters:\n DeparturePositions and DestinationPositions.\n CalculateRouteMatrix calculates routes and returns the travel time and \n travel distance from each departure position to each destination position in the \n request. For example, given departure positions A and B, and destination positions \n X and Y, CalculateRouteMatrix will return time and distance for routes \n from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned \n (and routes calculated) will be the number of DeparturePositions \n times the number of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
\nRequires that you first create a\n route calculator resource.
\nBy default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating routes.
\nAdditional options include:
\n\n \n Specifying a departure time using either DepartureTime\n or DepartNow. This calculates routes based on predictive traffic\n data at the given time.
You can't specify both DepartureTime and\n DepartNow in a single request. Specifying both parameters\n returns a validation error.
\n Specifying a travel mode using TravelMode sets the transportation\n mode used to calculate the routes. This also lets you specify additional route\n preferences in CarModeOptions if traveling by Car, or\n TruckModeOptions if traveling by Truck.
\n Calculates a route\n matrix given the following required parameters:\n DeparturePositions and DestinationPositions.\n CalculateRouteMatrix calculates routes and returns the travel time and\n travel distance from each departure position to each destination position in the\n request. For example, given departure positions A and B, and destination positions X and\n Y, CalculateRouteMatrix will return time and distance for routes from A to\n X, A to Y, B to X, and B to Y (in that order). The number of results returned (and\n routes calculated) will be the number of DeparturePositions times the\n number of DestinationPositions.
Your account is charged for each route calculated, not the number of\n requests.
\nRequires that you first create a\n route calculator resource.
\nBy default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating routes.
\nAdditional options include:
\n\n Specifying a\n departure time using either DepartureTime or\n DepartNow. This calculates routes based on predictive traffic\n data at the given time.
You can't specify both DepartureTime and\n DepartNow in a single request. Specifying both parameters\n returns a validation error.
\n Specifying a travel\n mode using TravelMode sets the transportation mode used to calculate\n the routes. This also lets you specify additional route preferences in\n CarModeOptions if traveling by Car, or\n TruckModeOptions if traveling by Truck.
The name of the route calculator resource that you want to use to calculate the route matrix.
", + "smithy.api#documentation": "The name of the route calculator resource that you want to use to calculate the route\n matrix.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -969,7 +969,7 @@ "DeparturePositions": { "target": "com.amazonaws.location#PositionList", "traits": { - "smithy.api#documentation": "The list of departure (origin) positions for the route matrix. An array of points,\n each of which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-123.115,\n 49.285].
Depending on the data provider selected in the route calculator resource there may be additional\n restrictions on the inputs you can choose. See \n Position restrictions in the Amazon Location Service Developer Guide.
\nFor route calculators that use Esri as the data provider, if you specify a \n departure that's not located on a road, Amazon Location moves the position \n to the nearest road. The snapped value is available in the result in \n SnappedDeparturePositions.
Valid Values: [-180 to 180,-90 to 90]\n
The list of departure (origin) positions for the route matrix. An array of points,\n each of which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-123.115,\n 49.285].
Depending on the data provider selected in the route calculator resource there may\n be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer\n Guide.
\nFor route calculators that use Esri as the data provider, if you specify a\n departure that's not located on a road, Amazon Location moves the\n position to the nearest road. The snapped value is available in the\n result in SnappedDeparturePositions.
Valid Values: [-180 to 180,-90 to 90]\n
The list of destination positions for the route matrix. An array of points, each of\n which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-122.339,\n 47.615]\n
Depending on the data provider selected in the route calculator resource there may be additional\n restrictions on the inputs you can choose. See \n Position restrictions in the Amazon Location Service Developer Guide.
\nFor route calculators that use Esri as the data provider, if you specify a \n destination that's not located on a road, Amazon Location moves the position \n to the nearest road. The snapped value is available in the result in \n SnappedDestinationPositions.
Valid Values: [-180 to 180,-90 to 90]\n
The list of destination positions for the route matrix. An array of points, each of\n which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-122.339,\n 47.615]\n
Depending on the data provider selected in the route calculator resource there may\n be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer\n Guide.
\nFor route calculators that use Esri as the data provider, if you specify a\n destination that's not located on a road, Amazon Location moves the\n position to the nearest road. The snapped value is available in the\n result in SnappedDestinationPositions.
Valid Values: [-180 to 180,-90 to 90]\n
The calculated route matrix containing the results for all pairs of \n DeparturePositions to DestinationPositions. \n Each row corresponds to one entry in DeparturePositions. Each\n entry in the row corresponds to the route from that entry in\n DeparturePositions to an entry in DestinationPositions. \n
The calculated route matrix containing the results for all pairs of\n DeparturePositions to DestinationPositions. Each row\n corresponds to one entry in DeparturePositions. Each entry in the row\n corresponds to the route from that entry in DeparturePositions to an entry\n in DestinationPositions.
For routes calculated using an Esri route calculator resource, departure positions \n are snapped to the closest road. For Esri route calculator resources, this returns \n the list of departure/origin positions used for calculation of the \n RouteMatrix.
For routes calculated using an Esri route calculator resource, departure positions are\n snapped to the closest road. For Esri route calculator resources, this returns the list\n of departure/origin positions used for calculation of the\n RouteMatrix.
The list of destination positions for the route matrix used for calculation of the RouteMatrix.
The list of destination positions for the route matrix used for calculation of the\n RouteMatrix.
Contains information about the route matrix, DataSource,\n DistanceUnit, RouteCount and ErrorCount.
Contains information about the route matrix, DataSource,\n DistanceUnit, RouteCount and\n ErrorCount.
The data provider of traffic and road network data used to calculate the routes.\n Indicates one of the available providers:
\n\n Esri\n
\n Here\n
For more information about data providers, see Amazon Location Service data providers.
", + "smithy.api#documentation": "The data provider of traffic and road network data used to calculate the routes.\n Indicates one of the available providers:
\n\n Esri\n
\n Here\n
For more information about data providers, see Amazon Location Service data\n providers.
", "smithy.api#required": {} } }, "RouteCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The count of cells in the route matrix. Equal to the number of DeparturePositions\n multiplied by the number of DestinationPositions.
The count of cells in the route matrix. Equal to the number of\n DeparturePositions multiplied by the number of\n DestinationPositions.
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
", + "smithy.api#documentation": "The count of error results in the route matrix. If this number is 0, all routes were\n calculated successfully.
", "smithy.api#range": { "min": 1, "max": 160000 @@ -1118,7 +1118,7 @@ "CalculatorName": { "target": "com.amazonaws.location#ResourceName", "traits": { - "smithy.api#documentation": "The name of the route calculator resource that you want to use to calculate the route.
", + "smithy.api#documentation": "The name of the route calculator resource that you want to use to calculate the route.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1126,21 +1126,21 @@ "DeparturePosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "The start position for the route. Defined in WGS 84 format:\n [longitude, latitude].
For example, [-123.115, 49.285]\n
If you specify a departure that's not located on a road, Amazon Location moves the\n position to the nearest road. If Esri is the provider for your route calculator, \n specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]\n
The start position for the route. Defined in World Geodetic\n System (WGS 84) format:\n [longitude, latitude].
For example, [-123.115, 49.285]\n
If you specify a departure that's not located on a road, Amazon Location moves the position\n to the nearest road. If Esri is the provider for your route calculator,\n specifying a route that is longer than 400 km returns a 400\n RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]\n
The finish position for the route. Defined in WGS 84 format:\n [longitude, latitude].
For example, [-122.339, 47.615]\n
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
\nValid Values: [-180 to 180,-90 to 90]\n
The finish position for the route. Defined in World Geodetic\n System (WGS 84) format:\n [longitude, latitude].
For example, [-122.339, 47.615]\n
If you specify a destination that's not located on a road, Amazon Location moves the position\n to the nearest road.
\nValid Values: [-180 to 180,-90 to 90]\n
Specifies an ordered list of up to 23 intermediate positions to include along a route\n between the departure position and destination position.
\nFor example, from the DeparturePosition\n [-123.115, 49.285], the route follows the order that the waypoint\n positions are given [[-122.757, 49.0021],[-122.349, 47.620]]\n
If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
\nSpecifying more than 23 waypoints returns a 400 ValidationException\n error.
If Esri is the provider for your route calculator, specifying a \n route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]\n
Specifies an ordered list of up to 23 intermediate positions to include along a route\n between the departure position and destination position.
\nFor example, from the DeparturePosition\n [-123.115, 49.285], the route follows the order that the waypoint\n positions are given [[-122.757, 49.0021],[-122.349, 47.620]]\n
If you specify a waypoint position that's not located on a road, Amazon Location moves the position\n to the nearest road.
\nSpecifying more than 23 waypoints returns a 400 ValidationException\n error.
If Esri is the provider for your route calculator, specifying a route that is\n longer than 400 km returns a 400 RoutesValidationException\n error.
Valid Values: [-180 to 180,-90 to 90]\n
Contains details about each path between a pair of positions included along a route\n such as: StartPosition, EndPosition, Distance,\n DurationSeconds, Geometry, and Steps. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.
For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby road:
\nThe StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:
\nLeg 1: The StartPosition is the departure position . The\n EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The\n EndPosition is the destination position.
Contains details about each path between a pair of positions included along a route\n such as: StartPosition, EndPosition, Distance,\n DurationSeconds, Geometry, and Steps. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.
For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby\n road:
\nThe StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:
\nLeg 1: The StartPosition is the departure position . The\n EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The\n EndPosition is the destination position.
The total distance covered by the route. The sum of the distance travelled between\n every stop on the route.
\nIf Esri is the data source for the route calculator, the route distance can’t \n be greater than 400 km. If the route exceeds 400 km, the response is a \n 400 RoutesValidationException error.
The total distance covered by the route. The sum of the distance travelled between\n every stop on the route.
\nIf Esri is the data source for the route calculator, the route distance can’t be\n greater than 400 km. If the route exceeds 400 km, the response is a 400\n RoutesValidationException error.
No longer used. If included, the only allowed value is \n RequestBasedUsage.
No longer used. If included, the only allowed value is\n RequestBasedUsage.
Creates a place index resource in your AWS account. Use a place index resource to\n geocode addresses and other text queries by using the SearchPlaceIndexForText operation,\n and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and\n enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.
If your application is tracking or routing assets you use in your business, such \n as delivery vehicles or employees, you may only use HERE as your geolocation \n provider. See section 82 of the AWS\n service terms for more details.
\nCreates a place index resource in your AWS account. Use a place index resource to\n geocode addresses and other text queries by using the\n SearchPlaceIndexForText operation, and reverse geocode coordinates by\n using the SearchPlaceIndexForPosition operation, and enable autosuggestions\n by using the SearchPlaceIndexForSuggestions operation.
If your application is tracking or routing assets you use in your business, such\n as delivery vehicles or employees, you may only use HERE as your geolocation\n provider. See section 82 of the AWS\n service terms for more details.
\nThe name of the place index resource.
\nRequirements:
\nContain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and\n underscores (_).
\nMust be a unique place index resource name.
\nNo spaces allowed. For example, ExamplePlaceIndex.
The name of the place index resource.
\nRequirements:
\nContain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods\n (.), and underscores (_).
\nMust be a unique place index resource name.
\nNo spaces allowed. For example, ExamplePlaceIndex.
Specifies the geospatial data provider for the new place index.
\nThis field is case-sensitive. Enter the valid values as shown. For example, entering\n HERE returns an error.
Valid values include:
\n\n Esri – For additional information about Esri's coverage in your\n region of interest, see Esri details on geocoding coverage.
\n Here – For additional information about HERE Technologies'\n coverage in your region of interest, see HERE details on goecoding coverage.
If you specify HERE Technologies (Here) as the data provider,\n you may not store results for locations in Japan. For more information, see the\n AWS Service Terms\n for Amazon Location Service.
For additional information , see Data providers\n on the Amazon Location Service Developer Guide.
", + "smithy.api#documentation": "Specifies the geospatial data provider for the new place index.
\nThis field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error.
Valid values include:
\n\n Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.
\n Here – For additional information about HERE\n Technologies' coverage in your region of interest, see HERE details on goecoding coverage.
If you specify HERE Technologies (Here) as the data provider,\n you may not store results for locations in Japan. For more information, see\n the AWS Service\n Terms for Amazon Location Service.
For additional information , see Data\n providers on the Amazon Location Service Developer Guide.
", "smithy.api#required": {} } }, @@ -1606,7 +1606,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "No longer used. If included, the only allowed value is \n RequestBasedUsage.
No longer used. If included, the only allowed value is\n RequestBasedUsage.
Applies one or more tags to the place index resource. A tag is a key-value pair that helps you\n manage, identify, search, and filter your resources.
\nFormat: \"key\" : \"value\"\n
Restrictions:
\nMaximum 50 tags per resource.
\nEach tag key must be unique and must have exactly one associated value.
\nMaximum key length: 128 Unicode characters in UTF-8.
\nMaximum value length: 256 Unicode characters in UTF-8.
\nCan use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -\n = . _ : / @
\nCannot use \"aws:\" as a prefix for a key.
\nApplies one or more tags to the place index resource. A tag is a key-value pair that\n helps you manage, identify, search, and filter your resources.
\nFormat: \"key\" : \"value\"\n
Restrictions:
\nMaximum 50 tags per resource.
\nEach tag key must be unique and must have exactly one associated value.
\nMaximum key length: 128 Unicode characters in UTF-8.
\nMaximum value length: 256 Unicode characters in UTF-8.
\nCan use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:\n + - = . _ : / @
\nCannot use \"aws:\" as a prefix for a key.
\nThe Amazon Resource Name (ARN) for the place index resource. Used to specify a resource\n across AWS.
\nFormat example:\n arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex\n
The Amazon Resource Name (ARN) for the place index resource. Used to specify a\n resource across AWS.
\nFormat example:\n arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex\n
The timestamp for when the place index resource was created in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was created in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.
Creates a route calculator resource in your AWS account.
\nYou can send requests to a route calculator resource to estimate travel time,\n distance, and get directions. A route calculator sources traffic and road network data\n from your chosen data provider.
\nIf your application is tracking or routing assets you use in your business, such \n as delivery vehicles or employees, you may only use HERE as your geolocation \n provider. See section 82 of the AWS\n service terms for more details.
\nCreates a route calculator resource in your AWS account.
\nYou can send requests to a route calculator resource to estimate travel time,\n distance, and get directions. A route calculator sources traffic and road network data\n from your chosen data provider.
\nIf your application is tracking or routing assets you use in your business, such\n as delivery vehicles or employees, you may only use HERE as your geolocation\n provider. See section 82 of the AWS\n service terms for more details.
\nThe name of the route calculator resource.
\nRequirements:
\nCan use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores\n (_).
\nMust be a unique Route calculator resource name.
\nNo spaces allowed. For example, ExampleRouteCalculator.
The name of the route calculator resource.
\nRequirements:
\nCan use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.),\n and underscores (_).
\nMust be a unique Route calculator resource name.
\nNo spaces allowed. For example, ExampleRouteCalculator.
Specifies the data provider of traffic and road network data.
\nThis field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error. Route calculators that use Esri as a data source \n only calculate routes that are shorter than 400 km.
Valid values include:
\n\n Esri – For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.
\n Here – For additional information about HERE\n Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.
For additional information , see Data\n providers on the Amazon Location Service Developer Guide.
", + "smithy.api#documentation": "Specifies the data provider of traffic and road network data.
\nThis field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error. Route calculators that use Esri as a\n data source only calculate routes that are shorter than 400 km.
Valid values include:
\n\n Esri – For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.
\n Here – For additional information about HERE\n Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.
For additional information , see Data\n providers on the Amazon Location Service Developer Guide.
", "smithy.api#required": {} } }, @@ -1716,7 +1716,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "No longer used. If included, the only allowed value is \n RequestBasedUsage.
No longer used. If included, the only allowed value is\n RequestBasedUsage.
Specifies how the results of an operation will be stored by the caller.
\nValid values include:
\n\n SingleUse specifies that the results won't be stored.
\n Storage specifies that the result can be cached or stored in a database.
Default value: SingleUse\n
Specifies how the results of an operation will be stored by the caller.
\nValid values include:
\n\n SingleUse specifies that the results won't be stored.
\n Storage specifies that the result can be cached or stored in a\n database.
Default value: SingleUse\n
Specifies the data storage option chosen for requesting Places.
\nWhen using Amazon Location Places:
\nIf using HERE Technologies as a data provider, you can't store results for\n locations in Japan by setting IntendedUse to Storage.\n parameter.
Under the MobileAssetTracking or MobilAssetManagement\n pricing plan, you can't store results from your place index resources by setting IntendedUse to Storage. This\n returns a validation exception error.
For more information, see the AWS Service Terms for\n Amazon Location Service.
\nSpecifies the data storage option chosen for requesting Places.
\nWhen using Amazon Location Places:
\nIf using HERE Technologies as a data provider, you can't store results for\n locations in Japan by setting IntendedUse to\n Storage. parameter.
Under the MobileAssetTracking or\n MobilAssetManagement pricing plan, you can't store results\n from your place index resources by setting IntendedUse to\n Storage. This returns a validation exception error.
For more information, see the AWS Service Terms for Amazon Location Service.
\nDeletes a place index resource from your AWS account.
\nThis operation deletes the resource permanently.
\nDeletes a place index resource from your AWS account.
\nThis operation deletes the resource permanently.
\nDeletes a route calculator resource from your AWS account.
\nThis operation deletes the resource permanently.
\nDeletes a route calculator resource from your AWS account.
\nThis operation deletes the resource permanently.
\nThe Amazon Resource Name (ARN) for the place index resource. Used to specify a resource\n across AWS.
\nFormat example:\n arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex\n
The Amazon Resource Name (ARN) for the place index resource. Used to specify a\n resource across AWS.
\nFormat example:\n arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex\n
The timestamp for when the place index resource was created in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was created in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was last updated in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.
The data provider of geospatial data. Values can be one of the following:
\n\n Esri\n
\n Here\n
For more information about data providers, see Amazon Location Service data providers.
", + "smithy.api#documentation": "The data provider of geospatial data. Values can be one of the following:
\n\n Esri\n
\n Here\n
For more information about data providers, see Amazon Location Service data providers.
", "smithy.api#required": {} } }, @@ -3766,14 +3766,14 @@ "StartPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "The starting position of the leg. Follows the format\n [longitude,latitude].
If the StartPosition isn't located on a road, it's snapped to a nearby road.
The starting position of the leg. Follows the format\n [longitude,latitude].
If the StartPosition isn't located on a road, it's snapped to a\n nearby road.
The terminating position of the leg. Follows the format\n [longitude,latitude].
If the EndPosition isn't located on a road, it's snapped to a nearby road.
The terminating position of the leg. Follows the format\n [longitude,latitude].
If the EndPosition isn't located on a road, it's snapped to a nearby\n road.
Contains the calculated route's details for each path between a pair of positions. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.
\nFor example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby road:
\nThe StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:
\nLeg 1: The StartPosition is the departure position . The\n EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The\n EndPosition is the destination position.
Contains the calculated route's details for each path between a pair of positions. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.
\nFor example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby\n road:
\nThe StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:
\nLeg 1: The StartPosition is the departure position . The\n EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The\n EndPosition is the destination position.
The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
\nDefault value: null\n
An optional limit for the number of geofences returned in a single call.
\nDefault value: 100\n
An optional limit for the maximum number of results returned in a single call.
\nDefault value: 100\n
An optional limit for the maximum number of results returned in a single call.
\nDefault value: 100\n
The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
\nDefault value: null\n
The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
\nDefault value: null\n
A pagination token indicating that there are additional pages available. You can use the\n token in a new request to fetch the next page of results.
" + "smithy.api#documentation": "A pagination token indicating that there are additional pages available. You can use\n the token in a new request to fetch the next page of results.
" } } } @@ -4514,7 +4525,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The data provider of geospatial data. Values can be one of the following:
\n\n Esri\n
\n Here\n
For more information about data providers, see Amazon Location Service data providers.
", + "smithy.api#documentation": "The data provider of geospatial data. Values can be one of the following:
\n\n Esri\n
\n Here\n
For more information about data providers, see Amazon Location Service data providers.
", "smithy.api#required": {} } }, @@ -4531,14 +4542,14 @@ "CreateTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp for when the place index resource was created in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was created in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was last updated in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.
The full name and address of the point of interest such as a city,\n region, or country. For example, 123 Any Street, Any Town, USA.
The full name and address of the point of interest such as a city, region, or country.\n For example, 123 Any Street, Any Town, USA.
The name for a street or a road to identify a location. For example, Main\n Street.
The name for a street or a road to identify a location. For example, Main\n Street.
A name for a local area, such as a city or town name. For example,\n Toronto.
A name for a local area, such as a city or town name. For example,\n Toronto.
A country, or an area that's part of a larger region. For example, Metro\n Vancouver.
A country, or an area that's part of a larger region. For example, Metro\n Vancouver.
A name for an area or geographical division, such as a province or state name. For\n example, British Columbia.
A name for an area or geographical division, such as a province or state name. For\n example, British Columbia.
A country/region specified using ISO 3166 3-digit\n country/region code. For example, CAN.
A country/region specified using ISO 3166 3-digit\n country/region code. For example, CAN.
A group of numbers and letters in a country-specific format, which accompanies the\n address for the purpose of identifying a location.
" + "smithy.api#documentation": "A group of numbers and letters in a country-specific format, which accompanies the\n address for the purpose of identifying a location.
" } }, "Interpolated": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "\n True if the result is interpolated from other known places.
\n False if the Place is a known place.
Not returned when the partner does not provide the information.
\nFor example, returns False for an address location that is found in the \n partner data, but returns True if an address does not exist in the partner\n data and its location is calculated by interpolating between other known addresses.\n
\n True if the result is interpolated from other known places.
\n False if the Place is a known place.
Not returned when the partner does not provide the information.
\nFor example, returns False for an address location that is found in the\n partner data, but returns True if an address does not exist in the partner\n data and its location is calculated by interpolating between other known addresses.\n
The time zone in which the Place is located. Returned only when using \n Here as the selected partner.
The time zone in which the Place is located. Returned only when using\n Here as the selected partner.
Contains details about addresses or points of interest that match the search\n criteria.
" + "smithy.api#documentation": "Contains details about addresses or points of interest that match the search\n criteria.
\nNot all details are included with all responses. Some details may only be returned \n by specific data partners.
" } }, "com.amazonaws.location#PlaceGeometry": { @@ -5173,7 +5184,7 @@ "Point": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "A single point geometry specifies a location for a Place using WGS 84\n coordinates:
\n\n x — Specifies the x coordinate or longitude.
\n\n y — Specifies the y coordinate or latitude.
\nA single point geometry specifies a location for a Place using WGS 84\n coordinates:
\n\n x — Specifies the x coordinate or longitude.
\n\n y — Specifies the y coordinate or latitude.
\nAn error corresponding to the calculation of a route between the \n DeparturePosition and DestinationPosition.
An error corresponding to the calculation of a route between the\n DeparturePosition and DestinationPosition.
The result for the calculated route of one DeparturePosition \n DestinationPosition pair.
The result for the calculated route of one DeparturePosition\n DestinationPosition pair.
An error corresponding to the calculation of a route between the\n DeparturePosition and DestinationPosition.
The error code can be one of the following:
\n\n RouteNotFound - Unable to find a \n valid route with the given parameters.
\n RouteTooLong - Route calculation went \n beyond the maximum size of a route and was terminated before completion.
\n PositionsNotFound - One or more of the \n input positions were not found on the route network.
\n DestinationPositionNotFound - The \n destination position was not found on the route network.
\n DeparturePositionNotFound - The \n departure position was not found on the route network.
\n OtherValidationError - The given inputs were not valid or a \n route was not found. More information is given in the error \n Message\n
An error corresponding to the calculation of a route between the\n DeparturePosition and DestinationPosition.
The error code can be one of the following:
\n\n RouteNotFound - Unable to find a valid route with the given\n parameters.
\n RouteTooLong - Route calculation went beyond the maximum size of\n a route and was terminated before completion.
\n PositionsNotFound - One or more of the input positions were not\n found on the route network.
\n DestinationPositionNotFound - The destination position was not\n found on the route network.
\n DeparturePositionNotFound - The departure position was not found\n on the route network.
\n OtherValidationError - The given inputs were not valid or a route\n was not found. More information is given in the error\n Message\n
The distance in meters of a great-circle arc between the query position and the \n result.
\nA great-circle arc is the shortest path on a sphere, in this case the \n Earth. This returns the shortest distance between two locations.
\nThe distance in meters of a great-circle arc between the query position and the\n result.
\nA great-circle arc is the shortest path on a sphere, in this case the Earth. This\n returns the shortest distance between two locations.
\nContains a search result from a position search query that is run on a place index resource.
" + "smithy.api#documentation": "Contains a search result from a position search query that is run on a place index\n resource.
" } }, "com.amazonaws.location#SearchForPositionResultList": { @@ -5636,7 +5647,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.
" + "smithy.api#documentation": "Contains a place suggestion resulting from a place suggestion query that is run on a\n place index resource.
" } }, "com.amazonaws.location#SearchForSuggestionsResultList": { @@ -5658,7 +5669,7 @@ "Distance": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The distance in meters of a great-circle arc between the bias position specified \n and the result. Distance will be returned only if a bias position was \n specified in the query.
A great-circle arc is the shortest path on a sphere, in this case the \n Earth. This returns the shortest distance between two locations.
\nThe distance in meters of a great-circle arc between the bias position specified and\n the result. Distance will be returned only if a bias position was specified\n in the query.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This\n returns the shortest distance between two locations.
\nThe relative confidence in the match for a result among the results returned. For \n example, if more fields for an address match (including house number, street, city, \n country/region, and postal code), the relevance score is closer to 1.
\nReturned only when the partner selected is Esri.
", + "smithy.api#documentation": "The relative confidence in the match for a result among the results returned. For\n example, if more fields for an address match (including house number, street, city,\n country/region, and postal code), the relevance score is closer to 1.
\nReturned only when the partner selected is Esri.
", "smithy.api#range": { "min": 0, "max": 1 @@ -5676,7 +5687,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains a search result from a text search query that is run on a place index resource.
" + "smithy.api#documentation": "Contains a search result from a text search query that is run on a place index\n resource.
" } }, "com.amazonaws.location#SearchForTextResultList": { @@ -5711,7 +5722,7 @@ } ], "traits": { - "smithy.api#documentation": "Reverse geocodes a given coordinate and returns a legible address. Allows you to search\n for Places or points of interest near a given position.
", + "smithy.api#documentation": "Reverse geocodes a given coordinate and returns a legible address. Allows you to\n search for Places or points of interest near a given position.
", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -5736,20 +5747,20 @@ "Position": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "Specifies the longitude and latitude of the position to query.
\n\n This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; \n the second number represents the Y coordinate, or latitude.
\nFor example, [-123.1174, 49.2847] represents a position with\n longitude -123.1174 and\n latitude 49.2847.
Specifies the longitude and latitude of the position to query.
\nThis parameter must contain a pair of numbers. The first number represents the X\n coordinate, or longitude; the second number represents the Y coordinate, or\n latitude.
\nFor example, [-123.1174, 49.2847] represents a position with longitude\n -123.1174 and latitude 49.2847.
An optional parameter. The maximum number of results returned per request.
\nDefault value: 50\n
An optional parameter. The maximum number of results returned per request.
\nDefault value: 50\n
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.
This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.
" + "smithy.api#documentation": "The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.
This setting affects the languages used in the results, but not the results\n themselves. If no language is specified, or not supported for a particular result, the\n partner automatically chooses a language for the result.
\nFor an example, we'll use the Greek language. You search for a location around Athens,\n Greece, with the language parameter set to en. The\n city in the results will most likely be returned as\n Athens.
If you set the language parameter to el, for Greek, then the\n city in the results will more likely be returned as\n Αθήνα.
If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.
" } } } @@ -5760,14 +5771,14 @@ "Summary": { "target": "com.amazonaws.location#SearchPlaceIndexForPositionSummary", "traits": { - "smithy.api#documentation": "Contains a summary of the request. Echoes the input values for Position,\n Language, MaxResults, and the DataSource of the place index.\n
Contains a summary of the request. Echoes the input values for Position,\n Language, MaxResults, and the DataSource of\n the place index.
Returns a list of Places closest to the specified position. Each result contains\n additional information about the Places returned.
", + "smithy.api#documentation": "Returns a list of Places closest to the specified position. Each result contains\n additional information about the Places returned.
", "smithy.api#required": {} } } @@ -5786,25 +5797,25 @@ "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#documentation": "Contains the optional result count limit that is specified in the request.
\nDefault value: 50\n
Contains the optional result count limit that is specified in the request.
\nDefault value: 50\n
The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:
\nEsri
\nHere
\nFor more information about data providers, see Amazon Location Service data providers.
", + "smithy.api#documentation": "The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:
\nEsri
\nHere
\nFor more information about data providers, see Amazon Location Service data providers.
", "smithy.api#required": {} } }, "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.
The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.
A summary of the request sent by using SearchPlaceIndexForPosition.
A summary of the request sent by using\n SearchPlaceIndexForPosition.
Generates suggestions for addresses and points of interest based on partial or\n misspelled free-form text. This operation is also known as autocomplete, autosuggest,\n or fuzzy matching.
\nOptional parameters let you narrow your search results by bounding box or\n country, or bias your search toward a specific position on the globe.
\nYou can search for suggested place names near a specified position by using BiasPosition, or\n filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; \n using both BiasPosition and FilterBBox in the same command returns an error.
Generates suggestions for addresses and points of interest based on partial or\n misspelled free-form text. This operation is also known as autocomplete, autosuggest, or\n fuzzy matching.
\nOptional parameters let you narrow your search results by bounding box or country, or\n bias your search toward a specific position on the globe.
\nYou can search for suggested place names near a specified position by using\n BiasPosition, or filter results within a bounding box by using\n FilterBBox. These parameters are mutually exclusive; using both\n BiasPosition and FilterBBox in the same command\n returns an error.
The free-form partial text to use to generate place suggestions. For example,\n eiffel tow.
The free-form partial text to use to generate place suggestions. For example,\n eiffel tow.
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
\n\n If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; \n the second number represents the Y coordinate, or latitude.
\nFor example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and\n latitude 49.2847.
\n BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.\n
An optional parameter that indicates a preference for place suggestions that are\n closer to a specified position.
\nIf provided, this parameter must contain a pair of numbers. The first number\n represents the X coordinate, or longitude; the second number represents the Y\n coordinate, or latitude.
\nFor example, [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.
\n BiasPosition and FilterBBox are mutually exclusive.\n Specifying both options results in an error.
An optional parameter that limits the search results by returning only suggestions within a specified bounding box.
\n\n If provided, this parameter must contain a total of four consecutive numbers in two pairs.\n The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the northeast corner of the bounding box.
\nFor example, [-12.7935, -37.4835, -12.0684, -36.9542] represents\n a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, \n and the northeast corner has longitude -12.0684 and latitude -36.9542.
\n FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.\n
An optional parameter that limits the search results by returning only suggestions\n within a specified bounding box.
\nIf provided, this parameter must contain a total of four consecutive numbers in two\n pairs. The first pair of numbers represents the X and Y coordinates (longitude and\n latitude, respectively) of the southwest corner of the bounding box; the second pair of\n numbers represents the X and Y coordinates (longitude and latitude, respectively) of the\n northeast corner of the bounding box.
\nFor example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a\n bounding box where the southwest corner has longitude -12.7935 and latitude\n -37.4835, and the northeast corner has longitude -12.0684\n and latitude -36.9542.
\n FilterBBox and BiasPosition are mutually exclusive.\n Specifying both options results in an error.
An optional parameter that limits the search results by returning only suggestions within the provided list of countries.
\nUse the ISO 3166 3-digit\n country code. For example, Australia uses three upper-case characters:\n AUS.
An optional parameter that limits the search results by returning only suggestions\n within the provided list of countries.
\nUse the ISO\n 3166 3-digit country code. For example, Australia uses three\n upper-case characters: AUS.
An optional parameter. The maximum number of results returned per request.
\nThe default: 5\n
An optional parameter. The maximum number of results returned per request.
\nThe default: 5\n
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.
This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.
\nUsed only when the partner selected is Here.
" + "smithy.api#documentation": "The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.
This setting affects the languages used in the results. If no language is specified,\n or not supported for a particular result, the partner automatically chooses a language\n for the result.
\nFor an example, we'll use the Greek language. You search for Athens, Gr\n to get suggestions with the language parameter set to en. The\n results found will most likely be returned as Athens, Greece.
If you set the language parameter to el, for Greek, then the\n result found will more likely be returned as Αθήνα, Ελλάδα.
If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.
" } } } @@ -5909,7 +5919,7 @@ "Summary": { "target": "com.amazonaws.location#SearchPlaceIndexForSuggestionsSummary", "traits": { - "smithy.api#documentation": "Contains a summary of the request. Echoes the input values for BiasPosition,\n FilterBBox, FilterCountries, Language, MaxResults,\n and Text. Also includes the DataSource of the place index.\n
Contains a summary of the request. Echoes the input values for\n BiasPosition, FilterBBox, FilterCountries,\n Language, MaxResults, and Text. Also includes\n the DataSource of the place index.
The free-form partial text input specified in the request.
", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "Contains the coordinates for the optional bias position specified in the request.
\nThis parameter contains a pair of numbers. The first number represents the X \n coordinate, or longitude; the second number represents the Y coordinate, or latitude.
\nFor example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and latitude 49.2847.
Contains the coordinates for the optional bias position specified in the\n request.
\nThis parameter contains a pair of numbers. The first number represents the X\n coordinate, or longitude; the second number represents the Y coordinate, or\n latitude.
\nFor example, [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.
Contains the coordinates for the optional bounding box specified in the request.
" + "smithy.api#documentation": "Contains the coordinates for the optional bounding box specified in the\n request.
" } }, "FilterCountries": { @@ -5960,19 +5969,19 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:
\nEsri
\nHere
\nFor more information about data providers, see Amazon Location Service data providers.
", + "smithy.api#documentation": "The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:
\nEsri
\nHere
\nFor more information about data providers, see Amazon Location Service data providers.
", "smithy.api#required": {} } }, "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.
The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.
A summary of the request sent by using SearchPlaceIndexForSuggestions.
A summary of the request sent by using\n SearchPlaceIndexForSuggestions.
Geocodes free-form text, such as an address, name, city, or region to allow you to\n search for Places or points of interest.
\nOptional parameters let you narrow your search results by bounding box or\n country, or bias your search toward a specific position on the globe.
\nYou can search for places near a given position using BiasPosition, or\n filter results within a bounding box using FilterBBox. Providing both\n parameters simultaneously returns an error.
Search results are returned in order of highest to lowest relevance.
", + "smithy.api#documentation": "Geocodes free-form text, such as an address, name, city, or region to allow you to\n search for Places or points of interest.
\nOptional parameters let you narrow your search results by bounding box or country, or\n bias your search toward a specific position on the globe.
\nYou can search for places near a given position using BiasPosition,\n or filter results within a bounding box using FilterBBox. Providing\n both parameters simultaneously returns an error.
Search results are returned in order of highest to lowest relevance.
", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -6024,45 +6033,44 @@ } }, "Text": { - "target": "smithy.api#String", + "target": "com.amazonaws.location#SensitiveString", "traits": { - "smithy.api#documentation": "The address, name,\n city, or region to be used in the search in free-form text format. For example, 123 Any\n Street.
The address, name, city, or region to be used in the search in free-form text format.\n For example, 123 Any Street.
An optional parameter that indicates a preference for places that are closer to a specified position.
\n\n If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the \n second number represents the Y coordinate, or latitude.
\nFor example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and\n latitude 49.2847.
\n BiasPosition and FilterBBox are mutually exclusive. Specifying both options \n results in an error.\n
An optional parameter that indicates a preference for places that are closer to a\n specified position.
\nIf provided, this parameter must contain a pair of numbers. The first number\n represents the X coordinate, or longitude; the second number represents the Y\n coordinate, or latitude.
\nFor example, [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.
\n BiasPosition and FilterBBox are mutually exclusive.\n Specifying both options results in an error.
An optional parameter that limits the search results by returning only places that are within the provided bounding box.
\n\n If provided, this parameter must contain a total of four consecutive numbers in two pairs.\n The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the northeast corner of the bounding box.
\nFor example, [-12.7935, -37.4835, -12.0684, -36.9542] represents\n a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, \n and the northeast corner has longitude -12.0684 and latitude -36.9542.
\n FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.\n
An optional parameter that limits the search results by returning only places that are\n within the provided bounding box.
\nIf provided, this parameter must contain a total of four consecutive numbers in two\n pairs. The first pair of numbers represents the X and Y coordinates (longitude and\n latitude, respectively) of the southwest corner of the bounding box; the second pair of\n numbers represents the X and Y coordinates (longitude and latitude, respectively) of the\n northeast corner of the bounding box.
\nFor example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a\n bounding box where the southwest corner has longitude -12.7935 and latitude\n -37.4835, and the northeast corner has longitude -12.0684\n and latitude -36.9542.
\n FilterBBox and BiasPosition are mutually exclusive.\n Specifying both options results in an error.
An optional parameter that limits the search results by returning only places that are in a specified list of countries.
\nValid values include ISO 3166 3-digit\n country codes. For example, Australia uses three upper-case characters:\n AUS.
An optional parameter that limits the search results by returning only places that are\n in a specified list of countries.
\nValid values include ISO 3166\n 3-digit country codes. For example, Australia uses three upper-case characters:\n AUS.
An optional parameter. The maximum number of results returned per request.
\nThe default: 50\n
An optional parameter. The maximum number of results returned per request.
\nThe default: 50\n
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.
This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.
" + "smithy.api#documentation": "The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.
This setting affects the languages used in the results, but not the results\n themselves. If no language is specified, or not supported for a particular result, the\n partner automatically chooses a language for the result.
\nFor an example, we'll use the Greek language. You search for Athens,\n Greece, with the language parameter set to en. The\n result found will most likely be returned as Athens.
If you set the language parameter to el, for Greek, then the\n result found will more likely be returned as Αθήνα.
If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.
" } } } @@ -6073,14 +6081,14 @@ "Summary": { "target": "com.amazonaws.location#SearchPlaceIndexForTextSummary", "traits": { - "smithy.api#documentation": "Contains a summary of the request. Echoes the input values for BiasPosition,\n FilterBBox, FilterCountries, Language, MaxResults,\n and Text. Also includes the DataSource of the place index and\n the bounding box, ResultBBox, which surrounds the search results.\n
Contains a summary of the request. Echoes the input values for\n BiasPosition, FilterBBox, FilterCountries,\n Language, MaxResults, and Text. Also includes\n the DataSource of the place index and the bounding box,\n ResultBBox, which surrounds the search results.
A list of Places matching the input text. Each result contains additional\n information about the specific point of interest.
", + "smithy.api#documentation": "A list of Places matching the input text. Each result contains additional information\n about the specific point of interest.
\nNot all response properties are included with all responses. Some properties may \n only be returned by specific data partners.
", "smithy.api#required": {} } } @@ -6090,23 +6098,22 @@ "type": "structure", "members": { "Text": { - "target": "smithy.api#String", + "target": "com.amazonaws.location#SensitiveString", "traits": { "smithy.api#documentation": "The search text specified in the request.
", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "Contains the coordinates for the optional bias position specified in the request.
\nThis parameter contains a pair of numbers. The first number represents the X \n coordinate, or longitude; the second number represents the Y coordinate, or latitude.
\nFor example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and latitude 49.2847.
Contains the coordinates for the optional bias position specified in the\n request.
\nThis parameter contains a pair of numbers. The first number represents the X\n coordinate, or longitude; the second number represents the Y coordinate, or\n latitude.
\nFor example, [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.
Contains the coordinates for the optional bounding box specified in the request.
" + "smithy.api#documentation": "Contains the coordinates for the optional bounding box specified in the\n request.
" } }, "FilterCountries": { @@ -6124,20 +6131,20 @@ "ResultBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "The bounding box that fully contains all search results.
\nIf you specified the optional FilterBBox parameter in the request, ResultBBox \n is contained within FilterBBox.
The bounding box that fully contains all search results.
\nIf you specified the optional FilterBBox parameter in the request,\n ResultBBox is contained within FilterBBox.
The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:
\nEsri
\nHere
\nFor more information about data providers, see Amazon Location Service data providers.
", + "smithy.api#documentation": "The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:
\nEsri
\nHere
\nFor more information about data providers, see Amazon Location Service data providers.
", "smithy.api#required": {} } }, "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.
The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.
A summary of the request sent by using SearchPlaceIndexForText.
The name of the time zone, following the \n IANA time zone standard. For example, America/Los_Angeles.
The name of the time zone, following the \n IANA time zone standard. For example,\n America/Los_Angeles.
Information about a time zone. Includes the name of the time zone and the offset\n from UTC in seconds.
" + "smithy.api#documentation": "Information about a time zone. Includes the name of the time zone and the offset from\n UTC in seconds.
" } }, "com.amazonaws.location#Timestamp": { @@ -6638,7 +6651,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "No longer used. If included, the only allowed value is \n RequestBasedUsage.
No longer used. If included, the only allowed value is\n RequestBasedUsage.
No longer used. If included, the only allowed value is \n RequestBasedUsage.
No longer used. If included, the only allowed value is\n RequestBasedUsage.
The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a\n resource across AWS.
\nFormat example: arn:aws:geo:region:account-id:place-\n index/ExamplePlaceIndex\n
The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a\n resource across AWS.
\nFormat example: arn:aws:geo:region:account-id:place-\n index/ExamplePlaceIndex\n
The timestamp for when the place index resource was last updated in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.
No longer used. If included, the only allowed value is \n RequestBasedUsage.
No longer used. If included, the only allowed value is\n RequestBasedUsage.
The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource\n across AWS.
\nFormat example: arn:aws:geo:region:account-id:route-\n calculator/ExampleCalculator\n
The Amazon Resource Name (ARN) of the updated route calculator resource. Used to\n specify a resource across AWS.
\nFormat example: arn:aws:geo:region:account-id:route-\n calculator/ExampleCalculator\n
The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.
\n\n Amazon Aurora\n
\nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
\nThe Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.
\n\n Amazon Aurora\n
\nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account\n must have the correct access privileges.
" + "smithy.api#documentation": "From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts or managing entities. To authorize a datashare for a data consumer,\n the producer account must have the correct access permissions.
" } }, "com.amazonaws.redshift#AuthorizeDataShareMessage": { @@ -1383,7 +1383,7 @@ "DbUser": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "A database user name that is authorized to log on to the database\n DbName using the password DbPassword. If the specified\n DbUser exists in the database, the new user name has the same database privileges as the\n the user named in DbUser. By default, the user is added to PUBLIC. If the\n DbGroups parameter is specifed, DbUser is added to the\n listed groups for any sessions created using these credentials.
A database user name that is authorized to log on to the database DbName\n using the password DbPassword. If the specified DbUser exists in the\n database, the new user name has the same database permissions as the the user named in\n DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter\n is specifed, DbUser is added to the listed groups for any sessions created\n using these credentials.
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
" } + }, + "LoadSampleData": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "A flag that specifies whether to load sample data once the cluster is created.
" + } } }, "traits": { @@ -3724,7 +3730,7 @@ "DataShareAssociations": { "target": "com.amazonaws.redshift#DataShareAssociationList", "traits": { - "smithy.api#documentation": "A value that specifies when the datashare has an association between a producer and data consumers.
" + "smithy.api#documentation": "A value that specifies when the datashare has an association between producer and data\n consumers.
" } }, "ManagedBy": { @@ -3925,7 +3931,7 @@ } ], "traits": { - "smithy.api#documentation": "From the producer account, removes authorization from the specified datashare.
" + "smithy.api#documentation": "From a datashare producer account, removes authorization from the specified datashare.
" } }, "com.amazonaws.redshift#DeauthorizeDataShareMessage": { @@ -7072,7 +7078,7 @@ } ], "traits": { - "smithy.api#documentation": "From a consumer account, remove association for the specified datashare.\n
" + "smithy.api#documentation": "From a datashare consumer account, remove association for the specified datashare.\n
" } }, "com.amazonaws.redshift#DisassociateDataShareConsumerMessage": { @@ -7980,7 +7986,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a database user name and temporary password with temporary authorization to\n log on to an Amazon Redshift database. The action returns the database user name\n prefixed with IAM: if AutoCreate is False or\n IAMA: if AutoCreate is True. You can\n optionally specify one or more database user groups that the user will join at log on.\n By default, the temporary credentials expire in 900 seconds. You can optionally specify\n a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more\n information, see Using IAM Authentication\n to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The Identity and Access Management (IAM) user or role that runs\n GetClusterCredentials must have an IAM policy attached that allows access to all\n necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the\n Amazon Redshift Cluster Management Guide.
\nIf the DbGroups parameter is specified, the IAM policy must allow the\n redshift:JoinGroup action with access to the listed\n dbgroups.
In addition, if the AutoCreate parameter is set to True,\n then the policy must include the redshift:CreateClusterUser\n privilege.
If the DbName parameter is specified, the IAM policy must allow access\n to the resource dbname for the specified database name.
Returns a database user name and temporary password with temporary authorization to\n log on to an Amazon Redshift database. The action returns the database user name\n prefixed with IAM: if AutoCreate is False or\n IAMA: if AutoCreate is True. You can\n optionally specify one or more database user groups that the user will join at log on.\n By default, the temporary credentials expire in 900 seconds. You can optionally specify\n a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more\n information, see Using IAM Authentication\n to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The Identity and Access Management (IAM) user or role that runs\n GetClusterCredentials must have an IAM policy attached that allows access to all\n necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the\n Amazon Redshift Cluster Management Guide.
\nIf the DbGroups parameter is specified, the IAM policy must allow the\n redshift:JoinGroup action with access to the listed\n dbgroups.
In addition, if the AutoCreate parameter is set to True,\n then the policy must include the redshift:CreateClusterUser\n permission.
If the DbName parameter is specified, the IAM policy must allow access\n to the resource dbname for the specified database name.
From the consumer account, rejects the specified datashare.
" + "smithy.api#documentation": "From a datashare consumer account, rejects the specified datashare.
" } }, "com.amazonaws.redshift#RejectDataShareMessage": { diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index ca9f7732014..7d9e12e3854 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -13854,7 +13854,7 @@ } ], "traits": { - "smithy.api#documentation": "Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.
\n\n BatchImportFindings must be called by one of the following:
The account that is associated with the findings. The identifier of the associated\n account is the value of the AwsAccountId attribute for the finding.
An account that is allow-listed for an official Security Hub partner integration.
\nThe maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.
\nAfter a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.
\n Note\n
\n UserDefinedFields\n
\n VerificationState\n
\n Workflow\n
Finding providers also should not use BatchImportFindings to update the following attributes.
\n Confidence\n
\n Criticality\n
\n RelatedFindings\n
\n Severity\n
\n Types\n
Instead, finding providers use FindingProviderFields to provide values for these attributes.
Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.
\n\n BatchImportFindings must be called by one of the following:
The Amazon Web Services account that is associated with a finding if you are using\n the default product ARN \n or are a partner sending findings from within a customer's Amazon Web Services account. \n In these cases, the identifier of the account that you are calling BatchImportFindings \n from needs to be the same as the AwsAccountId attribute for the finding.
An Amazon Web Services account that Security Hub has allow-listed for an official partner\n integration. In this case, you can call BatchImportFindings from the allow-listed\n account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.
\nAfter a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.
\n Note\n
\n UserDefinedFields\n
\n VerificationState\n
\n Workflow\n
Finding providers also should not use BatchImportFindings to update the following attributes.
\n Confidence\n
\n Criticality\n
\n RelatedFindings\n
\n Severity\n
\n Types\n
Instead, finding providers use FindingProviderFields to provide values for these attributes.
Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .
\nWhen you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.
\nFor example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.
The following throttling limits apply to using Security Hub API operations.
\n\n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.
\n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.
\n UpdateFindings - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.
\n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .
\nWhen you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.
\nFor example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.
The following throttling limits apply to using Security Hub API operations.
\n\n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.
\n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.
\n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.