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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

Synopsis

Creating a Request

data DescribeInferenceRecommendationsJob Source #

See: newDescribeInferenceRecommendationsJob smart constructor.

Constructors

DescribeInferenceRecommendationsJob'
Fields jobName :: Text The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

Instances

Instances details

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

newDescribeInferenceRecommendationsJob Source #

Arguments

:: Text	`DescribeInferenceRecommendationsJob`
-> DescribeInferenceRecommendationsJob

Create a value of DescribeInferenceRecommendationsJob 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:

DescribeInferenceRecommendationsJob, describeInferenceRecommendationsJob_jobName - The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

Request Lenses

describeInferenceRecommendationsJob_jobName :: Lens' DescribeInferenceRecommendationsJob Text Source #

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

Destructuring the Response

data DescribeInferenceRecommendationsJobResponse Source #

See: newDescribeInferenceRecommendationsJobResponse smart constructor.

Constructors

DescribeInferenceRecommendationsJobResponse'

Fields

completionTime :: Maybe POSIX
A timestamp that shows when the job completed.
endpointPerformances :: Maybe [EndpointPerformance]
The performance results from running an Inference Recommender job on an existing endpoint.
failureReason :: Maybe Text
If the job fails, provides information why the job failed.
inferenceRecommendations :: Maybe (NonEmpty InferenceRecommendation)
The recommendations made by Inference Recommender.
jobDescription :: Maybe Text
The job description that you provided when you initiated the job.
stoppingConditions :: Maybe RecommendationJobStoppingConditions
The stopping conditions that you provided when you initiated the job.
httpStatus :: Int
The response's http status code.
jobName :: Text
The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
jobType :: RecommendationJobType
The job type that you provided when you initiated the job.
jobArn :: Text
The Amazon Resource Name (ARN) of the job.
roleArn :: Text
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.
status :: RecommendationJobStatus
The status of the job.
creationTime :: POSIX
A timestamp that shows when the job was created.
lastModifiedTime :: POSIX
A timestamp that shows when the job was last modified.
inputConfig :: RecommendationJobInputConfig
Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

Instances

Instances details

Generic DescribeInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeInferenceRecommendationsJob Associated Types type Rep DescribeInferenceRecommendationsJobResponse :: Type -> Type # Methods from :: DescribeInferenceRecommendationsJobResponse -> Rep DescribeInferenceRecommendationsJobResponse x # to :: Rep DescribeInferenceRecommendationsJobResponse x -> DescribeInferenceRecommendationsJobResponse #
Read DescribeInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeInferenceRecommendationsJob Methods readsPrec :: Int -> ReadS DescribeInferenceRecommendationsJobResponse # readList :: ReadS [DescribeInferenceRecommendationsJobResponse] # readPrec :: ReadPrec DescribeInferenceRecommendationsJobResponse # readListPrec :: ReadPrec [DescribeInferenceRecommendationsJobResponse] #
Show DescribeInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeInferenceRecommendationsJob Methods showsPrec :: Int -> DescribeInferenceRecommendationsJobResponse -> ShowS # show :: DescribeInferenceRecommendationsJobResponse -> String # showList :: [DescribeInferenceRecommendationsJobResponse] -> ShowS #
NFData DescribeInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeInferenceRecommendationsJob Methods rnf :: DescribeInferenceRecommendationsJobResponse -> () #
Eq DescribeInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeInferenceRecommendationsJob Methods (==) :: DescribeInferenceRecommendationsJobResponse -> DescribeInferenceRecommendationsJobResponse -> Bool # (/=) :: DescribeInferenceRecommendationsJobResponse -> DescribeInferenceRecommendationsJobResponse -> Bool #
type Rep DescribeInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeInferenceRecommendationsJob type Rep DescribeInferenceRecommendationsJobResponse = D1 ('MetaData "DescribeInferenceRecommendationsJobResponse" "Amazonka.SageMaker.DescribeInferenceRecommendationsJob" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeInferenceRecommendationsJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "completionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "endpointPerformances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointPerformance])) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "inferenceRecommendations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty InferenceRecommendation))) :: S1 ('MetaSel ('Just "jobDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stoppingConditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationJobStoppingConditions)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :: (((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecommendationJobType)) :: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecommendationJobStatus) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "inputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecommendationJobInputConfig))))))

newDescribeInferenceRecommendationsJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeInferenceRecommendationsJobResponse'`
-> Text	`DescribeInferenceRecommendationsJob`
-> RecommendationJobType	`DescribeInferenceRecommendationsJobResponse`
-> Text	`DescribeInferenceRecommendationsJobResponse`
-> Text	`DescribeInferenceRecommendationsJobResponse`
-> RecommendationJobStatus	`DescribeInferenceRecommendationsJobResponse`
-> UTCTime	`DescribeInferenceRecommendationsJobResponse`
-> UTCTime	`DescribeInferenceRecommendationsJobResponse`
-> RecommendationJobInputConfig	`DescribeInferenceRecommendationsJobResponse`
-> DescribeInferenceRecommendationsJobResponse

Create a value of DescribeInferenceRecommendationsJobResponse 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:

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_completionTime - A timestamp that shows when the job completed.

$sel:endpointPerformances:DescribeInferenceRecommendationsJobResponse', describeInferenceRecommendationsJobResponse_endpointPerformances - The performance results from running an Inference Recommender job on an existing endpoint.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_failureReason - If the job fails, provides information why the job failed.

$sel:inferenceRecommendations:DescribeInferenceRecommendationsJobResponse', describeInferenceRecommendationsJobResponse_inferenceRecommendations - The recommendations made by Inference Recommender.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_jobDescription - The job description that you provided when you initiated the job.

$sel:stoppingConditions:DescribeInferenceRecommendationsJobResponse', describeInferenceRecommendationsJobResponse_stoppingConditions - The stopping conditions that you provided when you initiated the job.

$sel:httpStatus:DescribeInferenceRecommendationsJobResponse', describeInferenceRecommendationsJobResponse_httpStatus - The response's http status code.

DescribeInferenceRecommendationsJob, describeInferenceRecommendationsJobResponse_jobName - The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_jobType - The job type that you provided when you initiated the job.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_jobArn - The Amazon Resource Name (ARN) of the job.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_roleArn - The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_status - The status of the job.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_creationTime - A timestamp that shows when the job was created.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_lastModifiedTime - A timestamp that shows when the job was last modified.

DescribeInferenceRecommendationsJobResponse, describeInferenceRecommendationsJobResponse_inputConfig - Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

Response Lenses

describeInferenceRecommendationsJobResponse_completionTime :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe UTCTime) Source #

A timestamp that shows when the job completed.

describeInferenceRecommendationsJobResponse_endpointPerformances :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe [EndpointPerformance]) Source #

