Amazonka.SageMaker.DescribeAutoMLJob

Returns information about an Amazon SageMaker AutoML job.

Creating a Request

data DescribeAutoMLJob

See: newDescribeAutoMLJob smart constructor.

Constructors

DescribeAutoMLJob'

Fields

• autoMLJobName :: Text

  Requests information about an AutoML job using its unique name.

Instances

ToJSON DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

toJSON :: DescribeAutoMLJob -> Value

toEncoding :: DescribeAutoMLJob -> Encoding

toJSONList :: [DescribeAutoMLJob] -> Value

toEncodingList :: [DescribeAutoMLJob] -> Encoding

ToHeaders DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

toHeaders :: DescribeAutoMLJob -> [Header]

ToPath DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

toPath :: DescribeAutoMLJob -> ByteString

ToQuery DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

toQuery :: DescribeAutoMLJob -> QueryString

AWSRequest DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Associated Types

type AWSResponse DescribeAutoMLJob

Methods

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

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

Generic DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Associated Types

type Rep DescribeAutoMLJob :: Type -> Type

Methods

from :: DescribeAutoMLJob -> Rep DescribeAutoMLJob x

to :: Rep DescribeAutoMLJob x -> DescribeAutoMLJob

Read DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

readsPrec :: Int -> ReadS DescribeAutoMLJob

readList :: ReadS [DescribeAutoMLJob]

readPrec :: ReadPrec DescribeAutoMLJob

readListPrec :: ReadPrec [DescribeAutoMLJob]

Show DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

showsPrec :: Int -> DescribeAutoMLJob -> ShowS

show :: DescribeAutoMLJob -> String

showList :: [DescribeAutoMLJob] -> ShowS

NFData DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

rnf :: DescribeAutoMLJob -> ()

Eq DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

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

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

Hashable DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

hashWithSalt :: Int -> DescribeAutoMLJob -> Int

hash :: DescribeAutoMLJob -> Int

type AWSResponse DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

type AWSResponse DescribeAutoMLJob = DescribeAutoMLJobResponse

type Rep DescribeAutoMLJob

Defined in Amazonka.SageMaker.DescribeAutoMLJob

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

newDescribeAutoMLJob

Arguments

:: Text

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:

DescribeAutoMLJob, describeAutoMLJob_autoMLJobName - Requests information about an AutoML job using its unique name.

Request Lenses

describeAutoMLJob_autoMLJobName :: Lens' DescribeAutoMLJob Text

Requests information about an AutoML job using its unique name.

Destructuring the Response

data DescribeAutoMLJobResponse

See: newDescribeAutoMLJobResponse smart constructor.

Constructors

DescribeAutoMLJobResponse'

Fields

• autoMLJobArtifacts :: Maybe AutoMLJobArtifacts

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

• autoMLJobConfig :: Maybe AutoMLJobConfig

  Returns the configuration for the AutoML job.

• autoMLJobObjective :: Maybe AutoMLJobObjective

  Returns the job's objective.

• bestCandidate :: Maybe AutoMLCandidate

  The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

• endTime :: Maybe POSIX

  Returns the end time of the AutoML job.

• failureReason :: Maybe Text

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

• generateCandidateDefinitionsOnly :: Maybe Bool

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

• modelDeployConfig :: Maybe ModelDeployConfig

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

• modelDeployResult :: Maybe ModelDeployResult

  Provides information about endpoint for the model deployment.

• partialFailureReasons :: Maybe (NonEmpty AutoMLPartialFailureReason)

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

• problemType :: Maybe ProblemType

  Returns the job's problem type.

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

• httpStatus :: Int

  The response's http status code.

• autoMLJobName :: Text

  Returns the name of the AutoML job.

• autoMLJobArn :: Text

  Returns the ARN of the AutoML job.

• inputDataConfig :: NonEmpty AutoMLChannel

  Returns the input data configuration for the AutoML job..

• outputDataConfig :: AutoMLOutputDataConfig

  Returns the job's output data config.

