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

Description

Returns information about a transform job.

Synopsis

Creating a Request

data DescribeTransformJob Source #

See: newDescribeTransformJob smart constructor.

Constructors

DescribeTransformJob' 

Fields

Instances

Instances details
Eq DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

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

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

Read DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

readsPrec :: Int -> ReadS DescribeTransformJob #

readList :: ReadS [DescribeTransformJob] #

readPrec :: ReadPrec DescribeTransformJob #

readListPrec :: ReadPrec [DescribeTransformJob] #

Show DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

showsPrec :: Int -> DescribeTransformJob -> ShowS #

show :: DescribeTransformJob -> String #

showList :: [DescribeTransformJob] -> ShowS #

Generic DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Associated Types

type Rep DescribeTransformJob :: Type -> Type #

Methods

from :: DescribeTransformJob -> Rep DescribeTransformJob x #

to :: Rep DescribeTransformJob x -> DescribeTransformJob #

NFData DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

rnf :: DescribeTransformJob -> () #

Hashable DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

hashWithSalt :: Int -> DescribeTransformJob -> Int #

hash :: DescribeTransformJob -> Int #

ToJSON DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

toJSON :: DescribeTransformJob -> Value #

toEncoding :: DescribeTransformJob -> Encoding #

toJSONList :: [DescribeTransformJob] -> Value #

toEncodingList :: [DescribeTransformJob] -> Encoding #

AWSRequest DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Associated Types

type AWSResponse DescribeTransformJob #

Methods

request :: DescribeTransformJob -> Request DescribeTransformJob #

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

ToHeaders DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

toHeaders :: DescribeTransformJob -> [Header] #

ToPath DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

toPath :: DescribeTransformJob -> ByteString #

ToQuery DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

toQuery :: DescribeTransformJob -> QueryString #

type Rep DescribeTransformJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

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

Defined in Amazonka.SageMaker.DescribeTransformJob

type AWSResponse DescribeTransformJob = DescribeTransformJobResponse

newDescribeTransformJob Source #

Arguments

:: Text

$sel:transformJobName:DescribeTransformJob'

-> DescribeTransformJob 

Create a value of DescribeTransformJob 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:transformJobName:DescribeTransformJob', describeTransformJob_transformJobName - The name of the transform job that you want to view details of.

Request Lenses

describeTransformJob_transformJobName :: Lens' DescribeTransformJob Text Source #

The name of the transform job that you want to view details of.

Destructuring the Response

data DescribeTransformJobResponse Source #

See: newDescribeTransformJobResponse smart constructor.

Constructors

DescribeTransformJobResponse' 

Fields

Instances

Instances details
Eq DescribeTransformJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

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

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

Read DescribeTransformJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

readsPrec :: Int -> ReadS DescribeTransformJobResponse #

readList :: ReadS [DescribeTransformJobResponse] #

readPrec :: ReadPrec DescribeTransformJobResponse #

readListPrec :: ReadPrec [DescribeTransformJobResponse] #

Show DescribeTransformJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

showsPrec :: Int -> DescribeTransformJobResponse -> ShowS #

show :: DescribeTransformJobResponse -> String #

showList :: [DescribeTransformJobResponse] -> ShowS #

Generic DescribeTransformJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Associated Types

type Rep DescribeTransformJobResponse :: Type -> Type #

Methods

from :: DescribeTransformJobResponse -> Rep DescribeTransformJobResponse x #

to :: Rep DescribeTransformJobResponse x -> DescribeTransformJobResponse #

NFData DescribeTransformJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

rnf :: DescribeTransformJobResponse -> () #

type Rep DescribeTransformJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeTransformJob

