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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation to create an Earth observation job.

Synopsis

Creating a Request

data StartEarthObservationJob Source #

See: newStartEarthObservationJob smart constructor.

Constructors

StartEarthObservationJob'

Fields

clientToken :: Maybe Text
A unique token that guarantees that the call to this API is idempotent.
executionRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
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.
inputConfig :: InputConfigInput
Input configuration information for the Earth Observation job.
jobConfig :: JobConfigInput
An object containing information about the job configuration.
name :: Text
The name of the Earth Observation job.

Instances

Instances details

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

newStartEarthObservationJob Source #

Arguments

:: InputConfigInput	`StartEarthObservationJob`
-> JobConfigInput	`StartEarthObservationJob`
-> Text	`StartEarthObservationJob`
-> StartEarthObservationJob

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.

Constructors

StartEarthObservationJobResponse'

Fields

executionRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
inputConfig :: Maybe InputConfigOutput
Input configuration information for the Earth Observation job.
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 Earth Observation job.
creationTime :: POSIX
The creation time.
durationInSeconds :: Int
The duration of the session, in seconds.
jobConfig :: JobConfigInput
An object containing information about the job configuration.
name :: Text
The name of the Earth Observation job.
status :: EarthObservationJobStatus
The status of the Earth Observation job.

Instances

Instances details

Generic StartEarthObservationJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartEarthObservationJob Associated Types type Rep StartEarthObservationJobResponse :: Type -> Type # Methods from :: StartEarthObservationJobResponse -> Rep StartEarthObservationJobResponse x # to :: Rep StartEarthObservationJobResponse x -> StartEarthObservationJobResponse #
Show StartEarthObservationJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartEarthObservationJob Methods showsPrec :: Int -> StartEarthObservationJobResponse -> ShowS # show :: StartEarthObservationJobResponse -> String # showList :: [StartEarthObservationJobResponse] -> ShowS #
NFData StartEarthObservationJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartEarthObservationJob Methods rnf :: StartEarthObservationJobResponse -> () #
Eq StartEarthObservationJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartEarthObservationJob Methods (==) :: StartEarthObservationJobResponse -> StartEarthObservationJobResponse -> Bool # (/=) :: StartEarthObservationJobResponse -> StartEarthObservationJobResponse -> Bool #
type Rep StartEarthObservationJobResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.StartEarthObservationJob type Rep StartEarthObservationJobResponse = D1 ('MetaData "StartEarthObservationJobResponse" "Amazonka.SageMakerGeoSpatial.StartEarthObservationJob" "amazonka-sagemaker-geospatial-2.0-Fg7YtbyXAZrLwLaIITXFtu" 'False) (C1 ('MetaCons "StartEarthObservationJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "inputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputConfigOutput))) :: (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 "jobConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobConfigInput) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EarthObservationJobStatus))))))

newStartEarthObservationJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartEarthObservationJobResponse'`
-> Text	`StartEarthObservationJobResponse`
-> UTCTime	`StartEarthObservationJobResponse`
-> Int	`StartEarthObservationJobResponse`
-> JobConfigInput	`StartEarthObservationJob`
-> Text	`StartEarthObservationJob`
-> EarthObservationJobStatus	`StartEarthObservationJobResponse`
-> 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.