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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a recommendation job. You can create either an instance recommendation or load test job.

Synopsis

Creating a Request

data CreateInferenceRecommendationsJob Source #

See: newCreateInferenceRecommendationsJob smart constructor.

Constructors

CreateInferenceRecommendationsJob'

Fields

jobDescription :: Maybe Text
Description of the recommendation job.
outputConfig :: Maybe RecommendationJobOutputConfig
Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
stoppingConditions :: Maybe RecommendationJobStoppingConditions
A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
tags :: Maybe [Tag]
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
jobName :: Text
A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
jobType :: RecommendationJobType
Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
roleArn :: Text
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
inputConfig :: RecommendationJobInputConfig
Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

Instances

Instances details

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

newCreateInferenceRecommendationsJob Source #

Arguments

:: Text	`CreateInferenceRecommendationsJob`
-> RecommendationJobType	`CreateInferenceRecommendationsJob`
-> Text	`CreateInferenceRecommendationsJob`
-> RecommendationJobInputConfig	`CreateInferenceRecommendationsJob`
-> CreateInferenceRecommendationsJob

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

CreateInferenceRecommendationsJob, createInferenceRecommendationsJob_jobDescription - Description of the recommendation job.

CreateInferenceRecommendationsJob, createInferenceRecommendationsJob_outputConfig - Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

$sel:stoppingConditions:CreateInferenceRecommendationsJob', createInferenceRecommendationsJob_stoppingConditions - A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

CreateInferenceRecommendationsJob, createInferenceRecommendationsJob_tags - The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

CreateInferenceRecommendationsJob, createInferenceRecommendationsJob_jobName - A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

CreateInferenceRecommendationsJob, createInferenceRecommendationsJob_jobType - Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

CreateInferenceRecommendationsJob, createInferenceRecommendationsJob_roleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

CreateInferenceRecommendationsJob, createInferenceRecommendationsJob_inputConfig - Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

Request Lenses

createInferenceRecommendationsJob_jobDescription :: Lens' CreateInferenceRecommendationsJob (Maybe Text) Source #

Description of the recommendation job.

createInferenceRecommendationsJob_outputConfig :: Lens' CreateInferenceRecommendationsJob (Maybe RecommendationJobOutputConfig) Source #

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

createInferenceRecommendationsJob_stoppingConditions :: Lens' CreateInferenceRecommendationsJob (Maybe RecommendationJobStoppingConditions) Source #

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

createInferenceRecommendationsJob_tags :: Lens' CreateInferenceRecommendationsJob (Maybe [Tag]) Source #

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

createInferenceRecommendationsJob_jobName :: Lens' CreateInferenceRecommendationsJob Text Source #

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

createInferenceRecommendationsJob_jobType :: Lens' CreateInferenceRecommendationsJob RecommendationJobType Source #

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

createInferenceRecommendationsJob_roleArn :: Lens' CreateInferenceRecommendationsJob Text Source #

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

createInferenceRecommendationsJob_inputConfig :: Lens' CreateInferenceRecommendationsJob RecommendationJobInputConfig Source #

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

Destructuring the Response

data CreateInferenceRecommendationsJobResponse Source #

See: newCreateInferenceRecommendationsJobResponse smart constructor.

Constructors

CreateInferenceRecommendationsJobResponse'
Fields httpStatus :: Int The response's http status code. jobArn :: Text The Amazon Resource Name (ARN) of the recommendation job.

Instances

Instances details

Generic CreateInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateInferenceRecommendationsJob Associated Types type Rep CreateInferenceRecommendationsJobResponse :: Type -> Type # Methods from :: CreateInferenceRecommendationsJobResponse -> Rep CreateInferenceRecommendationsJobResponse x # to :: Rep CreateInferenceRecommendationsJobResponse x -> CreateInferenceRecommendationsJobResponse #
Read CreateInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateInferenceRecommendationsJob Methods readsPrec :: Int -> ReadS CreateInferenceRecommendationsJobResponse # readList :: ReadS [CreateInferenceRecommendationsJobResponse] # readPrec :: ReadPrec CreateInferenceRecommendationsJobResponse # readListPrec :: ReadPrec [CreateInferenceRecommendationsJobResponse] #
Show CreateInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateInferenceRecommendationsJob Methods showsPrec :: Int -> CreateInferenceRecommendationsJobResponse -> ShowS # show :: CreateInferenceRecommendationsJobResponse -> String # showList :: [CreateInferenceRecommendationsJobResponse] -> ShowS #
NFData CreateInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateInferenceRecommendationsJob Methods rnf :: CreateInferenceRecommendationsJobResponse -> () #
Eq CreateInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateInferenceRecommendationsJob Methods (==) :: CreateInferenceRecommendationsJobResponse -> CreateInferenceRecommendationsJobResponse -> Bool # (/=) :: CreateInferenceRecommendationsJobResponse -> CreateInferenceRecommendationsJobResponse -> Bool #
type Rep CreateInferenceRecommendationsJobResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateInferenceRecommendationsJob type Rep CreateInferenceRecommendationsJobResponse = D1 ('MetaData "CreateInferenceRecommendationsJobResponse" "Amazonka.SageMaker.CreateInferenceRecommendationsJob" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateInferenceRecommendationsJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateInferenceRecommendationsJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateInferenceRecommendationsJobResponse'`
-> Text	`CreateInferenceRecommendationsJobResponse`
-> CreateInferenceRecommendationsJobResponse

Create a value of CreateInferenceRecommendationsJobResponse 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:httpStatus:CreateInferenceRecommendationsJobResponse', createInferenceRecommendationsJobResponse_httpStatus - The response's http status code.

CreateInferenceRecommendationsJobResponse, createInferenceRecommendationsJobResponse_jobArn - The Amazon Resource Name (ARN) of the recommendation job.

Response Lenses

createInferenceRecommendationsJobResponse_httpStatus :: Lens' CreateInferenceRecommendationsJobResponse Int Source #

The response's http status code.

createInferenceRecommendationsJobResponse_jobArn :: Lens' CreateInferenceRecommendationsJobResponse Text Source #

The Amazon Resource Name (ARN) of the recommendation job.