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.CreatePlaceIndex

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider.

Synopsis

data CreatePlaceIndex = CreatePlaceIndex' {
- dataSourceConfiguration :: Maybe DataSourceConfiguration
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- dataSource :: Text
- indexName :: Text
- pricingPlan :: PricingPlan
}
newCreatePlaceIndex :: Text -> Text -> PricingPlan -> CreatePlaceIndex
createPlaceIndex_dataSourceConfiguration :: Lens' CreatePlaceIndex (Maybe DataSourceConfiguration)
createPlaceIndex_description :: Lens' CreatePlaceIndex (Maybe Text)
createPlaceIndex_tags :: Lens' CreatePlaceIndex (Maybe (HashMap Text Text))
createPlaceIndex_dataSource :: Lens' CreatePlaceIndex Text
createPlaceIndex_indexName :: Lens' CreatePlaceIndex Text
createPlaceIndex_pricingPlan :: Lens' CreatePlaceIndex PricingPlan
data CreatePlaceIndexResponse = CreatePlaceIndexResponse' {
- httpStatus :: Int
- createTime :: POSIX
- indexArn :: Text
- indexName :: Text
}
newCreatePlaceIndexResponse :: Int -> UTCTime -> Text -> Text -> CreatePlaceIndexResponse
createPlaceIndexResponse_httpStatus :: Lens' CreatePlaceIndexResponse Int
createPlaceIndexResponse_createTime :: Lens' CreatePlaceIndexResponse UTCTime
createPlaceIndexResponse_indexArn :: Lens' CreatePlaceIndexResponse Text
createPlaceIndexResponse_indexName :: Lens' CreatePlaceIndexResponse Text

Creating a Request

data CreatePlaceIndex Source #

See: newCreatePlaceIndex smart constructor.

Constructors

CreatePlaceIndex'

Fields

dataSourceConfiguration :: Maybe DataSourceConfiguration
Specifies the data storage option requesting Places.
description :: Maybe Text
The optional description for the place index resource.
tags :: Maybe (HashMap Text Text)
Applies one or more tags to the place index resource. 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: + - = . _ : / @.
dataSource :: Text
Specifies the data provider of geospatial data.
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
Valid values include:
- Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.
- Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.
  Place index resources using HERE Technologies as a data provider can't store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
indexName :: Text
The name of the place index resource.
Requirements:
- Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
- Must be a unique place index resource name.
- No spaces allowed. For example, ExamplePlaceIndex.
pricingPlan :: PricingPlan
Specifies the pricing plan for your place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Instances

Instances details

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

newCreatePlaceIndex Source #

Arguments

:: Text	`$sel:dataSource:CreatePlaceIndex'`
-> Text	`$sel:indexName:CreatePlaceIndex'`
-> PricingPlan	`$sel:pricingPlan:CreatePlaceIndex'`
-> CreatePlaceIndex

Create a value of CreatePlaceIndex 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:dataSourceConfiguration:CreatePlaceIndex', createPlaceIndex_dataSourceConfiguration - Specifies the data storage option requesting Places.

$sel:description:CreatePlaceIndex', createPlaceIndex_description - The optional description for the place index resource.

$sel:tags:CreatePlaceIndex', createPlaceIndex_tags - Applies one or more tags to the place index resource. 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:dataSource:CreatePlaceIndex', createPlaceIndex_dataSource - Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.
Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.
Place index resources using HERE Technologies as a data provider can't store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

$sel:indexName:CreatePlaceIndex', createPlaceIndex_indexName - The name of the place index resource.

Requirements:

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

$sel:pricingPlan:CreatePlaceIndex', createPlaceIndex_pricingPlan - Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Request Lenses

createPlaceIndex_dataSourceConfiguration :: Lens' CreatePlaceIndex (Maybe DataSourceConfiguration) Source #

Specifies the data storage option requesting Places.

createPlaceIndex_description :: Lens' CreatePlaceIndex (Maybe Text) Source #

The optional description for the place index resource.

createPlaceIndex_tags :: Lens' CreatePlaceIndex (Maybe (HashMap Text Text)) Source #

Applies one or more tags to the place index resource. 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: + - = . _ : / @.

createPlaceIndex_dataSource :: Lens' CreatePlaceIndex Text Source #

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.
Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.
Place index resources using HERE Technologies as a data provider can't store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

createPlaceIndex_indexName :: Lens' CreatePlaceIndex Text Source #

The name of the place index resource.

Requirements:

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

createPlaceIndex_pricingPlan :: Lens' CreatePlaceIndex PricingPlan Source #

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Destructuring the Response

data CreatePlaceIndexResponse Source #

See: newCreatePlaceIndexResponse smart constructor.

Constructors

CreatePlaceIndexResponse'

Fields

httpStatus :: Int
The response's http status code.
createTime :: POSIX
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
indexArn :: Text
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
indexName :: Text
The name for the place index resource.

Instances

Instances details

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

newCreatePlaceIndexResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreatePlaceIndexResponse'`
-> UTCTime	`$sel:createTime:CreatePlaceIndexResponse'`
-> Text	`$sel:indexArn:CreatePlaceIndexResponse'`
-> Text	`$sel:indexName:CreatePlaceIndex'`
-> CreatePlaceIndexResponse

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

$sel:createTime:CreatePlaceIndexResponse', createPlaceIndexResponse_createTime - The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

$sel:indexArn:CreatePlaceIndexResponse', createPlaceIndexResponse_indexArn - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

$sel:indexName:CreatePlaceIndex', createPlaceIndexResponse_indexName - The name for the place index resource.

Response Lenses

createPlaceIndexResponse_httpStatus :: Lens' CreatePlaceIndexResponse Int Source #

The response's http status code.

createPlaceIndexResponse_createTime :: Lens' CreatePlaceIndexResponse UTCTime Source #

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

createPlaceIndexResponse_indexArn :: Lens' CreatePlaceIndexResponse Text Source #

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

createPlaceIndexResponse_indexName :: Lens' CreatePlaceIndexResponse Text Source #

The name for the place index resource.