[ aws . location ]

create-geofence-collection

Description

Creates a geofence collection, which manages and stores geofences.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--collection-name (string)

A custom name for the geofence collection.

Requirements:

  • Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), and underscores (_).

  • Must be a unique geofence collection name.

  • No spaces allowed. For example, ExampleGeofenceCollection .

--description (string)

An optional description for the geofence collection.

--pricing-plan (string)

Specifies the pricing plan for your geofence collection. There’s three pricing plan options:

  • RequestBasedUsage — Selects the “Request-Based Usage” pricing plan.

  • MobileAssetTracking — Selects the “Mobile Asset Tracking” pricing plan.

  • MobileAssetManagement — Selects the “Mobile Asset Management” pricing plan.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

Possible values:

  • RequestBasedUsage

  • MobileAssetTracking

  • MobileAssetManagement

--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) for the geofence collection resource. Used when you need to specify a resource across all AWS.

CollectionName -> (string)

The name for the geofence collection.

CreateTime -> (timestamp)

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