Amazonka.SageMaker.DescribeTransformJob

Returns information about a transform job.

Creating a Request

data DescribeTransformJob

See: newDescribeTransformJob smart constructor.

Constructors

DescribeTransformJob'

Fields

• transformJobName :: Text

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

Instances

ToJSON DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

toJSON :: DescribeTransformJob -> Value

toEncoding :: DescribeTransformJob -> Encoding

toJSONList :: [DescribeTransformJob] -> Value

toEncodingList :: [DescribeTransformJob] -> Encoding

ToHeaders DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

toHeaders :: DescribeTransformJob -> [Header]

ToPath DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

toPath :: DescribeTransformJob -> ByteString

ToQuery DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

toQuery :: DescribeTransformJob -> QueryString

AWSRequest DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Associated Types

type AWSResponse DescribeTransformJob

Methods

request :: (Service -> Service) -> DescribeTransformJob -> Request DescribeTransformJob

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

Generic DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Associated Types

type Rep DescribeTransformJob :: Type -> Type

Methods

from :: DescribeTransformJob -> Rep DescribeTransformJob x

to :: Rep DescribeTransformJob x -> DescribeTransformJob

Read DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

readsPrec :: Int -> ReadS DescribeTransformJob

readList :: ReadS [DescribeTransformJob]

readPrec :: ReadPrec DescribeTransformJob

readListPrec :: ReadPrec [DescribeTransformJob]

Show DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

showsPrec :: Int -> DescribeTransformJob -> ShowS

show :: DescribeTransformJob -> String

showList :: [DescribeTransformJob] -> ShowS

NFData DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

rnf :: DescribeTransformJob -> ()

Eq DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

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

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

Hashable DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

hashWithSalt :: Int -> DescribeTransformJob -> Int

hash :: DescribeTransformJob -> Int

type AWSResponse DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

type AWSResponse DescribeTransformJob = DescribeTransformJobResponse

type Rep DescribeTransformJob

Defined in Amazonka.SageMaker.DescribeTransformJob

