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

Description

Returns information about an Amazon SageMaker AutoML job.

Synopsis

Creating a Request

data DescribeAutoMLJob Source #

See: newDescribeAutoMLJob smart constructor.

Constructors

DescribeAutoMLJob' 

Fields

Instances

Instances details
Eq DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

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

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

Read DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

readsPrec :: Int -> ReadS DescribeAutoMLJob #

readList :: ReadS [DescribeAutoMLJob] #

readPrec :: ReadPrec DescribeAutoMLJob #

readListPrec :: ReadPrec [DescribeAutoMLJob] #

Show DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

showsPrec :: Int -> DescribeAutoMLJob -> ShowS #

show :: DescribeAutoMLJob -> String #

showList :: [DescribeAutoMLJob] -> ShowS #

Generic DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Associated Types

type Rep DescribeAutoMLJob :: Type -> Type #

Methods

from :: DescribeAutoMLJob -> Rep DescribeAutoMLJob x #

to :: Rep DescribeAutoMLJob x -> DescribeAutoMLJob #

NFData DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

rnf :: DescribeAutoMLJob -> () #

Hashable DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

hashWithSalt :: Int -> DescribeAutoMLJob -> Int #

hash :: DescribeAutoMLJob -> Int #

ToJSON DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

toJSON :: DescribeAutoMLJob -> Value #

toEncoding :: DescribeAutoMLJob -> Encoding #

toJSONList :: [DescribeAutoMLJob] -> Value #

toEncodingList :: [DescribeAutoMLJob] -> Encoding #

AWSRequest DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Associated Types

type AWSResponse DescribeAutoMLJob #

Methods

request :: DescribeAutoMLJob -> Request DescribeAutoMLJob #

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

ToHeaders DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

toHeaders :: DescribeAutoMLJob -> [Header] #

ToPath DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

toPath :: DescribeAutoMLJob -> ByteString #

ToQuery DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

toQuery :: DescribeAutoMLJob -> QueryString #

type Rep DescribeAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

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

Defined in Amazonka.SageMaker.DescribeAutoMLJob

type AWSResponse DescribeAutoMLJob = DescribeAutoMLJobResponse

newDescribeAutoMLJob Source #

Arguments

:: Text

$sel:autoMLJobName:DescribeAutoMLJob'

-> DescribeAutoMLJob 

Create a value of DescribeAutoMLJob 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:autoMLJobName:DescribeAutoMLJob', describeAutoMLJob_autoMLJobName - Requests information about an AutoML job using its unique name.

Request Lenses

describeAutoMLJob_autoMLJobName :: Lens' DescribeAutoMLJob Text Source #

Requests information about an AutoML job using its unique name.

Destructuring the Response

data DescribeAutoMLJobResponse Source #

See: newDescribeAutoMLJobResponse smart constructor.

Constructors

DescribeAutoMLJobResponse' 

Fields

Instances

Instances details
Eq DescribeAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

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

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

Read DescribeAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

readsPrec :: Int -> ReadS DescribeAutoMLJobResponse #

readList :: ReadS [DescribeAutoMLJobResponse] #

readPrec :: ReadPrec DescribeAutoMLJobResponse #

readListPrec :: ReadPrec [DescribeAutoMLJobResponse] #

Show DescribeAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

showsPrec :: Int -> DescribeAutoMLJobResponse -> ShowS #

show :: DescribeAutoMLJobResponse -> String #

showList :: [DescribeAutoMLJobResponse] -> ShowS #

Generic DescribeAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Associated Types

type Rep DescribeAutoMLJobResponse :: Type -> Type #

Methods

from :: DescribeAutoMLJobResponse -> Rep DescribeAutoMLJobResponse x #

to :: Rep DescribeAutoMLJobResponse x -> DescribeAutoMLJobResponse #

NFData DescribeAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

rnf :: DescribeAutoMLJobResponse -> () #

type Rep DescribeAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeAutoMLJob

