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 ]

describe-geofence-collection

Description

Retrieves the geofence collection details.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-geofence-collection
--collection-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--collection-name (string)

The name of the geofence collection.

--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 of the geofence collection.

CreateTime -> (timestamp)

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

Description -> (string)

The optional description for the geofence collection.

KmsKeyId -> (string)

A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource

PricingPlan -> (string)

The pricing plan selected for the specified geofence collection.

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

PricingPlanDataSource -> (string)

The specified data provider for the geofence collection.

Tags -> (map)

Displays the key, value pairs of tags associated with this resource.

key -> (string)

value -> (string)

UpdateTime -> (timestamp)

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