[ aws . location ]

update-geofence-collection

Description

Updates the specified properties of a given geofence collection.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-geofence-collection
--collection-name <value>
[--description <value>]
[--pricing-plan <value>]
[--pricing-plan-data-source <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--collection-name (string)

The name of the geofence collection to update.

--description (string)

Updates the description for the geofence collection.

--pricing-plan (string)

Updates the pricing plan for the geofence collection.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing .

Possible values:

  • RequestBasedUsage

  • MobileAssetTracking

  • MobileAssetManagement

--pricing-plan-data-source (string)

Updates the data provider for the geofence collection.

A required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about data providers and pricing plans , see the Amazon Location Service product page.

Note

This can only be updated when updating the PricingPlan in the same request.

Amazon Location Service uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won’t be shared with the data provider, and will remain in your AWS account and Region unless you move it.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

CollectionArn -> (string)

The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across AWS.

  • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

CollectionName -> (string)

The name of the updated geofence collection.

UpdateTime -> (timestamp)

The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