| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SageMaker.DescribeAutoMLJob
Description
Returns information about an Amazon SageMaker AutoML job.
Synopsis
- data DescribeAutoMLJob = DescribeAutoMLJob' {}
- newDescribeAutoMLJob :: Text -> DescribeAutoMLJob
- describeAutoMLJob_autoMLJobName :: Lens' DescribeAutoMLJob Text
- data DescribeAutoMLJobResponse = DescribeAutoMLJobResponse' {
- autoMLJobArtifacts :: Maybe AutoMLJobArtifacts
- autoMLJobConfig :: Maybe AutoMLJobConfig
- autoMLJobObjective :: Maybe AutoMLJobObjective
- bestCandidate :: Maybe AutoMLCandidate
- endTime :: Maybe POSIX
- failureReason :: Maybe Text
- generateCandidateDefinitionsOnly :: Maybe Bool
- modelDeployConfig :: Maybe ModelDeployConfig
- modelDeployResult :: Maybe ModelDeployResult
- partialFailureReasons :: Maybe (NonEmpty AutoMLPartialFailureReason)
- problemType :: Maybe ProblemType
- resolvedAttributes :: Maybe ResolvedAttributes
- httpStatus :: Int
- autoMLJobName :: Text
- autoMLJobArn :: Text
- inputDataConfig :: NonEmpty AutoMLChannel
- outputDataConfig :: AutoMLOutputDataConfig
- roleArn :: Text
- creationTime :: POSIX
- lastModifiedTime :: POSIX
- autoMLJobStatus :: AutoMLJobStatus
- autoMLJobSecondaryStatus :: AutoMLJobSecondaryStatus
- newDescribeAutoMLJobResponse :: Int -> Text -> Text -> NonEmpty AutoMLChannel -> AutoMLOutputDataConfig -> Text -> UTCTime -> UTCTime -> AutoMLJobStatus -> AutoMLJobSecondaryStatus -> DescribeAutoMLJobResponse
- describeAutoMLJobResponse_autoMLJobArtifacts :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobArtifacts)
- describeAutoMLJobResponse_autoMLJobConfig :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobConfig)
- describeAutoMLJobResponse_autoMLJobObjective :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobObjective)
- describeAutoMLJobResponse_bestCandidate :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLCandidate)
- describeAutoMLJobResponse_endTime :: Lens' DescribeAutoMLJobResponse (Maybe UTCTime)
- describeAutoMLJobResponse_failureReason :: Lens' DescribeAutoMLJobResponse (Maybe Text)
- describeAutoMLJobResponse_generateCandidateDefinitionsOnly :: Lens' DescribeAutoMLJobResponse (Maybe Bool)
- describeAutoMLJobResponse_modelDeployConfig :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployConfig)
- describeAutoMLJobResponse_modelDeployResult :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployResult)
- describeAutoMLJobResponse_partialFailureReasons :: Lens' DescribeAutoMLJobResponse (Maybe (NonEmpty AutoMLPartialFailureReason))
- describeAutoMLJobResponse_problemType :: Lens' DescribeAutoMLJobResponse (Maybe ProblemType)
- describeAutoMLJobResponse_resolvedAttributes :: Lens' DescribeAutoMLJobResponse (Maybe ResolvedAttributes)
- describeAutoMLJobResponse_httpStatus :: Lens' DescribeAutoMLJobResponse Int
- describeAutoMLJobResponse_autoMLJobName :: Lens' DescribeAutoMLJobResponse Text
- describeAutoMLJobResponse_autoMLJobArn :: Lens' DescribeAutoMLJobResponse Text
- describeAutoMLJobResponse_inputDataConfig :: Lens' DescribeAutoMLJobResponse (NonEmpty AutoMLChannel)
- describeAutoMLJobResponse_outputDataConfig :: Lens' DescribeAutoMLJobResponse AutoMLOutputDataConfig
- describeAutoMLJobResponse_roleArn :: Lens' DescribeAutoMLJobResponse Text
- describeAutoMLJobResponse_creationTime :: Lens' DescribeAutoMLJobResponse UTCTime
- describeAutoMLJobResponse_lastModifiedTime :: Lens' DescribeAutoMLJobResponse UTCTime
- describeAutoMLJobResponse_autoMLJobStatus :: Lens' DescribeAutoMLJobResponse AutoMLJobStatus
- describeAutoMLJobResponse_autoMLJobSecondaryStatus :: Lens' DescribeAutoMLJobResponse AutoMLJobSecondaryStatus
Creating a Request
data DescribeAutoMLJob Source #
See: newDescribeAutoMLJob smart constructor.
Constructors
| DescribeAutoMLJob' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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 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
newDescribeAutoMLJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> NonEmpty AutoMLChannel | |
| -> AutoMLOutputDataConfig | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> AutoMLJobStatus | |
| -> AutoMLJobSecondaryStatus | |
| -> 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) Source #
Returns information on the job's artifacts found in
AutoMLJobArtifacts.
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_bestCandidate :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLCandidate) Source #
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) Source #
Returns the end time of the AutoML job.
describeAutoMLJobResponse_failureReason :: Lens' DescribeAutoMLJobResponse (Maybe Text) Source #
Returns the failure reason for an AutoML job, when applicable.
describeAutoMLJobResponse_generateCandidateDefinitionsOnly :: Lens' DescribeAutoMLJobResponse (Maybe Bool) Source #
Indicates whether the output for an AutoML job generates candidate definitions only.
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_modelDeployResult :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployResult) Source #
Provides information about endpoint for the model deployment.
describeAutoMLJobResponse_partialFailureReasons :: Lens' DescribeAutoMLJobResponse (Maybe (NonEmpty AutoMLPartialFailureReason)) Source #
Returns a list of reasons for partial failures within an AutoML job.
describeAutoMLJobResponse_problemType :: Lens' DescribeAutoMLJobResponse (Maybe ProblemType) Source #
Returns the job's problem type.
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_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 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.