Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.DescribeCompilationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

Synopsis

Creating a Request

data DescribeCompilationJob Source #

See: newDescribeCompilationJob smart constructor.

Constructors

DescribeCompilationJob'
Fields compilationJobName :: Text The name of the model compilation job that you want information about.

Instances

Instances details

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

newDescribeCompilationJob Source #

Arguments

:: Text	`$sel:compilationJobName:DescribeCompilationJob'`
-> DescribeCompilationJob

Create a value of DescribeCompilationJob 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:compilationJobName:DescribeCompilationJob', describeCompilationJob_compilationJobName - The name of the model compilation job that you want information about.

Request Lenses

describeCompilationJob_compilationJobName :: Lens' DescribeCompilationJob Text Source #

The name of the model compilation job that you want information about.

Destructuring the Response

data DescribeCompilationJobResponse Source #

See: newDescribeCompilationJobResponse smart constructor.

Constructors

DescribeCompilationJobResponse'

Fields

modelDigests :: Maybe ModelDigests
Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
compilationStartTime :: Maybe POSIX
The time when the model compilation job started the CompilationJob instances.
You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.
inferenceImage :: Maybe Text
The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.
vpcConfig :: Maybe NeoVpcConfig
A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
compilationEndTime :: Maybe POSIX
The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
httpStatus :: Int
The response's http status code.
compilationJobName :: Text
The name of the model compilation job.
compilationJobArn :: Text
The Amazon Resource Name (ARN) of the model compilation job.
compilationJobStatus :: CompilationJobStatus
The status of the model compilation job.
stoppingCondition :: StoppingCondition
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
creationTime :: POSIX
The time that the model compilation job was created.
lastModifiedTime :: POSIX
The time that the status of the model compilation job was last modified.
failureReason :: Text
If a model compilation job failed, the reason it failed.
modelArtifacts :: ModelArtifacts
Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
roleArn :: Text
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
inputConfig :: InputConfig
Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
outputConfig :: OutputConfig
Information about the output location for the compiled model and the target device that the model runs on.

Instances

Instances details

