Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Location.CreateGeofenceCollection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a geofence collection, which manages and stores geofences.

Synopsis

data CreateGeofenceCollection = CreateGeofenceCollection' {
- description :: Maybe Text
- kmsKeyId :: Maybe Text
- pricingPlan :: Maybe PricingPlan
- pricingPlanDataSource :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- collectionName :: Text
}
newCreateGeofenceCollection :: Text -> CreateGeofenceCollection
createGeofenceCollection_description :: Lens' CreateGeofenceCollection (Maybe Text)
createGeofenceCollection_kmsKeyId :: Lens' CreateGeofenceCollection (Maybe Text)
createGeofenceCollection_pricingPlan :: Lens' CreateGeofenceCollection (Maybe PricingPlan)
createGeofenceCollection_pricingPlanDataSource :: Lens' CreateGeofenceCollection (Maybe Text)
createGeofenceCollection_tags :: Lens' CreateGeofenceCollection (Maybe (HashMap Text Text))
createGeofenceCollection_collectionName :: Lens' CreateGeofenceCollection Text
data CreateGeofenceCollectionResponse = CreateGeofenceCollectionResponse' {
- httpStatus :: Int
- collectionArn :: Text
- collectionName :: Text
- createTime :: ISO8601
}
newCreateGeofenceCollectionResponse :: Int -> Text -> Text -> UTCTime -> CreateGeofenceCollectionResponse
createGeofenceCollectionResponse_httpStatus :: Lens' CreateGeofenceCollectionResponse Int
createGeofenceCollectionResponse_collectionArn :: Lens' CreateGeofenceCollectionResponse Text
createGeofenceCollectionResponse_collectionName :: Lens' CreateGeofenceCollectionResponse Text
createGeofenceCollectionResponse_createTime :: Lens' CreateGeofenceCollectionResponse UTCTime

Creating a Request

data CreateGeofenceCollection Source #

See: newCreateGeofenceCollection smart constructor.

Constructors

CreateGeofenceCollection'

Fields

description :: Maybe Text
An optional description for the geofence collection.
kmsKeyId :: Maybe Text
A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
pricingPlan :: Maybe PricingPlan
No longer used. If included, the only allowed value is RequestBasedUsage.
pricingPlanDataSource :: Maybe Text
This parameter is no longer used.
tags :: Maybe (HashMap Text Text)
Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
collectionName :: Text
A custom name for the geofence collection.
Requirements:
- Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
- Must be a unique geofence collection name.
- No spaces allowed. For example, ExampleGeofenceCollection.

Instances

Instances details

