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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--collection-name (string)
The name of the geofence collection.
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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)
No longer used. Always returns
RequestBasedUsage.
PricingPlanDataSource -> (string)
No longer used. Always returns an empty string.
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