• roleArn :: Text

  The Amazon Resource Name (ARN) of the 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.

• creationTime :: POSIX

  Returns the creation time of the AutoML job.

• lastModifiedTime :: POSIX

  Returns the job's last modified time.

• autoMLJobStatus :: AutoMLJobStatus

  Returns the status of the AutoML job.

• autoMLJobSecondaryStatus :: AutoMLJobSecondaryStatus

  Returns the secondary status of the AutoML job.

Instances

Generic DescribeAutoMLJobResponse

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Associated Types

type Rep DescribeAutoMLJobResponse :: Type -> Type

Methods

from :: DescribeAutoMLJobResponse -> Rep DescribeAutoMLJobResponse x

to :: Rep DescribeAutoMLJobResponse x -> DescribeAutoMLJobResponse

Read DescribeAutoMLJobResponse

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

readsPrec :: Int -> ReadS DescribeAutoMLJobResponse

readList :: ReadS [DescribeAutoMLJobResponse]

readPrec :: ReadPrec DescribeAutoMLJobResponse

readListPrec :: ReadPrec [DescribeAutoMLJobResponse]

Show DescribeAutoMLJobResponse

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

showsPrec :: Int -> DescribeAutoMLJobResponse -> ShowS

show :: DescribeAutoMLJobResponse -> String

showList :: [DescribeAutoMLJobResponse] -> ShowS

NFData DescribeAutoMLJobResponse

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

rnf :: DescribeAutoMLJobResponse -> ()

Eq DescribeAutoMLJobResponse

Defined in Amazonka.SageMaker.DescribeAutoMLJob

Methods

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

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

type Rep DescribeAutoMLJobResponse

Defined in Amazonka.SageMaker.DescribeAutoMLJob