type Rep DescribeAutoMLJobResponse = D1 ('MetaData "DescribeAutoMLJobResponse" "Amazonka.SageMaker.DescribeAutoMLJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeAutoMLJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "generateCandidateDefinitionsOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "partialFailureReasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AutoMLPartialFailureReason))) :*: (S1 ('MetaSel ('Just "modelDeployResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelDeployResult)) :*: S1 ('MetaSel ('Just "problemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProblemType))))) :*: ((S1 ('MetaSel ('Just "autoMLJobConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLJobConfig)) :*: (S1 ('MetaSel ('Just "autoMLJobObjective") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLJobObjective)) :*: S1 ('MetaSel ('Just "autoMLJobArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLJobArtifacts)))) :*: (S1 ('MetaSel ('Just "resolvedAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResolvedAttributes)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "bestCandidate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLCandidate)))))) :*: (((S1 ('MetaSel ('Just "modelDeployConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelDeployConfig)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "autoMLJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "autoMLJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty AutoMLChannel))))) :*: ((S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AutoMLOutputDataConfig) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :*: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "autoMLJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AutoMLJobStatus) :*: S1 ('MetaSel ('Just "autoMLJobSecondaryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AutoMLJobSecondaryStatus)))))))

newDescribeAutoMLJobResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeAutoMLJobResponse'

-> Text

$sel:autoMLJobName:DescribeAutoMLJob'

-> Text

$sel:autoMLJobArn:DescribeAutoMLJobResponse'

-> NonEmpty AutoMLChannel

$sel:inputDataConfig:DescribeAutoMLJobResponse'

-> AutoMLOutputDataConfig

$sel:outputDataConfig:DescribeAutoMLJobResponse'

-> Text

$sel:roleArn:DescribeAutoMLJobResponse'

-> UTCTime

$sel:creationTime:DescribeAutoMLJobResponse'

-> UTCTime

$sel:lastModifiedTime:DescribeAutoMLJobResponse'

-> AutoMLJobStatus

$sel:autoMLJobStatus:DescribeAutoMLJobResponse'

-> AutoMLJobSecondaryStatus

$sel:autoMLJobSecondaryStatus:DescribeAutoMLJobResponse'

-> DescribeAutoMLJobResponse 

Create a value of DescribeAutoMLJobResponse 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:generateCandidateDefinitionsOnly:DescribeAutoMLJobResponse', describeAutoMLJobResponse_generateCandidateDefinitionsOnly - Indicates whether the output for an AutoML job generates candidate definitions only.

$sel:failureReason:DescribeAutoMLJobResponse', describeAutoMLJobResponse_failureReason - Returns the failure reason for an AutoML job, when applicable.

$sel:partialFailureReasons:DescribeAutoMLJobResponse', describeAutoMLJobResponse_partialFailureReasons - Returns a list of reasons for partial failures within an AutoML job.

$sel:modelDeployResult:DescribeAutoMLJobResponse', describeAutoMLJobResponse_modelDeployResult - Provides information about endpoint for the model deployment.

$sel:problemType:DescribeAutoMLJobResponse', describeAutoMLJobResponse_problemType - Returns the job's problem type.

$sel:autoMLJobConfig:DescribeAutoMLJobResponse', describeAutoMLJobResponse_autoMLJobConfig - Returns the configuration for the AutoML job.

$sel:autoMLJobObjective:DescribeAutoMLJobResponse', describeAutoMLJobResponse_autoMLJobObjective - Returns the job's objective.

$sel:autoMLJobArtifacts:DescribeAutoMLJobResponse', describeAutoMLJobResponse_autoMLJobArtifacts - Returns information on the job's artifacts found in AutoMLJobArtifacts.

$sel:resolvedAttributes:DescribeAutoMLJobResponse', describeAutoMLJobResponse_resolvedAttributes - This contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are auto-inferred. If you do provide them, the values used are the ones you provide.

$sel:endTime:DescribeAutoMLJobResponse', describeAutoMLJobResponse_endTime - Returns the end time of the AutoML job.

$sel:bestCandidate:DescribeAutoMLJobResponse', describeAutoMLJobResponse_bestCandidate - Returns the job's best AutoMLCandidate.

$sel:modelDeployConfig:DescribeAutoMLJobResponse', describeAutoMLJobResponse_modelDeployConfig - Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

$sel:httpStatus:DescribeAutoMLJobResponse', describeAutoMLJobResponse_httpStatus - The response's http status code.

$sel:autoMLJobName:DescribeAutoMLJob', describeAutoMLJobResponse_autoMLJobName - Returns the name of the AutoML job.

$sel:autoMLJobArn:DescribeAutoMLJobResponse', describeAutoMLJobResponse_autoMLJobArn - Returns the ARN of the AutoML job.

$sel:inputDataConfig:DescribeAutoMLJobResponse', describeAutoMLJobResponse_inputDataConfig - Returns the input data configuration for the AutoML job..

$sel:outputDataConfig:DescribeAutoMLJobResponse', describeAutoMLJobResponse_outputDataConfig - Returns the job's output data config.

$sel:roleArn:DescribeAutoMLJobResponse', describeAutoMLJobResponse_roleArn - The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

$sel:creationTime:DescribeAutoMLJobResponse', describeAutoMLJobResponse_creationTime - Returns the creation time of the AutoML job.

$sel:lastModifiedTime:DescribeAutoMLJobResponse', describeAutoMLJobResponse_lastModifiedTime - Returns the job's last modified time.

$sel:autoMLJobStatus:DescribeAutoMLJobResponse', describeAutoMLJobResponse_autoMLJobStatus - Returns the status of the AutoML job.

$sel:autoMLJobSecondaryStatus:DescribeAutoMLJobResponse', describeAutoMLJobResponse_autoMLJobSecondaryStatus - Returns the secondary status of the AutoML job.

Response Lenses

describeAutoMLJobResponse_generateCandidateDefinitionsOnly :: Lens' DescribeAutoMLJobResponse (Maybe Bool) Source #

Indicates whether the output for an AutoML job generates candidate definitions only.

describeAutoMLJobResponse_failureReason :: Lens' DescribeAutoMLJobResponse (Maybe Text) Source #

Returns the failure reason for an AutoML job, when applicable.

describeAutoMLJobResponse_partialFailureReasons :: Lens' DescribeAutoMLJobResponse (Maybe (NonEmpty AutoMLPartialFailureReason)) Source #

Returns a list of reasons for partial failures within an AutoML job.

describeAutoMLJobResponse_modelDeployResult :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployResult) Source #

Provides information about endpoint for the model deployment.

describeAutoMLJobResponse_problemType :: Lens' DescribeAutoMLJobResponse (Maybe ProblemType) Source #

Returns the job's problem type.

describeAutoMLJobResponse_autoMLJobConfig :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobConfig) Source #

Returns the configuration for the AutoML job.

describeAutoMLJobResponse_autoMLJobObjective :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobObjective) Source #

Returns the job's objective.

describeAutoMLJobResponse_autoMLJobArtifacts :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobArtifacts) Source #

Returns information on the job's artifacts found in AutoMLJobArtifacts.

describeAutoMLJobResponse_resolvedAttributes :: Lens' DescribeAutoMLJobResponse (Maybe ResolvedAttributes) Source #

This contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are auto-inferred. If you do provide them, the values used are the ones you provide.

describeAutoMLJobResponse_endTime :: Lens' DescribeAutoMLJobResponse (Maybe UTCTime) Source #

Returns the end time of the AutoML job.

describeAutoMLJobResponse_bestCandidate :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLCandidate) Source #

Returns the job's best AutoMLCandidate.

describeAutoMLJobResponse_modelDeployConfig :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployConfig) Source #

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

describeAutoMLJobResponse_httpStatus :: Lens' DescribeAutoMLJobResponse Int Source #

The response's http status code.

describeAutoMLJobResponse_autoMLJobName :: Lens' DescribeAutoMLJobResponse Text Source #

Returns the name of the AutoML job.

describeAutoMLJobResponse_autoMLJobArn :: Lens' DescribeAutoMLJobResponse Text Source #

Returns the ARN of the AutoML job.

describeAutoMLJobResponse_inputDataConfig :: Lens' DescribeAutoMLJobResponse (NonEmpty AutoMLChannel) Source #

Returns the input data configuration for the AutoML job..

describeAutoMLJobResponse_outputDataConfig :: Lens' DescribeAutoMLJobResponse AutoMLOutputDataConfig Source #

Returns the job's output data config.

describeAutoMLJobResponse_roleArn :: Lens' DescribeAutoMLJobResponse Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

describeAutoMLJobResponse_creationTime :: Lens' DescribeAutoMLJobResponse UTCTime Source #

Returns the creation time of the AutoML job.

describeAutoMLJobResponse_lastModifiedTime :: Lens' DescribeAutoMLJobResponse UTCTime Source #

Returns the job's last modified time.

describeAutoMLJobResponse_autoMLJobStatus :: Lens' DescribeAutoMLJobResponse AutoMLJobStatus Source #

Returns the status of the AutoML job.

describeAutoMLJobResponse_autoMLJobSecondaryStatus :: Lens' DescribeAutoMLJobResponse AutoMLJobSecondaryStatus Source #

Returns the secondary status of the AutoML job.