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 |
Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
Synopsis
- data StartVectorEnrichmentJob = StartVectorEnrichmentJob' {}
- newStartVectorEnrichmentJob :: Text -> VectorEnrichmentJobInputConfig -> VectorEnrichmentJobConfig -> Text -> StartVectorEnrichmentJob
- startVectorEnrichmentJob_clientToken :: Lens' StartVectorEnrichmentJob (Maybe Text)
- startVectorEnrichmentJob_kmsKeyId :: Lens' StartVectorEnrichmentJob (Maybe Text)
- startVectorEnrichmentJob_tags :: Lens' StartVectorEnrichmentJob (Maybe (HashMap Text Text))
- startVectorEnrichmentJob_executionRoleArn :: Lens' StartVectorEnrichmentJob Text
- startVectorEnrichmentJob_inputConfig :: Lens' StartVectorEnrichmentJob VectorEnrichmentJobInputConfig
- startVectorEnrichmentJob_jobConfig :: Lens' StartVectorEnrichmentJob VectorEnrichmentJobConfig
- startVectorEnrichmentJob_name :: Lens' StartVectorEnrichmentJob Text
- data StartVectorEnrichmentJobResponse = StartVectorEnrichmentJobResponse' {
- kmsKeyId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- arn :: Text
- creationTime :: POSIX
- durationInSeconds :: Int
- executionRoleArn :: Text
- inputConfig :: VectorEnrichmentJobInputConfig
- jobConfig :: VectorEnrichmentJobConfig
- name :: Text
- status :: VectorEnrichmentJobStatus
- type' :: VectorEnrichmentJobType
- newStartVectorEnrichmentJobResponse :: Int -> Text -> UTCTime -> Int -> Text -> VectorEnrichmentJobInputConfig -> VectorEnrichmentJobConfig -> Text -> VectorEnrichmentJobStatus -> VectorEnrichmentJobType -> StartVectorEnrichmentJobResponse
- startVectorEnrichmentJobResponse_kmsKeyId :: Lens' StartVectorEnrichmentJobResponse (Maybe Text)
- startVectorEnrichmentJobResponse_tags :: Lens' StartVectorEnrichmentJobResponse (Maybe (HashMap Text Text))
- startVectorEnrichmentJobResponse_httpStatus :: Lens' StartVectorEnrichmentJobResponse Int
- startVectorEnrichmentJobResponse_arn :: Lens' StartVectorEnrichmentJobResponse Text
- startVectorEnrichmentJobResponse_creationTime :: Lens' StartVectorEnrichmentJobResponse UTCTime
- startVectorEnrichmentJobResponse_durationInSeconds :: Lens' StartVectorEnrichmentJobResponse Int
- startVectorEnrichmentJobResponse_executionRoleArn :: Lens' StartVectorEnrichmentJobResponse Text
- startVectorEnrichmentJobResponse_inputConfig :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobInputConfig
- startVectorEnrichmentJobResponse_jobConfig :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobConfig
- startVectorEnrichmentJobResponse_name :: Lens' StartVectorEnrichmentJobResponse Text
- startVectorEnrichmentJobResponse_status :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobStatus
- startVectorEnrichmentJobResponse_type :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobType
Creating a Request
data StartVectorEnrichmentJob Source #
See: newStartVectorEnrichmentJob
smart constructor.
StartVectorEnrichmentJob' | |
|
Instances
newStartVectorEnrichmentJob Source #
:: Text | |
-> VectorEnrichmentJobInputConfig | |
-> VectorEnrichmentJobConfig | |
-> Text | |
-> 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.
StartVectorEnrichmentJobResponse' | |
|
Instances
newStartVectorEnrichmentJobResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> Int | |
-> Text | |
-> VectorEnrichmentJobInputConfig | |
-> VectorEnrichmentJobConfig | |
-> Text | |
-> VectorEnrichmentJobStatus | |
-> VectorEnrichmentJobType | |
-> StartVectorEnrichmentJobResponse |
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.