ToJSON CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods toJSON :: CreateGeofenceCollection -> Value # toEncoding :: CreateGeofenceCollection -> Encoding # toJSONList :: [CreateGeofenceCollection] -> Value # toEncodingList :: [CreateGeofenceCollection] -> Encoding #
ToHeaders CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods toHeaders :: CreateGeofenceCollection -> [Header] #
ToPath CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods toPath :: CreateGeofenceCollection -> ByteString #
ToQuery CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods toQuery :: CreateGeofenceCollection -> QueryString #
AWSRequest CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Associated Types type AWSResponse CreateGeofenceCollection # Methods request :: (Service -> Service) -> CreateGeofenceCollection -> Request CreateGeofenceCollection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateGeofenceCollection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGeofenceCollection))) #
Generic CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Associated Types type Rep CreateGeofenceCollection :: Type -> Type # Methods from :: CreateGeofenceCollection -> Rep CreateGeofenceCollection x # to :: Rep CreateGeofenceCollection x -> CreateGeofenceCollection #
Read CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods readsPrec :: Int -> ReadS CreateGeofenceCollection # readList :: ReadS [CreateGeofenceCollection] # readPrec :: ReadPrec CreateGeofenceCollection # readListPrec :: ReadPrec [CreateGeofenceCollection] #
Show CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods showsPrec :: Int -> CreateGeofenceCollection -> ShowS # show :: CreateGeofenceCollection -> String # showList :: [CreateGeofenceCollection] -> ShowS #
NFData CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods rnf :: CreateGeofenceCollection -> () #
Eq CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods (==) :: CreateGeofenceCollection -> CreateGeofenceCollection -> Bool # (/=) :: CreateGeofenceCollection -> CreateGeofenceCollection -> Bool #
Hashable CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods hashWithSalt :: Int -> CreateGeofenceCollection -> Int # hash :: CreateGeofenceCollection -> Int #
type AWSResponse CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection type AWSResponse CreateGeofenceCollection = CreateGeofenceCollectionResponse
type Rep CreateGeofenceCollection Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection type Rep CreateGeofenceCollection = D1 ('MetaData "CreateGeofenceCollection" "Amazonka.Location.CreateGeofenceCollection" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "CreateGeofenceCollection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pricingPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PricingPlan)))) :: (S1 ('MetaSel ('Just "pricingPlanDataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "collectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateGeofenceCollection Source #

Arguments

:: Text	`CreateGeofenceCollection`
-> CreateGeofenceCollection

Create a value of CreateGeofenceCollection 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:

CreateGeofenceCollection, createGeofenceCollection_description - An optional description for the geofence collection.

$sel:kmsKeyId:CreateGeofenceCollection', createGeofenceCollection_kmsKeyId - A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

CreateGeofenceCollection, createGeofenceCollection_pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

CreateGeofenceCollection, createGeofenceCollection_pricingPlanDataSource - This parameter is no longer used.

$sel:tags:CreateGeofenceCollection', createGeofenceCollection_tags - Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Cannot use "aws:" as a prefix for a key.

CreateGeofenceCollection, createGeofenceCollection_collectionName - A custom name for the geofence collection.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique geofence collection name.
No spaces allowed. For example, ExampleGeofenceCollection.

Request Lenses

createGeofenceCollection_description :: Lens' CreateGeofenceCollection (Maybe Text) Source #

An optional description for the geofence collection.

createGeofenceCollection_kmsKeyId :: Lens' CreateGeofenceCollection (Maybe Text) Source #

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

createGeofenceCollection_pricingPlan :: Lens' CreateGeofenceCollection (Maybe PricingPlan) Source #

No longer used. If included, the only allowed value is RequestBasedUsage.

createGeofenceCollection_pricingPlanDataSource :: Lens' CreateGeofenceCollection (Maybe Text) Source #

This parameter is no longer used.

createGeofenceCollection_tags :: Lens' CreateGeofenceCollection (Maybe (HashMap Text Text)) Source #

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Cannot use "aws:" as a prefix for a key.

createGeofenceCollection_collectionName :: Lens' CreateGeofenceCollection Text Source #

A custom name for the geofence collection.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique geofence collection name.
No spaces allowed. For example, ExampleGeofenceCollection.

Destructuring the Response

data CreateGeofenceCollectionResponse Source #

See: newCreateGeofenceCollectionResponse smart constructor.

Constructors

CreateGeofenceCollectionResponse'

Fields

httpStatus :: Int
The response's http status code.
collectionArn :: Text
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 :: Text
The name for the geofence collection.
createTime :: ISO8601
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Instances

Instances details

Generic CreateGeofenceCollectionResponse Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Associated Types type Rep CreateGeofenceCollectionResponse :: Type -> Type # Methods from :: CreateGeofenceCollectionResponse -> Rep CreateGeofenceCollectionResponse x # to :: Rep CreateGeofenceCollectionResponse x -> CreateGeofenceCollectionResponse #
Read CreateGeofenceCollectionResponse Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods readsPrec :: Int -> ReadS CreateGeofenceCollectionResponse # readList :: ReadS [CreateGeofenceCollectionResponse] # readPrec :: ReadPrec CreateGeofenceCollectionResponse # readListPrec :: ReadPrec [CreateGeofenceCollectionResponse] #
Show CreateGeofenceCollectionResponse Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods showsPrec :: Int -> CreateGeofenceCollectionResponse -> ShowS # show :: CreateGeofenceCollectionResponse -> String # showList :: [CreateGeofenceCollectionResponse] -> ShowS #
NFData CreateGeofenceCollectionResponse Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods rnf :: CreateGeofenceCollectionResponse -> () #
Eq CreateGeofenceCollectionResponse Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection Methods (==) :: CreateGeofenceCollectionResponse -> CreateGeofenceCollectionResponse -> Bool # (/=) :: CreateGeofenceCollectionResponse -> CreateGeofenceCollectionResponse -> Bool #
type Rep CreateGeofenceCollectionResponse Source #
Instance details Defined in Amazonka.Location.CreateGeofenceCollection type Rep CreateGeofenceCollectionResponse = D1 ('MetaData "CreateGeofenceCollectionResponse" "Amazonka.Location.CreateGeofenceCollection" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "CreateGeofenceCollectionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "collectionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "collectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))

newCreateGeofenceCollectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateGeofenceCollectionResponse'`
-> Text	`$sel:collectionArn:CreateGeofenceCollectionResponse'`
-> Text	`CreateGeofenceCollection`
-> UTCTime	`CreateGeofenceCollectionResponse`
-> CreateGeofenceCollectionResponse

Create a value of CreateGeofenceCollectionResponse 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:httpStatus:CreateGeofenceCollectionResponse', createGeofenceCollectionResponse_httpStatus - The response's http status code.

$sel:collectionArn:CreateGeofenceCollectionResponse', createGeofenceCollectionResponse_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

CreateGeofenceCollection, createGeofenceCollectionResponse_collectionName - The name for the geofence collection.

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

Response Lenses

createGeofenceCollectionResponse_httpStatus :: Lens' CreateGeofenceCollectionResponse Int Source #

The response's http status code.

createGeofenceCollectionResponse_collectionArn :: Lens' CreateGeofenceCollectionResponse 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

createGeofenceCollectionResponse_collectionName :: Lens' CreateGeofenceCollectionResponse Text Source #

The name for the geofence collection.

createGeofenceCollectionResponse_createTime :: Lens' CreateGeofenceCollectionResponse UTCTime Source #

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