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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates the definition for a model explainability job.

Synopsis

Creating a Request

data CreateModelExplainabilityJobDefinition Source #

See: newCreateModelExplainabilityJobDefinition smart constructor.

Constructors

CreateModelExplainabilityJobDefinition'

Fields

modelExplainabilityBaselineConfig :: Maybe ModelExplainabilityBaselineConfig
The baseline configuration for a model explainability job.
networkConfig :: Maybe MonitoringNetworkConfig
Networking options for a model explainability job.
stoppingCondition :: Maybe MonitoringStoppingCondition
tags :: Maybe [Tag]
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
jobDefinitionName :: Text
The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
modelExplainabilityAppSpecification :: ModelExplainabilityAppSpecification
Configures the model explainability job to run a specified Docker container image.
modelExplainabilityJobInput :: ModelExplainabilityJobInput
Inputs for the model explainability job.
modelExplainabilityJobOutputConfig :: MonitoringOutputConfig
jobResources :: MonitoringResources
roleArn :: Text
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Instances

Instances details

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

newCreateModelExplainabilityJobDefinition Source #

Arguments

:: Text	`$sel:jobDefinitionName:CreateModelExplainabilityJobDefinition'`
-> ModelExplainabilityAppSpecification	`$sel:modelExplainabilityAppSpecification:CreateModelExplainabilityJobDefinition'`
-> ModelExplainabilityJobInput	`$sel:modelExplainabilityJobInput:CreateModelExplainabilityJobDefinition'`
-> MonitoringOutputConfig	`$sel:modelExplainabilityJobOutputConfig:CreateModelExplainabilityJobDefinition'`
-> MonitoringResources	`$sel:jobResources:CreateModelExplainabilityJobDefinition'`
-> Text	`CreateModelExplainabilityJobDefinition`
-> CreateModelExplainabilityJobDefinition

Create a value of CreateModelExplainabilityJobDefinition 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:modelExplainabilityBaselineConfig:CreateModelExplainabilityJobDefinition', createModelExplainabilityJobDefinition_modelExplainabilityBaselineConfig - The baseline configuration for a model explainability job.

CreateModelExplainabilityJobDefinition, createModelExplainabilityJobDefinition_networkConfig - Networking options for a model explainability job.

CreateModelExplainabilityJobDefinition, createModelExplainabilityJobDefinition_stoppingCondition - Undocumented member.

CreateModelExplainabilityJobDefinition, createModelExplainabilityJobDefinition_tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

$sel:jobDefinitionName:CreateModelExplainabilityJobDefinition', createModelExplainabilityJobDefinition_jobDefinitionName - The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

$sel:modelExplainabilityAppSpecification:CreateModelExplainabilityJobDefinition', createModelExplainabilityJobDefinition_modelExplainabilityAppSpecification - Configures the model explainability job to run a specified Docker container image.

$sel:modelExplainabilityJobInput:CreateModelExplainabilityJobDefinition', createModelExplainabilityJobDefinition_modelExplainabilityJobInput - Inputs for the model explainability job.

$sel:modelExplainabilityJobOutputConfig:CreateModelExplainabilityJobDefinition', createModelExplainabilityJobDefinition_modelExplainabilityJobOutputConfig - Undocumented member.

$sel:jobResources:CreateModelExplainabilityJobDefinition', createModelExplainabilityJobDefinition_jobResources - Undocumented member.

CreateModelExplainabilityJobDefinition, createModelExplainabilityJobDefinition_roleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Request Lenses

createModelExplainabilityJobDefinition_modelExplainabilityBaselineConfig :: Lens' CreateModelExplainabilityJobDefinition (Maybe ModelExplainabilityBaselineConfig) Source #

The baseline configuration for a model explainability job.

createModelExplainabilityJobDefinition_networkConfig :: Lens' CreateModelExplainabilityJobDefinition (Maybe MonitoringNetworkConfig) Source #

Networking options for a model explainability job.

createModelExplainabilityJobDefinition_stoppingCondition :: Lens' CreateModelExplainabilityJobDefinition (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

createModelExplainabilityJobDefinition_tags :: Lens' CreateModelExplainabilityJobDefinition (Maybe [Tag]) Source #

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createModelExplainabilityJobDefinition_jobDefinitionName :: Lens' CreateModelExplainabilityJobDefinition Text Source #

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

createModelExplainabilityJobDefinition_modelExplainabilityAppSpecification :: Lens' CreateModelExplainabilityJobDefinition ModelExplainabilityAppSpecification Source #

Configures the model explainability job to run a specified Docker container image.

createModelExplainabilityJobDefinition_modelExplainabilityJobInput :: Lens' CreateModelExplainabilityJobDefinition ModelExplainabilityJobInput Source #

Inputs for the model explainability job.

createModelExplainabilityJobDefinition_modelExplainabilityJobOutputConfig :: Lens' CreateModelExplainabilityJobDefinition MonitoringOutputConfig Source #

Undocumented member.

createModelExplainabilityJobDefinition_jobResources :: Lens' CreateModelExplainabilityJobDefinition MonitoringResources Source #

Undocumented member.

createModelExplainabilityJobDefinition_roleArn :: Lens' CreateModelExplainabilityJobDefinition Text Source #

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

Destructuring the Response

data CreateModelExplainabilityJobDefinitionResponse Source #

See: newCreateModelExplainabilityJobDefinitionResponse smart constructor.

Constructors

CreateModelExplainabilityJobDefinitionResponse'
Fields httpStatus :: Int The response's http status code. jobDefinitionArn :: Text The Amazon Resource Name (ARN) of the model explainability job.

Instances

Instances details

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

newCreateModelExplainabilityJobDefinitionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateModelExplainabilityJobDefinitionResponse'`
-> Text	`$sel:jobDefinitionArn:CreateModelExplainabilityJobDefinitionResponse'`
-> CreateModelExplainabilityJobDefinitionResponse

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

$sel:jobDefinitionArn:CreateModelExplainabilityJobDefinitionResponse', createModelExplainabilityJobDefinitionResponse_jobDefinitionArn - The Amazon Resource Name (ARN) of the model explainability job.

Response Lenses

createModelExplainabilityJobDefinitionResponse_httpStatus :: Lens' CreateModelExplainabilityJobDefinitionResponse Int Source #

The response's http status code.

createModelExplainabilityJobDefinitionResponse_jobDefinitionArn :: Lens' CreateModelExplainabilityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the model explainability job.