{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.Location.DescribeGeofenceCollection -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Retrieves the geofence collection details. module Amazonka.Location.DescribeGeofenceCollection ( -- * Creating a Request DescribeGeofenceCollection (..), newDescribeGeofenceCollection, -- * Request Lenses describeGeofenceCollection_collectionName, -- * Destructuring the Response DescribeGeofenceCollectionResponse (..), newDescribeGeofenceCollectionResponse, -- * Response Lenses describeGeofenceCollectionResponse_kmsKeyId, describeGeofenceCollectionResponse_pricingPlan, describeGeofenceCollectionResponse_pricingPlanDataSource, describeGeofenceCollectionResponse_tags, describeGeofenceCollectionResponse_httpStatus, describeGeofenceCollectionResponse_collectionArn, describeGeofenceCollectionResponse_collectionName, describeGeofenceCollectionResponse_createTime, describeGeofenceCollectionResponse_description, describeGeofenceCollectionResponse_updateTime, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.Location.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDescribeGeofenceCollection' smart constructor. data DescribeGeofenceCollection = DescribeGeofenceCollection' { -- | The name of the geofence collection. collectionName :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeGeofenceCollection' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'collectionName', 'describeGeofenceCollection_collectionName' - The name of the geofence collection. newDescribeGeofenceCollection :: -- | 'collectionName' Prelude.Text -> DescribeGeofenceCollection newDescribeGeofenceCollection pCollectionName_ = DescribeGeofenceCollection' { collectionName = pCollectionName_ } -- | The name of the geofence collection. describeGeofenceCollection_collectionName :: Lens.Lens' DescribeGeofenceCollection Prelude.Text describeGeofenceCollection_collectionName = Lens.lens (\DescribeGeofenceCollection' {collectionName} -> collectionName) (\s@DescribeGeofenceCollection' {} a -> s {collectionName = a} :: DescribeGeofenceCollection) instance Core.AWSRequest DescribeGeofenceCollection where type AWSResponse DescribeGeofenceCollection = DescribeGeofenceCollectionResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeGeofenceCollectionResponse' Prelude.<$> (x Data..?> "KmsKeyId") Prelude.<*> (x Data..?> "PricingPlan") Prelude.<*> (x Data..?> "PricingPlanDataSource") Prelude.<*> (x Data..?> "Tags" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> (x Data..:> "CollectionArn") Prelude.<*> (x Data..:> "CollectionName") Prelude.<*> (x Data..:> "CreateTime") Prelude.<*> (x Data..:> "Description") Prelude.<*> (x Data..:> "UpdateTime") ) instance Prelude.Hashable DescribeGeofenceCollection where hashWithSalt _salt DescribeGeofenceCollection' {..} = _salt `Prelude.hashWithSalt` collectionName instance Prelude.NFData DescribeGeofenceCollection where rnf DescribeGeofenceCollection' {..} = Prelude.rnf collectionName instance Data.ToHeaders DescribeGeofenceCollection where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToPath DescribeGeofenceCollection where toPath DescribeGeofenceCollection' {..} = Prelude.mconcat [ "/geofencing/v0/collections/", Data.toBS collectionName ] instance Data.ToQuery DescribeGeofenceCollection where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeGeofenceCollectionResponse' smart constructor. data DescribeGeofenceCollectionResponse = DescribeGeofenceCollectionResponse' { -- | A key identifier for an -- -- assigned to the Amazon Location resource kmsKeyId :: Prelude.Maybe Prelude.Text, -- | No longer used. Always returns @RequestBasedUsage@. pricingPlan :: Prelude.Maybe PricingPlan, -- | No longer used. Always returns an empty string. pricingPlanDataSource :: Prelude.Maybe Prelude.Text, -- | Displays the key, value pairs of tags associated with this resource. tags :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text), -- | The response's http status code. httpStatus :: Prelude.Int, -- | 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@ collectionArn :: Prelude.Text, -- | The name of the geofence collection. collectionName :: Prelude.Text, -- | The timestamp for when the geofence resource was created in -- -- format: @YYYY-MM-DDThh:mm:ss.sssZ@ createTime :: Data.ISO8601, -- | The optional description for the geofence collection. description :: Prelude.Text, -- | The timestamp for when the geofence collection was last updated in -- -- format: @YYYY-MM-DDThh:mm:ss.sssZ@ updateTime :: Data.ISO8601 } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeGeofenceCollectionResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'kmsKeyId', 'describeGeofenceCollectionResponse_kmsKeyId' - A key identifier for an -- -- assigned to the Amazon Location resource -- -- 'pricingPlan', 'describeGeofenceCollectionResponse_pricingPlan' - No longer used. Always returns @RequestBasedUsage@. -- -- 'pricingPlanDataSource', 'describeGeofenceCollectionResponse_pricingPlanDataSource' - No longer used. Always returns an empty string. -- -- 'tags', 'describeGeofenceCollectionResponse_tags' - Displays the key, value pairs of tags associated with this resource. -- -- 'httpStatus', 'describeGeofenceCollectionResponse_httpStatus' - The response's http status code. -- -- 'collectionArn', '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@ -- -- 'collectionName', 'describeGeofenceCollectionResponse_collectionName' - The name of the geofence collection. -- -- 'createTime', 'describeGeofenceCollectionResponse_createTime' - The timestamp for when the geofence resource was created in -- -- format: @YYYY-MM-DDThh:mm:ss.sssZ@ -- -- 'description', 'describeGeofenceCollectionResponse_description' - The optional description for the geofence collection. -- -- 'updateTime', 'describeGeofenceCollectionResponse_updateTime' - The timestamp for when the geofence collection was last updated in -- -- format: @YYYY-MM-DDThh:mm:ss.sssZ@ newDescribeGeofenceCollectionResponse :: -- | 'httpStatus' Prelude.Int -> -- | 'collectionArn' Prelude.Text -> -- | 'collectionName' Prelude.Text -> -- | 'createTime' Prelude.UTCTime -> -- | 'description' Prelude.Text -> -- | 'updateTime' Prelude.UTCTime -> DescribeGeofenceCollectionResponse newDescribeGeofenceCollectionResponse pHttpStatus_ pCollectionArn_ pCollectionName_ pCreateTime_ pDescription_ pUpdateTime_ = DescribeGeofenceCollectionResponse' { kmsKeyId = Prelude.Nothing, pricingPlan = Prelude.Nothing, pricingPlanDataSource = Prelude.Nothing, tags = Prelude.Nothing, httpStatus = pHttpStatus_, collectionArn = pCollectionArn_, collectionName = pCollectionName_, createTime = Data._Time Lens.# pCreateTime_, description = pDescription_, updateTime = Data._Time Lens.# pUpdateTime_ } -- | A key identifier for an -- -- assigned to the Amazon Location resource describeGeofenceCollectionResponse_kmsKeyId :: Lens.Lens' DescribeGeofenceCollectionResponse (Prelude.Maybe Prelude.Text) describeGeofenceCollectionResponse_kmsKeyId = Lens.lens (\DescribeGeofenceCollectionResponse' {kmsKeyId} -> kmsKeyId) (\s@DescribeGeofenceCollectionResponse' {} a -> s {kmsKeyId = a} :: DescribeGeofenceCollectionResponse) -- | No longer used. Always returns @RequestBasedUsage@. describeGeofenceCollectionResponse_pricingPlan :: Lens.Lens' DescribeGeofenceCollectionResponse (Prelude.Maybe PricingPlan) describeGeofenceCollectionResponse_pricingPlan = Lens.lens (\DescribeGeofenceCollectionResponse' {pricingPlan} -> pricingPlan) (\s@DescribeGeofenceCollectionResponse' {} a -> s {pricingPlan = a} :: DescribeGeofenceCollectionResponse) -- | No longer used. Always returns an empty string. describeGeofenceCollectionResponse_pricingPlanDataSource :: Lens.Lens' DescribeGeofenceCollectionResponse (Prelude.Maybe Prelude.Text) describeGeofenceCollectionResponse_pricingPlanDataSource = Lens.lens (\DescribeGeofenceCollectionResponse' {pricingPlanDataSource} -> pricingPlanDataSource) (\s@DescribeGeofenceCollectionResponse' {} a -> s {pricingPlanDataSource = a} :: DescribeGeofenceCollectionResponse) -- | Displays the key, value pairs of tags associated with this resource. describeGeofenceCollectionResponse_tags :: Lens.Lens' DescribeGeofenceCollectionResponse (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) describeGeofenceCollectionResponse_tags = Lens.lens (\DescribeGeofenceCollectionResponse' {tags} -> tags) (\s@DescribeGeofenceCollectionResponse' {} a -> s {tags = a} :: DescribeGeofenceCollectionResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. describeGeofenceCollectionResponse_httpStatus :: Lens.Lens' DescribeGeofenceCollectionResponse Prelude.Int describeGeofenceCollectionResponse_httpStatus = Lens.lens (\DescribeGeofenceCollectionResponse' {httpStatus} -> httpStatus) (\s@DescribeGeofenceCollectionResponse' {} a -> s {httpStatus = a} :: DescribeGeofenceCollectionResponse) -- | 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_collectionArn :: Lens.Lens' DescribeGeofenceCollectionResponse Prelude.Text describeGeofenceCollectionResponse_collectionArn = Lens.lens (\DescribeGeofenceCollectionResponse' {collectionArn} -> collectionArn) (\s@DescribeGeofenceCollectionResponse' {} a -> s {collectionArn = a} :: DescribeGeofenceCollectionResponse) -- | The name of the geofence collection. describeGeofenceCollectionResponse_collectionName :: Lens.Lens' DescribeGeofenceCollectionResponse Prelude.Text describeGeofenceCollectionResponse_collectionName = Lens.lens (\DescribeGeofenceCollectionResponse' {collectionName} -> collectionName) (\s@DescribeGeofenceCollectionResponse' {} a -> s {collectionName = a} :: DescribeGeofenceCollectionResponse) -- | The timestamp for when the geofence resource was created in -- -- format: @YYYY-MM-DDThh:mm:ss.sssZ@ describeGeofenceCollectionResponse_createTime :: Lens.Lens' DescribeGeofenceCollectionResponse Prelude.UTCTime describeGeofenceCollectionResponse_createTime = Lens.lens (\DescribeGeofenceCollectionResponse' {createTime} -> createTime) (\s@DescribeGeofenceCollectionResponse' {} a -> s {createTime = a} :: DescribeGeofenceCollectionResponse) Prelude.. Data._Time -- | The optional description for the geofence collection. describeGeofenceCollectionResponse_description :: Lens.Lens' DescribeGeofenceCollectionResponse Prelude.Text describeGeofenceCollectionResponse_description = Lens.lens (\DescribeGeofenceCollectionResponse' {description} -> description) (\s@DescribeGeofenceCollectionResponse' {} a -> s {description = a} :: DescribeGeofenceCollectionResponse) -- | The timestamp for when the geofence collection was last updated in -- -- format: @YYYY-MM-DDThh:mm:ss.sssZ@ describeGeofenceCollectionResponse_updateTime :: Lens.Lens' DescribeGeofenceCollectionResponse Prelude.UTCTime describeGeofenceCollectionResponse_updateTime = Lens.lens (\DescribeGeofenceCollectionResponse' {updateTime} -> updateTime) (\s@DescribeGeofenceCollectionResponse' {} a -> s {updateTime = a} :: DescribeGeofenceCollectionResponse) Prelude.. Data._Time instance Prelude.NFData DescribeGeofenceCollectionResponse where rnf DescribeGeofenceCollectionResponse' {..} = Prelude.rnf kmsKeyId `Prelude.seq` Prelude.rnf pricingPlan `Prelude.seq` Prelude.rnf pricingPlanDataSource `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf collectionArn `Prelude.seq` Prelude.rnf collectionName `Prelude.seq` Prelude.rnf createTime `Prelude.seq` Prelude.rnf description `Prelude.seq` Prelude.rnf updateTime