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.SageMakerGeoSpatial.StartVectorEnrichmentJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.

Synopsis

Creating a Request

data StartVectorEnrichmentJob Source #

See: newStartVectorEnrichmentJob smart constructor.

Constructors

StartVectorEnrichmentJob'

Fields

clientToken :: Maybe Text
A unique token that guarantees that the call to this API is idempotent.
kmsKeyId :: Maybe Text
The Amazon Key Management Service (KMS) key ID for server-side encryption.
tags :: Maybe (HashMap Text Text)
Each tag consists of a key and a value.
executionRoleArn :: Text
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
inputConfig :: VectorEnrichmentJobInputConfig
Input configuration information for the Vector Enrichment job.
jobConfig :: VectorEnrichmentJobConfig
An object containing information about the job configuration.
name :: Text
The name of the Vector Enrichment job.

Instances

Instances details

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

newStartVectorEnrichmentJob Source #

Arguments

:: Text	`StartVectorEnrichmentJob`
-> VectorEnrichmentJobInputConfig	`StartVectorEnrichmentJob`
-> VectorEnrichmentJobConfig	`StartVectorEnrichmentJob`
-> Text	`StartVectorEnrichmentJob`
-> StartVectorEnrichmentJob

Create a value of StartVectorEnrichmentJob 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:clientToken:StartVectorEnrichmentJob', startVectorEnrichmentJob_clientToken - A unique token that guarantees that the call to this API is idempotent.

StartVectorEnrichmentJob, startVectorEnrichmentJob_kmsKeyId - The Amazon Key Management Service (KMS) key ID for server-side encryption.

StartVectorEnrichmentJob, startVectorEnrichmentJob_tags - Each tag consists of a key and a value.

StartVectorEnrichmentJob, startVectorEnrichmentJob_executionRoleArn - The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

StartVectorEnrichmentJob, startVectorEnrichmentJob_inputConfig - Input configuration information for the Vector Enrichment job.

StartVectorEnrichmentJob, startVectorEnrichmentJob_jobConfig - An object containing information about the job configuration.

StartVectorEnrichmentJob, startVectorEnrichmentJob_name - The name of the Vector Enrichment job.

Request Lenses

startVectorEnrichmentJob_clientToken :: Lens' StartVectorEnrichmentJob (Maybe Text) Source #

A unique token that guarantees that the call to this API is idempotent.

startVectorEnrichmentJob_kmsKeyId :: Lens' StartVectorEnrichmentJob (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

startVectorEnrichmentJob_tags :: Lens' StartVectorEnrichmentJob (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

startVectorEnrichmentJob_executionRoleArn :: Lens' StartVectorEnrichmentJob Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

startVectorEnrichmentJob_inputConfig :: Lens' StartVectorEnrichmentJob VectorEnrichmentJobInputConfig Source #

Input configuration information for the Vector Enrichment job.

startVectorEnrichmentJob_jobConfig :: Lens' StartVectorEnrichmentJob VectorEnrichmentJobConfig Source #

An object containing information about the job configuration.

startVectorEnrichmentJob_name :: Lens' StartVectorEnrichmentJob Text Source #

The name of the Vector Enrichment job.

Destructuring the Response

data StartVectorEnrichmentJobResponse Source #

See: newStartVectorEnrichmentJobResponse smart constructor.

Constructors

StartVectorEnrichmentJobResponse'

Fields

kmsKeyId :: Maybe Text
The Amazon Key Management Service (KMS) key ID for server-side encryption.
tags :: Maybe (HashMap Text Text)
Each tag consists of a key and a value.
httpStatus :: Int
The response's http status code.
arn :: Text
The Amazon Resource Name (ARN) of the Vector Enrichment job.
creationTime :: POSIX
The creation time.
durationInSeconds :: Int
The duration of the Vector Enrichment job, in seconds.
executionRoleArn :: Text
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
inputConfig :: VectorEnrichmentJobInputConfig
Input configuration information for starting the Vector Enrichment job.
jobConfig :: VectorEnrichmentJobConfig
An object containing information about the job configuration.
name :: Text
The name of the Vector Enrichment job.
status :: VectorEnrichmentJobStatus
The status of the Vector Enrichment job being started.
type' :: VectorEnrichmentJobType
The type of the Vector Enrichment job.

Instances

Instances details

