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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of a model explainability job definition.

Synopsis

Creating a Request

data DescribeModelExplainabilityJobDefinition Source #

See: newDescribeModelExplainabilityJobDefinition smart constructor.

Constructors

DescribeModelExplainabilityJobDefinition'
Fields 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.

Instances

Instances details

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

newDescribeModelExplainabilityJobDefinition Source #

Arguments

:: Text	`DescribeModelExplainabilityJobDefinition`
-> DescribeModelExplainabilityJobDefinition

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

DescribeModelExplainabilityJobDefinition, describeModelExplainabilityJobDefinition_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.

Request Lenses

describeModelExplainabilityJobDefinition_jobDefinitionName :: Lens' DescribeModelExplainabilityJobDefinition 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.

Destructuring the Response

data DescribeModelExplainabilityJobDefinitionResponse Source #

See: newDescribeModelExplainabilityJobDefinitionResponse smart constructor.

Constructors

DescribeModelExplainabilityJobDefinitionResponse'

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
httpStatus :: Int
The response's http status code.
jobDefinitionArn :: Text
The Amazon Resource Name (ARN) of the model explainability job.
jobDefinitionName :: Text
The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
creationTime :: POSIX
The time at which the model explainability job was created.
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 the Amazon Web Services 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.

Instances

Instances details

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

newDescribeModelExplainabilityJobDefinitionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeModelExplainabilityJobDefinitionResponse'`
-> Text	`$sel:jobDefinitionArn:DescribeModelExplainabilityJobDefinitionResponse'`
-> Text	`DescribeModelExplainabilityJobDefinition`
-> UTCTime	`DescribeModelExplainabilityJobDefinitionResponse`
-> ModelExplainabilityAppSpecification	`$sel:modelExplainabilityAppSpecification:DescribeModelExplainabilityJobDefinitionResponse'`
-> ModelExplainabilityJobInput	`$sel:modelExplainabilityJobInput:DescribeModelExplainabilityJobDefinitionResponse'`
-> MonitoringOutputConfig	`$sel:modelExplainabilityJobOutputConfig:DescribeModelExplainabilityJobDefinitionResponse'`
-> MonitoringResources	`$sel:jobResources:DescribeModelExplainabilityJobDefinitionResponse'`
-> Text	`DescribeModelExplainabilityJobDefinitionResponse`
-> DescribeModelExplainabilityJobDefinitionResponse

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

DescribeModelExplainabilityJobDefinitionResponse, describeModelExplainabilityJobDefinitionResponse_networkConfig - Networking options for a model explainability job.

DescribeModelExplainabilityJobDefinitionResponse, describeModelExplainabilityJobDefinitionResponse_stoppingCondition - Undocumented member.

$sel:httpStatus:DescribeModelExplainabilityJobDefinitionResponse', describeModelExplainabilityJobDefinitionResponse_httpStatus - The response's http status code.

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

DescribeModelExplainabilityJobDefinition, describeModelExplainabilityJobDefinitionResponse_jobDefinitionName - The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

DescribeModelExplainabilityJobDefinitionResponse, describeModelExplainabilityJobDefinitionResponse_creationTime - The time at which the model explainability job was created.

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

$sel:modelExplainabilityJobInput:DescribeModelExplainabilityJobDefinitionResponse', describeModelExplainabilityJobDefinitionResponse_modelExplainabilityJobInput - Inputs for the model explainability job.

$sel:modelExplainabilityJobOutputConfig:DescribeModelExplainabilityJobDefinitionResponse', describeModelExplainabilityJobDefinitionResponse_modelExplainabilityJobOutputConfig - Undocumented member.

$sel:jobResources:DescribeModelExplainabilityJobDefinitionResponse', describeModelExplainabilityJobDefinitionResponse_jobResources - Undocumented member.

DescribeModelExplainabilityJobDefinitionResponse, describeModelExplainabilityJobDefinitionResponse_roleArn - The Amazon Resource Name (ARN) of the Amazon Web Services 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.

Response Lenses

describeModelExplainabilityJobDefinitionResponse_modelExplainabilityBaselineConfig :: Lens' DescribeModelExplainabilityJobDefinitionResponse (Maybe ModelExplainabilityBaselineConfig) Source #

The baseline configuration for a model explainability job.

describeModelExplainabilityJobDefinitionResponse_networkConfig :: Lens' DescribeModelExplainabilityJobDefinitionResponse (Maybe MonitoringNetworkConfig) Source #

Networking options for a model explainability job.

describeModelExplainabilityJobDefinitionResponse_stoppingCondition :: Lens' DescribeModelExplainabilityJobDefinitionResponse (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

describeModelExplainabilityJobDefinitionResponse_httpStatus :: Lens' DescribeModelExplainabilityJobDefinitionResponse Int Source #

The response's http status code.

describeModelExplainabilityJobDefinitionResponse_jobDefinitionArn :: Lens' DescribeModelExplainabilityJobDefinitionResponse Text Source #

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

describeModelExplainabilityJobDefinitionResponse_jobDefinitionName :: Lens' DescribeModelExplainabilityJobDefinitionResponse Text Source #

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

describeModelExplainabilityJobDefinitionResponse_creationTime :: Lens' DescribeModelExplainabilityJobDefinitionResponse UTCTime Source #

The time at which the model explainability job was created.

describeModelExplainabilityJobDefinitionResponse_modelExplainabilityAppSpecification :: Lens' DescribeModelExplainabilityJobDefinitionResponse ModelExplainabilityAppSpecification Source #

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

describeModelExplainabilityJobDefinitionResponse_modelExplainabilityJobInput :: Lens' DescribeModelExplainabilityJobDefinitionResponse ModelExplainabilityJobInput Source #

Inputs for the model explainability job.

describeModelExplainabilityJobDefinitionResponse_modelExplainabilityJobOutputConfig :: Lens' DescribeModelExplainabilityJobDefinitionResponse MonitoringOutputConfig Source #

Undocumented member.

describeModelExplainabilityJobDefinitionResponse_jobResources :: Lens' DescribeModelExplainabilityJobDefinitionResponse MonitoringResources Source #

Undocumented member.

describeModelExplainabilityJobDefinitionResponse_roleArn :: Lens' DescribeModelExplainabilityJobDefinitionResponse Text Source #

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