/AWS1/CL_LOCDSCGEOFENCECOLLRSP¶
DescribeGeofenceCollectionResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_COLLECTIONNAME TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME¶
The name of the geofence collection.
IV_COLLECTIONARN TYPE /AWS1/LOCARN /AWS1/LOCARN¶
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.
Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
IV_DESCRIPTION TYPE /AWS1/LOCRESOURCEDESCRIPTION /AWS1/LOCRESOURCEDESCRIPTION¶
The optional description for the geofence collection.
IV_CREATETIME TYPE /AWS1/LOCTIMESTAMP /AWS1/LOCTIMESTAMP¶
The timestamp for when the geofence resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
IV_UPDATETIME TYPE /AWS1/LOCTIMESTAMP /AWS1/LOCTIMESTAMP¶
The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Optional arguments:¶
IV_PRICINGPLAN TYPE /AWS1/LOCPRICINGPLAN /AWS1/LOCPRICINGPLAN¶
No longer used. Always returns
RequestBasedUsage.
IV_PRICINGPLANDATASOURCE TYPE /AWS1/LOCSTRING /AWS1/LOCSTRING¶
No longer used. Always returns an empty string.
IV_KMSKEYID TYPE /AWS1/LOCKMSKEYID /AWS1/LOCKMSKEYID¶
A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource
IT_TAGS TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
Displays the key, value pairs of tags associated with this resource.
IV_GEOFENCECOUNT TYPE /AWS1/LOCINTEGER /AWS1/LOCINTEGER¶
The number of geofences in the geofence collection.
Queryable Attributes¶
CollectionName¶
The name of the geofence collection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COLLECTIONNAME() |
Getter for COLLECTIONNAME, with configurable default |
ASK_COLLECTIONNAME() |
Getter for COLLECTIONNAME w/ exceptions if field has no valu |
HAS_COLLECTIONNAME() |
Determine if COLLECTIONNAME has a value |
CollectionArn¶
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.
Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COLLECTIONARN() |
Getter for COLLECTIONARN, with configurable default |
ASK_COLLECTIONARN() |
Getter for COLLECTIONARN w/ exceptions if field has no value |
HAS_COLLECTIONARN() |
Determine if COLLECTIONARN has a value |
Description¶
The optional description for the geofence collection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
PricingPlan¶
No longer used. Always returns
RequestBasedUsage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRICINGPLAN() |
Getter for PRICINGPLAN, with configurable default |
ASK_PRICINGPLAN() |
Getter for PRICINGPLAN w/ exceptions if field has no value |
HAS_PRICINGPLAN() |
Determine if PRICINGPLAN has a value |
PricingPlanDataSource¶
No longer used. Always returns an empty string.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRICINGPLANDATASOURCE() |
Getter for PRICINGPLANDATASOURCE, with configurable default |
ASK_PRICINGPLANDATASOURCE() |
Getter for PRICINGPLANDATASOURCE w/ exceptions if field has |
HAS_PRICINGPLANDATASOURCE() |
Determine if PRICINGPLANDATASOURCE has a value |
KmsKeyId¶
A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYID() |
Getter for KMSKEYID, with configurable default |
ASK_KMSKEYID() |
Getter for KMSKEYID w/ exceptions if field has no value |
HAS_KMSKEYID() |
Determine if KMSKEYID has a value |
Tags¶
Displays the key, value pairs of tags associated with this resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
CreateTime¶
The timestamp for when the geofence resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATETIME() |
Getter for CREATETIME, with configurable default |
ASK_CREATETIME() |
Getter for CREATETIME w/ exceptions if field has no value |
HAS_CREATETIME() |
Determine if CREATETIME has a value |
UpdateTime¶
The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATETIME() |
Getter for UPDATETIME, with configurable default |
ASK_UPDATETIME() |
Getter for UPDATETIME w/ exceptions if field has no value |
HAS_UPDATETIME() |
Determine if UPDATETIME has a value |
GeofenceCount¶
The number of geofences in the geofence collection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GEOFENCECOUNT() |
Getter for GEOFENCECOUNT, with configurable default |
ASK_GEOFENCECOUNT() |
Getter for GEOFENCECOUNT w/ exceptions if field has no value |
HAS_GEOFENCECOUNT() |
Determine if GEOFENCECOUNT has a value |