type Rep DescribeTransformJobResponse = D1 ('MetaData "DescribeTransformJobResponse" "Amazonka.SageMaker.DescribeTransformJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeTransformJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "labelingJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "modelClientConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelClientConfig)) :*: (S1 ('MetaSel ('Just "batchStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchStrategy)) :*: S1 ('MetaSel ('Just "maxPayloadInMB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :*: ((S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "experimentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperimentConfig))) :*: (S1 ('MetaSel ('Just "transformEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "transformStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "autoMLJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "maxConcurrentTransforms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "transformOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransformOutput))) :*: (S1 ('MetaSel ('Just "dataProcessing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataProcessing)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "transformJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "transformJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "transformJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TransformJobStatus) :*: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "transformInput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TransformInput) :*: (S1 ('MetaSel ('Just "transformResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TransformResources) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))))

newDescribeTransformJobResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeTransformJobResponse'

-> Text

$sel:transformJobName:DescribeTransformJob'

-> Text

$sel:transformJobArn:DescribeTransformJobResponse'

-> TransformJobStatus

$sel:transformJobStatus:DescribeTransformJobResponse'

-> Text

$sel:modelName:DescribeTransformJobResponse'

-> TransformInput

$sel:transformInput:DescribeTransformJobResponse'

-> TransformResources

$sel:transformResources:DescribeTransformJobResponse'

-> UTCTime

$sel:creationTime:DescribeTransformJobResponse'

-> DescribeTransformJobResponse 

Create a value of DescribeTransformJobResponse 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:labelingJobArn:DescribeTransformJobResponse', describeTransformJobResponse_labelingJobArn - The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

$sel:failureReason:DescribeTransformJobResponse', describeTransformJobResponse_failureReason - If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

$sel:modelClientConfig:DescribeTransformJobResponse', describeTransformJobResponse_modelClientConfig - The timeout and maximum number of retries for processing a transform job invocation.

$sel:batchStrategy:DescribeTransformJobResponse', describeTransformJobResponse_batchStrategy - Specifies the number of records to include in a mini-batch for an HTTP inference request. A record // is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

$sel:maxPayloadInMB:DescribeTransformJobResponse', describeTransformJobResponse_maxPayloadInMB - The maximum payload size, in MB, used in the transform job.

$sel:environment:DescribeTransformJobResponse', describeTransformJobResponse_environment - The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

$sel:experimentConfig:DescribeTransformJobResponse', describeTransformJobResponse_experimentConfig - Undocumented member.

$sel:transformEndTime:DescribeTransformJobResponse', describeTransformJobResponse_transformEndTime - Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

$sel:transformStartTime:DescribeTransformJobResponse', describeTransformJobResponse_transformStartTime - Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

$sel:autoMLJobArn:DescribeTransformJobResponse', describeTransformJobResponse_autoMLJobArn - The Amazon Resource Name (ARN) of the AutoML transform job.

$sel:maxConcurrentTransforms:DescribeTransformJobResponse', describeTransformJobResponse_maxConcurrentTransforms - The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

$sel:transformOutput:DescribeTransformJobResponse', describeTransformJobResponse_transformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

$sel:dataProcessing:DescribeTransformJobResponse', describeTransformJobResponse_dataProcessing - Undocumented member.

$sel:httpStatus:DescribeTransformJobResponse', describeTransformJobResponse_httpStatus - The response's http status code.

$sel:transformJobName:DescribeTransformJob', describeTransformJobResponse_transformJobName - The name of the transform job.

$sel:transformJobArn:DescribeTransformJobResponse', describeTransformJobResponse_transformJobArn - The Amazon Resource Name (ARN) of the transform job.

$sel:transformJobStatus:DescribeTransformJobResponse', describeTransformJobResponse_transformJobStatus - The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

$sel:modelName:DescribeTransformJobResponse', describeTransformJobResponse_modelName - The name of the model used in the transform job.

$sel:transformInput:DescribeTransformJobResponse', describeTransformJobResponse_transformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

$sel:transformResources:DescribeTransformJobResponse', describeTransformJobResponse_transformResources - Describes the resources, including ML instance types and ML instance count, to use for the transform job.

$sel:creationTime:DescribeTransformJobResponse', describeTransformJobResponse_creationTime - A timestamp that shows when the transform Job was created.

Response Lenses

describeTransformJobResponse_labelingJobArn :: Lens' DescribeTransformJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

describeTransformJobResponse_failureReason :: Lens' DescribeTransformJobResponse (Maybe Text) Source #

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

describeTransformJobResponse_modelClientConfig :: Lens' DescribeTransformJobResponse (Maybe ModelClientConfig) Source #

The timeout and maximum number of retries for processing a transform job invocation.

describeTransformJobResponse_batchStrategy :: Lens' DescribeTransformJobResponse (Maybe BatchStrategy) Source #

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record // is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

describeTransformJobResponse_maxPayloadInMB :: Lens' DescribeTransformJobResponse (Maybe Natural) Source #

The maximum payload size, in MB, used in the transform job.

describeTransformJobResponse_environment :: Lens' DescribeTransformJobResponse (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

describeTransformJobResponse_experimentConfig :: Lens' DescribeTransformJobResponse (Maybe ExperimentConfig) Source #

Undocumented member.

describeTransformJobResponse_transformEndTime :: Lens' DescribeTransformJobResponse (Maybe UTCTime) Source #

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

describeTransformJobResponse_transformStartTime :: Lens' DescribeTransformJobResponse (Maybe UTCTime) Source #

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

describeTransformJobResponse_autoMLJobArn :: Lens' DescribeTransformJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AutoML transform job.

describeTransformJobResponse_maxConcurrentTransforms :: Lens' DescribeTransformJobResponse (Maybe Natural) Source #

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

describeTransformJobResponse_transformOutput :: Lens' DescribeTransformJobResponse (Maybe TransformOutput) Source #

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

describeTransformJobResponse_dataProcessing :: Lens' DescribeTransformJobResponse (Maybe DataProcessing) Source #

Undocumented member.

describeTransformJobResponse_httpStatus :: Lens' DescribeTransformJobResponse Int Source #

The response's http status code.

describeTransformJobResponse_transformJobName :: Lens' DescribeTransformJobResponse Text Source #

The name of the transform job.

describeTransformJobResponse_transformJobArn :: Lens' DescribeTransformJobResponse Text Source #

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

describeTransformJobResponse_transformJobStatus :: Lens' DescribeTransformJobResponse TransformJobStatus Source #

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

describeTransformJobResponse_modelName :: Lens' DescribeTransformJobResponse Text Source #

The name of the model used in the transform job.

describeTransformJobResponse_transformInput :: Lens' DescribeTransformJobResponse TransformInput Source #

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

describeTransformJobResponse_transformResources :: Lens' DescribeTransformJobResponse TransformResources Source #

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

describeTransformJobResponse_creationTime :: Lens' DescribeTransformJobResponse UTCTime Source #

A timestamp that shows when the transform Job was created.