libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.DescribeProcessingJob

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
Eq DescribeProcessingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

Methods

(==) :: DescribeProcessingJob -> DescribeProcessingJob -> Bool #

(/=) :: DescribeProcessingJob -> DescribeProcessingJob -> Bool #

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 #

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 #

NFData DescribeProcessingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

Methods

rnf :: DescribeProcessingJob -> () #

Hashable DescribeProcessingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

Methods

hashWithSalt :: Int -> DescribeProcessingJob -> Int #

hash :: DescribeProcessingJob -> Int #

ToJSON DescribeProcessingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

Methods

toJSON :: DescribeProcessingJob -> Value #

toEncoding :: DescribeProcessingJob -> Encoding #

toJSONList :: [DescribeProcessingJob] -> Value #

toEncodingList :: [DescribeProcessingJob] -> Encoding #

AWSRequest DescribeProcessingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

Associated Types

type AWSResponse DescribeProcessingJob #

Methods

request :: DescribeProcessingJob -> Request DescribeProcessingJob #

response :: MonadResource m => Logger -> Service -> Proxy DescribeProcessingJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeProcessingJob))) #

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 #

type Rep DescribeProcessingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

type Rep DescribeProcessingJob = D1 ('MetaData "DescribeProcessingJob" "Amazonka.SageMaker.DescribeProcessingJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeProcessingJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "processingJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeProcessingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

type AWSResponse DescribeProcessingJob = DescribeProcessingJobResponse

newDescribeProcessingJob Source #

Arguments

:: Text

$sel:processingJobName: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:

$sel:processingJobName: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

Instances

Instances details
Eq DescribeProcessingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

Methods

(==) :: DescribeProcessingJobResponse -> DescribeProcessingJobResponse -> Bool #

(/=) :: DescribeProcessingJobResponse -> DescribeProcessingJobResponse -> Bool #

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 #

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 #

NFData DescribeProcessingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

Methods

rnf :: DescribeProcessingJobResponse -> () #

type Rep DescribeProcessingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeProcessingJob

type Rep DescribeProcessingJobResponse = D1 ('MetaData "DescribeProcessingJobResponse" "Amazonka.SageMaker.DescribeProcessingJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeProcessingJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "monitoringScheduleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "stoppingCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingStoppingCondition)) :*: S1 ('MetaSel ('Just "experimentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperimentConfig))))) :*: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "processingInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessingInput])) :*: S1 ('MetaSel ('Just "networkConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfig)))) :*: (S1 ('MetaSel ('Just "autoMLJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "trainingJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "exitMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "processingOutputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingOutputConfig)) :*: S1 ('MetaSel ('Just "processingStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "processingEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "roleArn") '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

$sel:processingJobName:DescribeProcessingJob'

-> ProcessingResources

$sel:processingResources:DescribeProcessingJobResponse'

-> AppSpecification

$sel:appSpecification:DescribeProcessingJobResponse'

-> Text

$sel:processingJobArn:DescribeProcessingJobResponse'

-> ProcessingJobStatus

$sel:processingJobStatus:DescribeProcessingJobResponse'

-> UTCTime

$sel:creationTime: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:

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

$sel:monitoringScheduleArn:DescribeProcessingJobResponse', describeProcessingJobResponse_monitoringScheduleArn - The ARN of a monitoring schedule for an endpoint associated with this processing job.

$sel:environment:DescribeProcessingJobResponse', describeProcessingJobResponse_environment - The environment variables set in the Docker container.

$sel:stoppingCondition:DescribeProcessingJobResponse', describeProcessingJobResponse_stoppingCondition - The time limit for how long the processing job is allowed to run.

$sel:experimentConfig:DescribeProcessingJobResponse', describeProcessingJobResponse_experimentConfig - The configuration information used to create an experiment.

$sel:lastModifiedTime:DescribeProcessingJobResponse', describeProcessingJobResponse_lastModifiedTime - The time at which the processing job was last modified.

$sel:processingInputs:DescribeProcessingJobResponse', describeProcessingJobResponse_processingInputs - The inputs for a processing job.

$sel:networkConfig:DescribeProcessingJobResponse', describeProcessingJobResponse_networkConfig - Networking options for a processing job.

$sel:autoMLJobArn:DescribeProcessingJobResponse', describeProcessingJobResponse_autoMLJobArn - The ARN of an AutoML job associated with this processing job.

$sel:trainingJobArn:DescribeProcessingJobResponse', describeProcessingJobResponse_trainingJobArn - The ARN of a training job associated with this processing job.

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

$sel:processingOutputConfig:DescribeProcessingJobResponse', describeProcessingJobResponse_processingOutputConfig - Output configuration for the processing job.

$sel:processingStartTime:DescribeProcessingJobResponse', describeProcessingJobResponse_processingStartTime - The time at which the processing job started.

$sel:processingEndTime:DescribeProcessingJobResponse', describeProcessingJobResponse_processingEndTime - The time at which the processing job completed.

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

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

$sel:processingJobName: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.

$sel:processingResources: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.

$sel:appSpecification:DescribeProcessingJobResponse', describeProcessingJobResponse_appSpecification - Configures the processing job to run a specified container image.

$sel:processingJobArn:DescribeProcessingJobResponse', describeProcessingJobResponse_processingJobArn - The Amazon Resource Name (ARN) of the processing job.

$sel:processingJobStatus:DescribeProcessingJobResponse', describeProcessingJobResponse_processingJobStatus - Provides the status of a processing job.

$sel:creationTime:DescribeProcessingJobResponse', describeProcessingJobResponse_creationTime - The time at which the processing job was created.

Response Lenses

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_monitoringScheduleArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

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

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

The environment variables set in the Docker container.

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

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

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

The configuration information used to create an experiment.

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

The time at which the processing job was last modified.

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

The inputs for a processing job.

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

Networking options for a processing job.

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

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

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

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

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_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_processingEndTime :: Lens' DescribeProcessingJobResponse (Maybe UTCTime) Source #

The time at which the processing job completed.

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