Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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>]
[--kms-key-id <value>]
--pricing-plan <value>
[--pricing-plan-data-source <value>]
[--tags <value>]
[--cli-input-json <value>]
[--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 (-), periods (.), and underscores (_).
  • Must be a unique geofence collection name.
  • No spaces allowed. For example, ExampleGeofenceCollection .

--description (string)

An optional description for the geofence collection.

--kms-key-id (string)

A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

--pricing-plan (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 .

Possible values:

  • RequestBasedUsage
  • MobileAssetTracking
  • MobileAssetManagement

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

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.

Note

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

--tags (map)

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: + - = . _ : / @.
  • Cannot use "aws:" as a prefix for a key.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.

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

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