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.SageMaker.DescribeProcessingJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of a processing job.

Synopsis

Creating a Request

data DescribeProcessingJob Source #

See: newDescribeProcessingJob smart constructor.

Constructors

DescribeProcessingJob'
Fields processingJobName :: Text The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

Instances

Instances details

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

newDescribeProcessingJob Source #

Arguments

:: Text	`DescribeProcessingJob`
-> DescribeProcessingJob

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

DescribeProcessingJob, describeProcessingJob_processingJobName - The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

Request Lenses

describeProcessingJob_processingJobName :: Lens' DescribeProcessingJob Text Source #

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

Destructuring the Response

data DescribeProcessingJobResponse Source #

See: newDescribeProcessingJobResponse smart constructor.

Constructors

DescribeProcessingJobResponse'

Fields

autoMLJobArn :: Maybe Text
The ARN of an AutoML job associated with this processing job.
environment :: Maybe (HashMap Text Text)
The environment variables set in the Docker container.
exitMessage :: Maybe Text
An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
experimentConfig :: Maybe ExperimentConfig
The configuration information used to create an experiment.
failureReason :: Maybe Text
A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
lastModifiedTime :: Maybe POSIX
The time at which the processing job was last modified.
monitoringScheduleArn :: Maybe Text
The ARN of a monitoring schedule for an endpoint associated with this processing job.
networkConfig :: Maybe NetworkConfig
Networking options for a processing job.
processingEndTime :: Maybe POSIX
The time at which the processing job completed.
processingInputs :: Maybe [ProcessingInput]
The inputs for a processing job.
processingOutputConfig :: Maybe ProcessingOutputConfig
Output configuration for the processing job.
processingStartTime :: Maybe POSIX
The time at which the processing job started.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stoppingCondition :: Maybe ProcessingStoppingCondition
The time limit for how long the processing job is allowed to run.
trainingJobArn :: Maybe Text
The ARN of a training job associated with this processing job.
httpStatus :: Int
The response's http status code.
processingJobName :: Text
The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
processingResources :: ProcessingResources
Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
appSpecification :: AppSpecification
Configures the processing job to run a specified container image.
processingJobArn :: Text
The Amazon Resource Name (ARN) of the processing job.
processingJobStatus :: ProcessingJobStatus
Provides the status of a processing job.
creationTime :: POSIX
The time at which the processing job was created.

Instances

Instances details

