| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Location.DescribeGeofenceCollection
Description
Retrieves the geofence collection details.
Synopsis
- data DescribeGeofenceCollection = DescribeGeofenceCollection' {}
- newDescribeGeofenceCollection :: Text -> DescribeGeofenceCollection
- describeGeofenceCollection_collectionName :: Lens' DescribeGeofenceCollection Text
- data DescribeGeofenceCollectionResponse = DescribeGeofenceCollectionResponse' {
- pricingPlanDataSource :: Maybe Text
- kmsKeyId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- collectionArn :: Text
- collectionName :: Text
- createTime :: POSIX
- description :: Text
- pricingPlan :: PricingPlan
- updateTime :: POSIX
- newDescribeGeofenceCollectionResponse :: Int -> Text -> Text -> UTCTime -> Text -> PricingPlan -> UTCTime -> DescribeGeofenceCollectionResponse
- describeGeofenceCollectionResponse_pricingPlanDataSource :: Lens' DescribeGeofenceCollectionResponse (Maybe Text)
- describeGeofenceCollectionResponse_kmsKeyId :: Lens' DescribeGeofenceCollectionResponse (Maybe Text)
- describeGeofenceCollectionResponse_tags :: Lens' DescribeGeofenceCollectionResponse (Maybe (HashMap Text Text))
- describeGeofenceCollectionResponse_httpStatus :: Lens' DescribeGeofenceCollectionResponse Int
- describeGeofenceCollectionResponse_collectionArn :: Lens' DescribeGeofenceCollectionResponse Text
- describeGeofenceCollectionResponse_collectionName :: Lens' DescribeGeofenceCollectionResponse Text
- describeGeofenceCollectionResponse_createTime :: Lens' DescribeGeofenceCollectionResponse UTCTime
- describeGeofenceCollectionResponse_description :: Lens' DescribeGeofenceCollectionResponse Text
- describeGeofenceCollectionResponse_pricingPlan :: Lens' DescribeGeofenceCollectionResponse PricingPlan
- describeGeofenceCollectionResponse_updateTime :: Lens' DescribeGeofenceCollectionResponse UTCTime
Creating a Request
data DescribeGeofenceCollection Source #
See: newDescribeGeofenceCollection smart constructor.
Constructors
| DescribeGeofenceCollection' | |
Fields
| |
Instances
newDescribeGeofenceCollection Source #
Create a value of DescribeGeofenceCollection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionName:DescribeGeofenceCollection', describeGeofenceCollection_collectionName - The name of the geofence collection.
Request Lenses
describeGeofenceCollection_collectionName :: Lens' DescribeGeofenceCollection Text Source #
The name of the geofence collection.
Destructuring the Response
data DescribeGeofenceCollectionResponse Source #
See: newDescribeGeofenceCollectionResponse smart constructor.
Constructors
| DescribeGeofenceCollectionResponse' | |
Fields
| |
Instances
newDescribeGeofenceCollectionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> Text | |
| -> PricingPlan | |
| -> UTCTime | |
| -> DescribeGeofenceCollectionResponse |
Create a value of DescribeGeofenceCollectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pricingPlanDataSource:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_pricingPlanDataSource - The specified data provider for the geofence collection.
$sel:kmsKeyId:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_kmsKeyId - A key identifier for an
AWS KMS customer managed key
assigned to the Amazon Location resource
$sel:tags:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_tags - Displays the key, value pairs of tags associated with this resource.
$sel:httpStatus:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_httpStatus - The response's http status code.
$sel:collectionArn:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_collectionArn - 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
$sel:collectionName:DescribeGeofenceCollection', describeGeofenceCollectionResponse_collectionName - The name of the geofence collection.
$sel:createTime:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_createTime - The timestamp for when the geofence resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
$sel:description:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_description - The optional description for the geofence collection.
$sel:pricingPlan:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_pricingPlan - 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.
$sel:updateTime:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_updateTime - The timestamp for when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
Response Lenses
describeGeofenceCollectionResponse_pricingPlanDataSource :: Lens' DescribeGeofenceCollectionResponse (Maybe Text) Source #
The specified data provider for the geofence collection.
describeGeofenceCollectionResponse_kmsKeyId :: Lens' DescribeGeofenceCollectionResponse (Maybe Text) Source #
A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource
describeGeofenceCollectionResponse_tags :: Lens' DescribeGeofenceCollectionResponse (Maybe (HashMap Text Text)) Source #
Displays the key, value pairs of tags associated with this resource.
describeGeofenceCollectionResponse_httpStatus :: Lens' DescribeGeofenceCollectionResponse Int Source #
The response's http status code.
describeGeofenceCollectionResponse_collectionArn :: Lens' DescribeGeofenceCollectionResponse Text Source #
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
describeGeofenceCollectionResponse_collectionName :: Lens' DescribeGeofenceCollectionResponse Text Source #
The name of the geofence collection.
describeGeofenceCollectionResponse_createTime :: Lens' DescribeGeofenceCollectionResponse UTCTime Source #
The timestamp for when the geofence resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
describeGeofenceCollectionResponse_description :: Lens' DescribeGeofenceCollectionResponse Text Source #
The optional description for the geofence collection.
describeGeofenceCollectionResponse_pricingPlan :: Lens' DescribeGeofenceCollectionResponse PricingPlan Source #
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.
describeGeofenceCollectionResponse_updateTime :: Lens' DescribeGeofenceCollectionResponse UTCTime Source #
The timestamp for when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