type Rep DescribeTransformJob = D1 ('MetaData "DescribeTransformJob" "Amazonka.SageMaker.DescribeTransformJob" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeTransformJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "transformJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeTransformJob

Arguments

:: Text

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:

DescribeTransformJob, describeTransformJob_transformJobName - The name of the transform job that you want to view details of.

Request Lenses

describeTransformJob_transformJobName :: Lens' DescribeTransformJob Text

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

Destructuring the Response

data DescribeTransformJobResponse

See: newDescribeTransformJobResponse smart constructor.

Constructors

DescribeTransformJobResponse'

Fields

• autoMLJobArn :: Maybe Text

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

• batchStrategy :: Maybe 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.

• dataCaptureConfig :: Maybe BatchDataCaptureConfig

  Configuration to control how SageMaker captures inference data.

• dataProcessing :: Maybe DataProcessing
• environment :: Maybe (HashMap Text Text)

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

• experimentConfig :: Maybe ExperimentConfig
• failureReason :: Maybe Text

  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.

• labelingJobArn :: Maybe Text

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

• maxConcurrentTransforms :: Maybe Natural

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

• maxPayloadInMB :: Maybe Natural

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

• modelClientConfig :: Maybe ModelClientConfig

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

• transformEndTime :: Maybe POSIX

  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.

• transformOutput :: Maybe TransformOutput

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

• transformStartTime :: Maybe POSIX

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

• httpStatus :: Int

  The response's http status code.

• transformJobName :: Text

  The name of the transform job.

• transformJobArn :: Text

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

• transformJobStatus :: TransformJobStatus

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

• modelName :: Text

  The name of the model used in the transform job.

• transformInput :: TransformInput

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

• transformResources :: TransformResources

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

• creationTime :: POSIX

  A timestamp that shows when the transform Job was created.

Instances

Generic DescribeTransformJobResponse

Defined in Amazonka.SageMaker.DescribeTransformJob

Associated Types

type Rep DescribeTransformJobResponse :: Type -> Type

Methods

from :: DescribeTransformJobResponse -> Rep DescribeTransformJobResponse x

to :: Rep DescribeTransformJobResponse x -> DescribeTransformJobResponse

Read DescribeTransformJobResponse

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

readsPrec :: Int -> ReadS DescribeTransformJobResponse

readList :: ReadS [DescribeTransformJobResponse]

readPrec :: ReadPrec DescribeTransformJobResponse

readListPrec :: ReadPrec [DescribeTransformJobResponse]

Show DescribeTransformJobResponse

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

showsPrec :: Int -> DescribeTransformJobResponse -> ShowS

show :: DescribeTransformJobResponse -> String

showList :: [DescribeTransformJobResponse] -> ShowS

NFData DescribeTransformJobResponse

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

rnf :: DescribeTransformJobResponse -> ()

Eq DescribeTransformJobResponse

Defined in Amazonka.SageMaker.DescribeTransformJob

Methods

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

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

type Rep DescribeTransformJobResponse

Defined in Amazonka.SageMaker.DescribeTransformJob

type Rep DescribeTransformJobResponse = D1 ('MetaData "DescribeTransformJobResponse" "Amazonka.SageMaker.DescribeTransformJob" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeTransformJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "autoMLJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "batchStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchStrategy))) :*: (S1 ('MetaSel ('Just "dataCaptureConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchDataCaptureConfig)) :*: (S1 ('MetaSel ('Just "dataProcessing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataProcessing)) :*: 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 "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "labelingJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "maxConcurrentTransforms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "maxPayloadInMB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "modelClientConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelClientConfig)))))) :*: (((S1 ('MetaSel ('Just "transformEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "transformOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransformOutput))) :*: (S1 ('MetaSel ('Just "transformStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (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

Arguments

:: Int

$sel:httpStatus:DescribeTransformJobResponse'

-> Text

DescribeTransformJob

-> Text

DescribeTransformJobResponse

-> TransformJobStatus

DescribeTransformJobResponse

-> Text

DescribeTransformJobResponse

-> TransformInput

DescribeTransformJobResponse

-> TransformResources

DescribeTransformJobResponse

-> UTCTime

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:

DescribeTransformJobResponse, describeTransformJobResponse_autoMLJobArn - The Amazon Resource Name (ARN) of the AutoML transform job.

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.

DescribeTransformJobResponse, describeTransformJobResponse_dataCaptureConfig - Configuration to control how SageMaker captures inference data.

DescribeTransformJobResponse, describeTransformJobResponse_dataProcessing - Undocumented member.

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

DescribeTransformJobResponse, describeTransformJobResponse_experimentConfig - Undocumented member.

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.

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

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.

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

DescribeTransformJobResponse, describeTransformJobResponse_modelClientConfig - The timeout and maximum number of retries for processing a transform job invocation.

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.

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

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:httpStatus:DescribeTransformJobResponse', describeTransformJobResponse_httpStatus - The response's http status code.

DescribeTransformJob, describeTransformJobResponse_transformJobName - The name of the transform job.

DescribeTransformJobResponse, describeTransformJobResponse_transformJobArn - The Amazon Resource Name (ARN) of the transform job.

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

DescribeTransformJobResponse, describeTransformJobResponse_modelName - The name of the model used in the transform job.

DescribeTransformJobResponse, describeTransformJobResponse_transformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

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

DescribeTransformJobResponse, describeTransformJobResponse_creationTime - A timestamp that shows when the transform Job was created.

Response Lenses

describeTransformJobResponse_autoMLJobArn :: Lens' DescribeTransformJobResponse (Maybe Text)

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

describeTransformJobResponse_batchStrategy :: Lens' DescribeTransformJobResponse (Maybe 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.

describeTransformJobResponse_dataCaptureConfig :: Lens' DescribeTransformJobResponse (Maybe BatchDataCaptureConfig)

Configuration to control how SageMaker captures inference data.

describeTransformJobResponse_dataProcessing :: Lens' DescribeTransformJobResponse (Maybe DataProcessing)

Undocumented member.

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

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)

Undocumented member.

describeTransformJobResponse_failureReason :: Lens' DescribeTransformJobResponse (Maybe Text)

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_labelingJobArn :: Lens' DescribeTransformJobResponse (Maybe Text)

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

describeTransformJobResponse_maxConcurrentTransforms :: Lens' DescribeTransformJobResponse (Maybe Natural)

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

describeTransformJobResponse_maxPayloadInMB :: Lens' DescribeTransformJobResponse (Maybe Natural)

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

describeTransformJobResponse_modelClientConfig :: Lens' DescribeTransformJobResponse (Maybe ModelClientConfig)

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

describeTransformJobResponse_transformEndTime :: Lens' DescribeTransformJobResponse (Maybe UTCTime)

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_transformOutput :: Lens' DescribeTransformJobResponse (Maybe TransformOutput)

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

describeTransformJobResponse_transformStartTime :: Lens' DescribeTransformJobResponse (Maybe UTCTime)

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_httpStatus :: Lens' DescribeTransformJobResponse Int

The response's http status code.

describeTransformJobResponse_transformJobName :: Lens' DescribeTransformJobResponse Text

The name of the transform job.

describeTransformJobResponse_transformJobArn :: Lens' DescribeTransformJobResponse Text

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

describeTransformJobResponse_transformJobStatus :: Lens' DescribeTransformJobResponse TransformJobStatus

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

describeTransformJobResponse_modelName :: Lens' DescribeTransformJobResponse Text

The name of the model used in the transform job.

describeTransformJobResponse_transformInput :: Lens' DescribeTransformJobResponse TransformInput

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

describeTransformJobResponse_transformResources :: Lens' DescribeTransformJobResponse TransformResources

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

describeTransformJobResponse_creationTime :: Lens' DescribeTransformJobResponse UTCTime

A timestamp that shows when the transform Job was created.