Generic StartVectorEnrichmentJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartVectorEnrichmentJob Associated Types type Rep StartVectorEnrichmentJobResponse :: Type -> Type # Methods from :: StartVectorEnrichmentJobResponse -> Rep StartVectorEnrichmentJobResponse x # to :: Rep StartVectorEnrichmentJobResponse x -> StartVectorEnrichmentJobResponse #
Read StartVectorEnrichmentJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartVectorEnrichmentJob Methods readsPrec :: Int -> ReadS StartVectorEnrichmentJobResponse # readList :: ReadS [StartVectorEnrichmentJobResponse] # readPrec :: ReadPrec StartVectorEnrichmentJobResponse # readListPrec :: ReadPrec [StartVectorEnrichmentJobResponse] #
Show StartVectorEnrichmentJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartVectorEnrichmentJob Methods showsPrec :: Int -> StartVectorEnrichmentJobResponse -> ShowS # show :: StartVectorEnrichmentJobResponse -> String # showList :: [StartVectorEnrichmentJobResponse] -> ShowS #
NFData StartVectorEnrichmentJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartVectorEnrichmentJob Methods rnf :: StartVectorEnrichmentJobResponse -> () #
Eq StartVectorEnrichmentJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartVectorEnrichmentJob Methods (==) :: StartVectorEnrichmentJobResponse -> StartVectorEnrichmentJobResponse -> Bool # (/=) :: StartVectorEnrichmentJobResponse -> StartVectorEnrichmentJobResponse -> Bool #
type Rep StartVectorEnrichmentJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartVectorEnrichmentJob type Rep StartVectorEnrichmentJobResponse = D1 ('MetaData "StartVectorEnrichmentJobResponse" "Amazonka.SageMakerGeoSpatial.StartVectorEnrichmentJob" "amazonka-sagemaker-geospatial-2.0-Fg7YtbyXAZrLwLaIITXFtu" 'False) (C1 ('MetaCons "StartVectorEnrichmentJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "durationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :: ((S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "inputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VectorEnrichmentJobInputConfig) :: S1 ('MetaSel ('Just "jobConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VectorEnrichmentJobConfig))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VectorEnrichmentJobStatus) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VectorEnrichmentJobType))))))

newStartVectorEnrichmentJobResponse Source #

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

StartVectorEnrichmentJob, startVectorEnrichmentJobResponse_kmsKeyId - The Amazon Key Management Service (KMS) key ID for server-side encryption.

StartVectorEnrichmentJob, startVectorEnrichmentJobResponse_tags - Each tag consists of a key and a value.

$sel:httpStatus:StartVectorEnrichmentJobResponse', startVectorEnrichmentJobResponse_httpStatus - The response's http status code.

StartVectorEnrichmentJobResponse, startVectorEnrichmentJobResponse_arn - The Amazon Resource Name (ARN) of the Vector Enrichment job.

StartVectorEnrichmentJobResponse, startVectorEnrichmentJobResponse_creationTime - The creation time.

StartVectorEnrichmentJobResponse, startVectorEnrichmentJobResponse_durationInSeconds - The duration of the Vector Enrichment job, in seconds.

StartVectorEnrichmentJob, startVectorEnrichmentJobResponse_executionRoleArn - The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

StartVectorEnrichmentJob, startVectorEnrichmentJobResponse_inputConfig - Input configuration information for starting the Vector Enrichment job.

StartVectorEnrichmentJob, startVectorEnrichmentJobResponse_jobConfig - An object containing information about the job configuration.

StartVectorEnrichmentJob, startVectorEnrichmentJobResponse_name - The name of the Vector Enrichment job.

StartVectorEnrichmentJobResponse, startVectorEnrichmentJobResponse_status - The status of the Vector Enrichment job being started.

StartVectorEnrichmentJobResponse, startVectorEnrichmentJobResponse_type - The type of the Vector Enrichment job.

Response Lenses

startVectorEnrichmentJobResponse_kmsKeyId :: Lens' StartVectorEnrichmentJobResponse (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

startVectorEnrichmentJobResponse_tags :: Lens' StartVectorEnrichmentJobResponse (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

startVectorEnrichmentJobResponse_httpStatus :: Lens' StartVectorEnrichmentJobResponse Int Source #

The response's http status code.

startVectorEnrichmentJobResponse_arn :: Lens' StartVectorEnrichmentJobResponse Text Source #

The Amazon Resource Name (ARN) of the Vector Enrichment job.

startVectorEnrichmentJobResponse_creationTime :: Lens' StartVectorEnrichmentJobResponse UTCTime Source #

The creation time.

startVectorEnrichmentJobResponse_durationInSeconds :: Lens' StartVectorEnrichmentJobResponse Int Source #

The duration of the Vector Enrichment job, in seconds.

startVectorEnrichmentJobResponse_executionRoleArn :: Lens' StartVectorEnrichmentJobResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

startVectorEnrichmentJobResponse_inputConfig :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobInputConfig Source #

Input configuration information for starting the Vector Enrichment job.

startVectorEnrichmentJobResponse_jobConfig :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobConfig Source #

An object containing information about the job configuration.

startVectorEnrichmentJobResponse_name :: Lens' StartVectorEnrichmentJobResponse Text Source #

The name of the Vector Enrichment job.

startVectorEnrichmentJobResponse_status :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobStatus Source #

The status of the Vector Enrichment job being started.

startVectorEnrichmentJobResponse_type :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobType Source #

The type of the Vector Enrichment job.

:: Int	`$sel:httpStatus:StartVectorEnrichmentJobResponse'`
-> Text	`StartVectorEnrichmentJobResponse`
-> UTCTime	`StartVectorEnrichmentJobResponse`
-> Int	`StartVectorEnrichmentJobResponse`
-> Text	`StartVectorEnrichmentJob`
-> VectorEnrichmentJobInputConfig	`StartVectorEnrichmentJob`
-> VectorEnrichmentJobConfig	`StartVectorEnrichmentJob`
-> Text	`StartVectorEnrichmentJob`
-> VectorEnrichmentJobStatus	`StartVectorEnrichmentJobResponse`
-> VectorEnrichmentJobType	`StartVectorEnrichmentJobResponse`
-> StartVectorEnrichmentJobResponse