Generic DescribeProcessingJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeProcessingJob Associated Types type Rep DescribeProcessingJobResponse :: Type -> Type # Methods from :: DescribeProcessingJobResponse -> Rep DescribeProcessingJobResponse x # to :: Rep DescribeProcessingJobResponse x -> DescribeProcessingJobResponse #
Read DescribeProcessingJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeProcessingJob Methods readsPrec :: Int -> ReadS DescribeProcessingJobResponse # readList :: ReadS [DescribeProcessingJobResponse] # readPrec :: ReadPrec DescribeProcessingJobResponse # readListPrec :: ReadPrec [DescribeProcessingJobResponse] #
Show DescribeProcessingJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeProcessingJob Methods showsPrec :: Int -> DescribeProcessingJobResponse -> ShowS # show :: DescribeProcessingJobResponse -> String # showList :: [DescribeProcessingJobResponse] -> ShowS #
NFData DescribeProcessingJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeProcessingJob Methods rnf :: DescribeProcessingJobResponse -> () #
Eq DescribeProcessingJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeProcessingJob Methods (==) :: DescribeProcessingJobResponse -> DescribeProcessingJobResponse -> Bool # (/=) :: DescribeProcessingJobResponse -> DescribeProcessingJobResponse -> Bool #
type Rep DescribeProcessingJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeProcessingJob type Rep DescribeProcessingJobResponse = D1 ('MetaData "DescribeProcessingJobResponse" "Amazonka.SageMaker.DescribeProcessingJob" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeProcessingJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "autoMLJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "exitMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "experimentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperimentConfig)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "monitoringScheduleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "networkConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfig)))) :: (S1 ('MetaSel ('Just "processingEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "processingInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessingInput])) :: S1 ('MetaSel ('Just "processingOutputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingOutputConfig)))))) :: (((S1 ('MetaSel ('Just "processingStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stoppingCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingStoppingCondition)) :: (S1 ('MetaSel ('Just "trainingJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :: ((S1 ('MetaSel ('Just "processingJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "processingResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessingResources) :: S1 ('MetaSel ('Just "appSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppSpecification))) :: (S1 ('MetaSel ('Just "processingJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "processingJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessingJobStatus) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))))

newDescribeProcessingJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeProcessingJobResponse'`
-> Text	`DescribeProcessingJob`
-> ProcessingResources	`DescribeProcessingJobResponse`
-> AppSpecification	`DescribeProcessingJobResponse`
-> Text	`DescribeProcessingJobResponse`
-> ProcessingJobStatus	`DescribeProcessingJobResponse`
-> UTCTime	`DescribeProcessingJobResponse`
-> DescribeProcessingJobResponse

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

DescribeProcessingJobResponse, describeProcessingJobResponse_autoMLJobArn - The ARN of an AutoML job associated with this processing job.

DescribeProcessingJobResponse, describeProcessingJobResponse_environment - The environment variables set in the Docker container.

DescribeProcessingJobResponse, describeProcessingJobResponse_exitMessage - An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

DescribeProcessingJobResponse, describeProcessingJobResponse_experimentConfig - The configuration information used to create an experiment.

DescribeProcessingJobResponse, describeProcessingJobResponse_failureReason - A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

DescribeProcessingJobResponse, describeProcessingJobResponse_lastModifiedTime - The time at which the processing job was last modified.

DescribeProcessingJobResponse, describeProcessingJobResponse_monitoringScheduleArn - The ARN of a monitoring schedule for an endpoint associated with this processing job.

DescribeProcessingJobResponse, describeProcessingJobResponse_networkConfig - Networking options for a processing job.

DescribeProcessingJobResponse, describeProcessingJobResponse_processingEndTime - The time at which the processing job completed.

DescribeProcessingJobResponse, describeProcessingJobResponse_processingInputs - The inputs for a processing job.

DescribeProcessingJobResponse, describeProcessingJobResponse_processingOutputConfig - Output configuration for the processing job.

DescribeProcessingJobResponse, describeProcessingJobResponse_processingStartTime - The time at which the processing job started.

DescribeProcessingJobResponse, describeProcessingJobResponse_roleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

DescribeProcessingJobResponse, describeProcessingJobResponse_stoppingCondition - The time limit for how long the processing job is allowed to run.

DescribeProcessingJobResponse, describeProcessingJobResponse_trainingJobArn - The ARN of a training job associated with this processing job.

$sel:httpStatus:DescribeProcessingJobResponse', describeProcessingJobResponse_httpStatus - The response's http status code.

DescribeProcessingJob, describeProcessingJobResponse_processingJobName - The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

DescribeProcessingJobResponse, describeProcessingJobResponse_processingResources - Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

DescribeProcessingJobResponse, describeProcessingJobResponse_appSpecification - Configures the processing job to run a specified container image.

DescribeProcessingJobResponse, describeProcessingJobResponse_processingJobArn - The Amazon Resource Name (ARN) of the processing job.

DescribeProcessingJobResponse, describeProcessingJobResponse_processingJobStatus - Provides the status of a processing job.

DescribeProcessingJobResponse, describeProcessingJobResponse_creationTime - The time at which the processing job was created.

Response Lenses

describeProcessingJobResponse_autoMLJobArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

The ARN of an AutoML job associated with this processing job.

describeProcessingJobResponse_environment :: Lens' DescribeProcessingJobResponse (Maybe (HashMap Text Text)) Source #

The environment variables set in the Docker container.

describeProcessingJobResponse_exitMessage :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

describeProcessingJobResponse_experimentConfig :: Lens' DescribeProcessingJobResponse (Maybe ExperimentConfig) Source #

The configuration information used to create an experiment.

describeProcessingJobResponse_failureReason :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

describeProcessingJobResponse_lastModifiedTime :: Lens' DescribeProcessingJobResponse (Maybe UTCTime) Source #

The time at which the processing job was last modified.

describeProcessingJobResponse_monitoringScheduleArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

The ARN of a monitoring schedule for an endpoint associated with this processing job.

describeProcessingJobResponse_networkConfig :: Lens' DescribeProcessingJobResponse (Maybe NetworkConfig) Source #

Networking options for a processing job.

describeProcessingJobResponse_processingEndTime :: Lens' DescribeProcessingJobResponse (Maybe UTCTime) Source #

The time at which the processing job completed.

describeProcessingJobResponse_processingInputs :: Lens' DescribeProcessingJobResponse (Maybe [ProcessingInput]) Source #

The inputs for a processing job.

describeProcessingJobResponse_processingOutputConfig :: Lens' DescribeProcessingJobResponse (Maybe ProcessingOutputConfig) Source #

Output configuration for the processing job.

describeProcessingJobResponse_processingStartTime :: Lens' DescribeProcessingJobResponse (Maybe UTCTime) Source #

The time at which the processing job started.

describeProcessingJobResponse_roleArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

describeProcessingJobResponse_stoppingCondition :: Lens' DescribeProcessingJobResponse (Maybe ProcessingStoppingCondition) Source #

The time limit for how long the processing job is allowed to run.

describeProcessingJobResponse_trainingJobArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

The ARN of a training job associated with this processing job.

describeProcessingJobResponse_httpStatus :: Lens' DescribeProcessingJobResponse Int Source #

The response's http status code.

describeProcessingJobResponse_processingJobName :: Lens' DescribeProcessingJobResponse Text Source #

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeProcessingJobResponse_processingResources :: Lens' DescribeProcessingJobResponse ProcessingResources Source #

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

describeProcessingJobResponse_appSpecification :: Lens' DescribeProcessingJobResponse AppSpecification Source #

Configures the processing job to run a specified container image.

describeProcessingJobResponse_processingJobArn :: Lens' DescribeProcessingJobResponse Text Source #

The Amazon Resource Name (ARN) of the processing job.

describeProcessingJobResponse_processingJobStatus :: Lens' DescribeProcessingJobResponse ProcessingJobStatus Source #

Provides the status of a processing job.

describeProcessingJobResponse_creationTime :: Lens' DescribeProcessingJobResponse UTCTime Source #

The time at which the processing job was created.