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 |
Use this operation to create an Earth observation job.
Synopsis
- data StartEarthObservationJob = StartEarthObservationJob' {
- clientToken :: Maybe Text
- executionRoleArn :: Maybe Text
- kmsKeyId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- inputConfig :: InputConfigInput
- jobConfig :: JobConfigInput
- name :: Text
- newStartEarthObservationJob :: InputConfigInput -> JobConfigInput -> Text -> StartEarthObservationJob
- startEarthObservationJob_clientToken :: Lens' StartEarthObservationJob (Maybe Text)
- startEarthObservationJob_executionRoleArn :: Lens' StartEarthObservationJob (Maybe Text)
- startEarthObservationJob_kmsKeyId :: Lens' StartEarthObservationJob (Maybe Text)
- startEarthObservationJob_tags :: Lens' StartEarthObservationJob (Maybe (HashMap Text Text))
- startEarthObservationJob_inputConfig :: Lens' StartEarthObservationJob InputConfigInput
- startEarthObservationJob_jobConfig :: Lens' StartEarthObservationJob JobConfigInput
- startEarthObservationJob_name :: Lens' StartEarthObservationJob Text
- data StartEarthObservationJobResponse = StartEarthObservationJobResponse' {}
- newStartEarthObservationJobResponse :: Int -> Text -> UTCTime -> Int -> JobConfigInput -> Text -> EarthObservationJobStatus -> StartEarthObservationJobResponse
- startEarthObservationJobResponse_executionRoleArn :: Lens' StartEarthObservationJobResponse (Maybe Text)
- startEarthObservationJobResponse_inputConfig :: Lens' StartEarthObservationJobResponse (Maybe InputConfigOutput)
- startEarthObservationJobResponse_kmsKeyId :: Lens' StartEarthObservationJobResponse (Maybe Text)
- startEarthObservationJobResponse_tags :: Lens' StartEarthObservationJobResponse (Maybe (HashMap Text Text))
- startEarthObservationJobResponse_httpStatus :: Lens' StartEarthObservationJobResponse Int
- startEarthObservationJobResponse_arn :: Lens' StartEarthObservationJobResponse Text
- startEarthObservationJobResponse_creationTime :: Lens' StartEarthObservationJobResponse UTCTime
- startEarthObservationJobResponse_durationInSeconds :: Lens' StartEarthObservationJobResponse Int
- startEarthObservationJobResponse_jobConfig :: Lens' StartEarthObservationJobResponse JobConfigInput
- startEarthObservationJobResponse_name :: Lens' StartEarthObservationJobResponse Text
- startEarthObservationJobResponse_status :: Lens' StartEarthObservationJobResponse EarthObservationJobStatus
Creating a Request
data StartEarthObservationJob Source #
See: newStartEarthObservationJob
smart constructor.
StartEarthObservationJob' | |
|
Instances
newStartEarthObservationJob Source #
Create a value of StartEarthObservationJob
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:StartEarthObservationJob'
, startEarthObservationJob_clientToken
- A unique token that guarantees that the call to this API is idempotent.
StartEarthObservationJob
, startEarthObservationJob_executionRoleArn
- The Amazon Resource Name (ARN) of the IAM role that you specified for
the job.
StartEarthObservationJob
, startEarthObservationJob_kmsKeyId
- The Amazon Key Management Service (KMS) key ID for server-side
encryption.
StartEarthObservationJob
, startEarthObservationJob_tags
- Each tag consists of a key and a value.
StartEarthObservationJob
, startEarthObservationJob_inputConfig
- Input configuration information for the Earth Observation job.
StartEarthObservationJob
, startEarthObservationJob_jobConfig
- An object containing information about the job configuration.
StartEarthObservationJob
, startEarthObservationJob_name
- The name of the Earth Observation job.
Request Lenses
startEarthObservationJob_clientToken :: Lens' StartEarthObservationJob (Maybe Text) Source #
A unique token that guarantees that the call to this API is idempotent.
startEarthObservationJob_executionRoleArn :: Lens' StartEarthObservationJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
startEarthObservationJob_kmsKeyId :: Lens' StartEarthObservationJob (Maybe Text) Source #
The Amazon Key Management Service (KMS) key ID for server-side encryption.
startEarthObservationJob_tags :: Lens' StartEarthObservationJob (Maybe (HashMap Text Text)) Source #
Each tag consists of a key and a value.
startEarthObservationJob_inputConfig :: Lens' StartEarthObservationJob InputConfigInput Source #
Input configuration information for the Earth Observation job.
startEarthObservationJob_jobConfig :: Lens' StartEarthObservationJob JobConfigInput Source #
An object containing information about the job configuration.
startEarthObservationJob_name :: Lens' StartEarthObservationJob Text Source #
The name of the Earth Observation job.
Destructuring the Response
data StartEarthObservationJobResponse Source #
See: newStartEarthObservationJobResponse
smart constructor.
StartEarthObservationJobResponse' | |
|
Instances
newStartEarthObservationJobResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> Int | |
-> JobConfigInput | |
-> Text | |
-> EarthObservationJobStatus | |
-> StartEarthObservationJobResponse |
Create a value of StartEarthObservationJobResponse
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:
StartEarthObservationJob
, startEarthObservationJobResponse_executionRoleArn
- The Amazon Resource Name (ARN) of the IAM role that you specified for
the job.
StartEarthObservationJob
, startEarthObservationJobResponse_inputConfig
- Input configuration information for the Earth Observation job.
StartEarthObservationJob
, startEarthObservationJobResponse_kmsKeyId
- The Amazon Key Management Service (KMS) key ID for server-side
encryption.
StartEarthObservationJob
, startEarthObservationJobResponse_tags
- Each tag consists of a key and a value.
$sel:httpStatus:StartEarthObservationJobResponse'
, startEarthObservationJobResponse_httpStatus
- The response's http status code.
StartEarthObservationJobResponse
, startEarthObservationJobResponse_arn
- The Amazon Resource Name (ARN) of the Earth Observation job.
StartEarthObservationJobResponse
, startEarthObservationJobResponse_creationTime
- The creation time.
StartEarthObservationJobResponse
, startEarthObservationJobResponse_durationInSeconds
- The duration of the session, in seconds.
StartEarthObservationJob
, startEarthObservationJobResponse_jobConfig
- An object containing information about the job configuration.
StartEarthObservationJob
, startEarthObservationJobResponse_name
- The name of the Earth Observation job.
StartEarthObservationJobResponse
, startEarthObservationJobResponse_status
- The status of the Earth Observation job.
Response Lenses
startEarthObservationJobResponse_executionRoleArn :: Lens' StartEarthObservationJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
startEarthObservationJobResponse_inputConfig :: Lens' StartEarthObservationJobResponse (Maybe InputConfigOutput) Source #
Input configuration information for the Earth Observation job.
startEarthObservationJobResponse_kmsKeyId :: Lens' StartEarthObservationJobResponse (Maybe Text) Source #
The Amazon Key Management Service (KMS) key ID for server-side encryption.
startEarthObservationJobResponse_tags :: Lens' StartEarthObservationJobResponse (Maybe (HashMap Text Text)) Source #
Each tag consists of a key and a value.
startEarthObservationJobResponse_httpStatus :: Lens' StartEarthObservationJobResponse Int Source #
The response's http status code.
startEarthObservationJobResponse_arn :: Lens' StartEarthObservationJobResponse Text Source #
The Amazon Resource Name (ARN) of the Earth Observation job.
startEarthObservationJobResponse_creationTime :: Lens' StartEarthObservationJobResponse UTCTime Source #
The creation time.
startEarthObservationJobResponse_durationInSeconds :: Lens' StartEarthObservationJobResponse Int Source #
The duration of the session, in seconds.
startEarthObservationJobResponse_jobConfig :: Lens' StartEarthObservationJobResponse JobConfigInput Source #
An object containing information about the job configuration.
startEarthObservationJobResponse_name :: Lens' StartEarthObservationJobResponse Text Source #
The name of the Earth Observation job.
startEarthObservationJobResponse_status :: Lens' StartEarthObservationJobResponse EarthObservationJobStatus Source #
The status of the Earth Observation job.