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 |
Creates a geofence collection, which manages and stores geofences.
Synopsis
- data CreateGeofenceCollection = CreateGeofenceCollection' {}
- newCreateGeofenceCollection :: Text -> PricingPlan -> CreateGeofenceCollection
- createGeofenceCollection_pricingPlanDataSource :: Lens' CreateGeofenceCollection (Maybe Text)
- createGeofenceCollection_kmsKeyId :: Lens' CreateGeofenceCollection (Maybe Text)
- createGeofenceCollection_description :: Lens' CreateGeofenceCollection (Maybe Text)
- createGeofenceCollection_tags :: Lens' CreateGeofenceCollection (Maybe (HashMap Text Text))
- createGeofenceCollection_collectionName :: Lens' CreateGeofenceCollection Text
- createGeofenceCollection_pricingPlan :: Lens' CreateGeofenceCollection PricingPlan
- data CreateGeofenceCollectionResponse = CreateGeofenceCollectionResponse' {
- httpStatus :: Int
- collectionArn :: Text
- collectionName :: Text
- createTime :: POSIX
- 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.
CreateGeofenceCollection' | |
|
Instances
newCreateGeofenceCollection Source #
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:
$sel:pricingPlanDataSource:CreateGeofenceCollection'
, createGeofenceCollection_pricingPlanDataSource
- Specifies the data provider for the geofence collection.
- Required value for the following pricing plans:
MobileAssetTracking
|MobileAssetManagement
For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.
Amazon Location Service only uses PricingPlanDataSource
to calculate
billing for your geofence collection. Your data won't be shared with
the data provider, and will remain in your AWS account or Region unless
you move it.
Valid Values: Esri
| Here
$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.
$sel:description:CreateGeofenceCollection'
, createGeofenceCollection_description
- An optional description for the geofence collection.
$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: + - = . _ : / @.
$sel:collectionName: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
.
$sel:pricingPlan:CreateGeofenceCollection'
, createGeofenceCollection_pricingPlan
- Specifies the pricing plan for the geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
Request Lenses
createGeofenceCollection_pricingPlanDataSource :: Lens' CreateGeofenceCollection (Maybe Text) Source #
Specifies the data provider for the geofence collection.
- Required value for the following pricing plans:
MobileAssetTracking
|MobileAssetManagement
For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.
Amazon Location Service only uses PricingPlanDataSource
to calculate
billing for your geofence collection. Your data won't be shared with
the data provider, and will remain in your AWS account or Region unless
you move it.
Valid Values: Esri
| Here
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_description :: Lens' CreateGeofenceCollection (Maybe Text) Source #
An optional description for the geofence collection.
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: + - = . _ : / @.
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
.
createGeofenceCollection_pricingPlan :: Lens' CreateGeofenceCollection PricingPlan Source #
Specifies the pricing plan for the geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
Destructuring the Response
data CreateGeofenceCollectionResponse Source #
See: newCreateGeofenceCollectionResponse
smart constructor.
CreateGeofenceCollectionResponse' | |
|
Instances
newCreateGeofenceCollectionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> 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
$sel:collectionName:CreateGeofenceCollection'
, createGeofenceCollectionResponse_collectionName
- The name for the geofence collection.
$sel:createTime: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