type Rep DescribeAutoMLJobResponse = D1 ('MetaData "DescribeAutoMLJobResponse" "Amazonka.SageMaker.DescribeAutoMLJob" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeAutoMLJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "autoMLJobArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLJobArtifacts)) :*: S1 ('MetaSel ('Just "autoMLJobConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLJobConfig))) :*: (S1 ('MetaSel ('Just "autoMLJobObjective") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLJobObjective)) :*: (S1 ('MetaSel ('Just "bestCandidate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLCandidate)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "generateCandidateDefinitionsOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "modelDeployConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelDeployConfig)))) :*: (S1 ('MetaSel ('Just "modelDeployResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelDeployResult)) :*: (S1 ('MetaSel ('Just "partialFailureReasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AutoMLPartialFailureReason))) :*: S1 ('MetaSel ('Just "problemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProblemType)))))) :*: (((S1 ('MetaSel ('Just "resolvedAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResolvedAttributes)) :*: 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

Arguments

:: Int

$sel:httpStatus:DescribeAutoMLJobResponse'

-> Text

DescribeAutoMLJob

-> Text

DescribeAutoMLJobResponse

-> NonEmpty AutoMLChannel

DescribeAutoMLJobResponse

-> AutoMLOutputDataConfig

DescribeAutoMLJobResponse

-> Text

DescribeAutoMLJobResponse

-> UTCTime

DescribeAutoMLJobResponse

-> UTCTime

DescribeAutoMLJobResponse

-> AutoMLJobStatus

DescribeAutoMLJobResponse

-> 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:autoMLJobArtifacts:DescribeAutoMLJobResponse', describeAutoMLJobResponse_autoMLJobArtifacts - Returns information on the job's artifacts found in AutoMLJobArtifacts.

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

DescribeAutoMLJobResponse, describeAutoMLJobResponse_autoMLJobObjective - Returns the job's objective.

$sel:bestCandidate:DescribeAutoMLJobResponse', describeAutoMLJobResponse_bestCandidate - The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_endTime - Returns the end time of the AutoML job.

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

$sel:generateCandidateDefinitionsOnly:DescribeAutoMLJobResponse', describeAutoMLJobResponse_generateCandidateDefinitionsOnly - Indicates whether the output for an AutoML job generates candidate definitions only.

$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:modelDeployResult:DescribeAutoMLJobResponse', describeAutoMLJobResponse_modelDeployResult - Provides information about endpoint for the model deployment.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_partialFailureReasons - Returns a list of reasons for partial failures within an AutoML job.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_problemType - Returns the job's problem type.

$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:httpStatus:DescribeAutoMLJobResponse', describeAutoMLJobResponse_httpStatus - The response's http status code.

DescribeAutoMLJob, describeAutoMLJobResponse_autoMLJobName - Returns the name of the AutoML job.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_autoMLJobArn - Returns the ARN of the AutoML job.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_inputDataConfig - Returns the input data configuration for the AutoML job..

DescribeAutoMLJobResponse, describeAutoMLJobResponse_outputDataConfig - Returns the job's output data config.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_roleArn - The Amazon Resource Name (ARN) of the 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, describeAutoMLJobResponse_creationTime - Returns the creation time of the AutoML job.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_lastModifiedTime - Returns the job's last modified time.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_autoMLJobStatus - Returns the status of the AutoML job.

DescribeAutoMLJobResponse, describeAutoMLJobResponse_autoMLJobSecondaryStatus - Returns the secondary status of the AutoML job.

Response Lenses

describeAutoMLJobResponse_autoMLJobArtifacts :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobArtifacts)

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

describeAutoMLJobResponse_autoMLJobConfig :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobConfig)

Returns the configuration for the AutoML job.

describeAutoMLJobResponse_autoMLJobObjective :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobObjective)

Returns the job's objective.

describeAutoMLJobResponse_bestCandidate :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLCandidate)

The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

describeAutoMLJobResponse_endTime :: Lens' DescribeAutoMLJobResponse (Maybe UTCTime)

Returns the end time of the AutoML job.

describeAutoMLJobResponse_failureReason :: Lens' DescribeAutoMLJobResponse (Maybe Text)

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

describeAutoMLJobResponse_generateCandidateDefinitionsOnly :: Lens' DescribeAutoMLJobResponse (Maybe Bool)

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

describeAutoMLJobResponse_modelDeployConfig :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployConfig)

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

describeAutoMLJobResponse_modelDeployResult :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployResult)

Provides information about endpoint for the model deployment.

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

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

describeAutoMLJobResponse_problemType :: Lens' DescribeAutoMLJobResponse (Maybe ProblemType)

Returns the job's problem type.

describeAutoMLJobResponse_resolvedAttributes :: Lens' DescribeAutoMLJobResponse (Maybe 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.

describeAutoMLJobResponse_httpStatus :: Lens' DescribeAutoMLJobResponse Int

The response's http status code.

describeAutoMLJobResponse_autoMLJobName :: Lens' DescribeAutoMLJobResponse Text

Returns the name of the AutoML job.

describeAutoMLJobResponse_autoMLJobArn :: Lens' DescribeAutoMLJobResponse Text

Returns the ARN of the AutoML job.

describeAutoMLJobResponse_inputDataConfig :: Lens' DescribeAutoMLJobResponse (NonEmpty AutoMLChannel)

Returns the input data configuration for the AutoML job..

describeAutoMLJobResponse_outputDataConfig :: Lens' DescribeAutoMLJobResponse AutoMLOutputDataConfig

Returns the job's output data config.

describeAutoMLJobResponse_roleArn :: Lens' DescribeAutoMLJobResponse Text

The Amazon Resource Name (ARN) of the 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

Returns the creation time of the AutoML job.

describeAutoMLJobResponse_lastModifiedTime :: Lens' DescribeAutoMLJobResponse UTCTime

Returns the job's last modified time.

describeAutoMLJobResponse_autoMLJobStatus :: Lens' DescribeAutoMLJobResponse AutoMLJobStatus

Returns the status of the AutoML job.

describeAutoMLJobResponse_autoMLJobSecondaryStatus :: Lens' DescribeAutoMLJobResponse AutoMLJobSecondaryStatus

Returns the secondary status of the AutoML job.