Eq DescribeCompilationJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeCompilationJob Methods (==) :: DescribeCompilationJobResponse -> DescribeCompilationJobResponse -> Bool # (/=) :: DescribeCompilationJobResponse -> DescribeCompilationJobResponse -> Bool #
Read DescribeCompilationJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeCompilationJob Methods readsPrec :: Int -> ReadS DescribeCompilationJobResponse # readList :: ReadS [DescribeCompilationJobResponse] # readPrec :: ReadPrec DescribeCompilationJobResponse # readListPrec :: ReadPrec [DescribeCompilationJobResponse] #
Show DescribeCompilationJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeCompilationJob Methods showsPrec :: Int -> DescribeCompilationJobResponse -> ShowS # show :: DescribeCompilationJobResponse -> String # showList :: [DescribeCompilationJobResponse] -> ShowS #
Generic DescribeCompilationJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeCompilationJob Associated Types type Rep DescribeCompilationJobResponse :: Type -> Type # Methods from :: DescribeCompilationJobResponse -> Rep DescribeCompilationJobResponse x # to :: Rep DescribeCompilationJobResponse x -> DescribeCompilationJobResponse #
NFData DescribeCompilationJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeCompilationJob Methods rnf :: DescribeCompilationJobResponse -> () #
type Rep DescribeCompilationJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeCompilationJob type Rep DescribeCompilationJobResponse = D1 ('MetaData "DescribeCompilationJobResponse" "Amazonka.SageMaker.DescribeCompilationJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeCompilationJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "modelDigests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelDigests)) :: S1 ('MetaSel ('Just "compilationStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "inferenceImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NeoVpcConfig)))) :: ((S1 ('MetaSel ('Just "compilationEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "compilationJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "compilationJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: (((S1 ('MetaSel ('Just "compilationJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CompilationJobStatus) :: S1 ('MetaSel ('Just "stoppingCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StoppingCondition)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :: ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "modelArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModelArtifacts)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "inputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputConfig) :: S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputConfig)))))))

newDescribeCompilationJobResponse Source #

Create a value of DescribeCompilationJobResponse 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:modelDigests:DescribeCompilationJobResponse', describeCompilationJobResponse_modelDigests - Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

$sel:compilationStartTime:DescribeCompilationJobResponse', describeCompilationJobResponse_compilationStartTime - The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

$sel:inferenceImage:DescribeCompilationJobResponse', describeCompilationJobResponse_inferenceImage - The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

$sel:vpcConfig:DescribeCompilationJobResponse', describeCompilationJobResponse_vpcConfig - A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

$sel:compilationEndTime:DescribeCompilationJobResponse', describeCompilationJobResponse_compilationEndTime - The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

$sel:httpStatus:DescribeCompilationJobResponse', describeCompilationJobResponse_httpStatus - The response's http status code.

$sel:compilationJobName:DescribeCompilationJob', describeCompilationJobResponse_compilationJobName - The name of the model compilation job.

$sel:compilationJobArn:DescribeCompilationJobResponse', describeCompilationJobResponse_compilationJobArn - The Amazon Resource Name (ARN) of the model compilation job.

$sel:compilationJobStatus:DescribeCompilationJobResponse', describeCompilationJobResponse_compilationJobStatus - The status of the model compilation job.

$sel:stoppingCondition:DescribeCompilationJobResponse', describeCompilationJobResponse_stoppingCondition - Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

$sel:creationTime:DescribeCompilationJobResponse', describeCompilationJobResponse_creationTime - The time that the model compilation job was created.

$sel:lastModifiedTime:DescribeCompilationJobResponse', describeCompilationJobResponse_lastModifiedTime - The time that the status of the model compilation job was last modified.

$sel:failureReason:DescribeCompilationJobResponse', describeCompilationJobResponse_failureReason - If a model compilation job failed, the reason it failed.

$sel:modelArtifacts:DescribeCompilationJobResponse', describeCompilationJobResponse_modelArtifacts - Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

$sel:roleArn:DescribeCompilationJobResponse', describeCompilationJobResponse_roleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

$sel:inputConfig:DescribeCompilationJobResponse', describeCompilationJobResponse_inputConfig - Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

$sel:outputConfig:DescribeCompilationJobResponse', describeCompilationJobResponse_outputConfig - Information about the output location for the compiled model and the target device that the model runs on.

Response Lenses

describeCompilationJobResponse_modelDigests :: Lens' DescribeCompilationJobResponse (Maybe ModelDigests) Source #

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

describeCompilationJobResponse_compilationStartTime :: Lens' DescribeCompilationJobResponse (Maybe UTCTime) Source #

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

describeCompilationJobResponse_inferenceImage :: Lens' DescribeCompilationJobResponse (Maybe Text) Source #

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

describeCompilationJobResponse_vpcConfig :: Lens' DescribeCompilationJobResponse (Maybe NeoVpcConfig) Source #

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

describeCompilationJobResponse_compilationEndTime :: Lens' DescribeCompilationJobResponse (Maybe UTCTime) Source #

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

describeCompilationJobResponse_httpStatus :: Lens' DescribeCompilationJobResponse Int Source #

The response's http status code.

describeCompilationJobResponse_compilationJobName :: Lens' DescribeCompilationJobResponse Text Source #

The name of the model compilation job.

describeCompilationJobResponse_compilationJobArn :: Lens' DescribeCompilationJobResponse Text Source #

The Amazon Resource Name (ARN) of the model compilation job.

describeCompilationJobResponse_compilationJobStatus :: Lens' DescribeCompilationJobResponse CompilationJobStatus Source #

The status of the model compilation job.

describeCompilationJobResponse_stoppingCondition :: Lens' DescribeCompilationJobResponse StoppingCondition Source #

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

describeCompilationJobResponse_creationTime :: Lens' DescribeCompilationJobResponse UTCTime Source #

The time that the model compilation job was created.

describeCompilationJobResponse_lastModifiedTime :: Lens' DescribeCompilationJobResponse UTCTime Source #

The time that the status of the model compilation job was last modified.

describeCompilationJobResponse_failureReason :: Lens' DescribeCompilationJobResponse Text Source #

If a model compilation job failed, the reason it failed.

describeCompilationJobResponse_modelArtifacts :: Lens' DescribeCompilationJobResponse ModelArtifacts Source #

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

describeCompilationJobResponse_roleArn :: Lens' DescribeCompilationJobResponse Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

describeCompilationJobResponse_inputConfig :: Lens' DescribeCompilationJobResponse InputConfig Source #

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

describeCompilationJobResponse_outputConfig :: Lens' DescribeCompilationJobResponse OutputConfig Source #

Information about the output location for the compiled model and the target device that the model runs on.

:: Int	`$sel:httpStatus:DescribeCompilationJobResponse'`
-> Text	`$sel:compilationJobName:DescribeCompilationJob'`
-> Text	`$sel:compilationJobArn:DescribeCompilationJobResponse'`
-> CompilationJobStatus	`$sel:compilationJobStatus:DescribeCompilationJobResponse'`
-> StoppingCondition	`$sel:stoppingCondition:DescribeCompilationJobResponse'`
-> UTCTime	`$sel:creationTime:DescribeCompilationJobResponse'`
-> UTCTime	`$sel:lastModifiedTime:DescribeCompilationJobResponse'`
-> Text	`$sel:failureReason:DescribeCompilationJobResponse'`
-> ModelArtifacts	`$sel:modelArtifacts:DescribeCompilationJobResponse'`
-> Text	`$sel:roleArn:DescribeCompilationJobResponse'`
-> InputConfig	`$sel:inputConfig:DescribeCompilationJobResponse'`
-> OutputConfig	`$sel:outputConfig:DescribeCompilationJobResponse'`
-> DescribeCompilationJobResponse