The performance results from running an Inference Recommender job on an existing endpoint.

describeInferenceRecommendationsJobResponse_failureReason :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe Text) Source #

If the job fails, provides information why the job failed.

describeInferenceRecommendationsJobResponse_inferenceRecommendations :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe (NonEmpty InferenceRecommendation)) Source #

The recommendations made by Inference Recommender.

describeInferenceRecommendationsJobResponse_jobDescription :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe Text) Source #

The job description that you provided when you initiated the job.

describeInferenceRecommendationsJobResponse_stoppingConditions :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe RecommendationJobStoppingConditions) Source #

The stopping conditions that you provided when you initiated the job.

describeInferenceRecommendationsJobResponse_httpStatus :: Lens' DescribeInferenceRecommendationsJobResponse Int Source #

The response's http status code.

describeInferenceRecommendationsJobResponse_jobName :: Lens' DescribeInferenceRecommendationsJobResponse Text Source #

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeInferenceRecommendationsJobResponse_jobType :: Lens' DescribeInferenceRecommendationsJobResponse RecommendationJobType Source #

The job type that you provided when you initiated the job.

describeInferenceRecommendationsJobResponse_jobArn :: Lens' DescribeInferenceRecommendationsJobResponse Text Source #

The Amazon Resource Name (ARN) of the job.

describeInferenceRecommendationsJobResponse_roleArn :: Lens' DescribeInferenceRecommendationsJobResponse Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

describeInferenceRecommendationsJobResponse_status :: Lens' DescribeInferenceRecommendationsJobResponse RecommendationJobStatus Source #

The status of the job.

describeInferenceRecommendationsJobResponse_creationTime :: Lens' DescribeInferenceRecommendationsJobResponse UTCTime Source #

A timestamp that shows when the job was created.

describeInferenceRecommendationsJobResponse_lastModifiedTime :: Lens' DescribeInferenceRecommendationsJobResponse UTCTime Source #

A timestamp that shows when the job was last modified.

describeInferenceRecommendationsJobResponse_inputConfig :: Lens' DescribeInferenceRecommendationsJobResponse RecommendationJobInputConfig Source #

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.