{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.SageMaker.DescribeModelBiasJobDefinition -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Returns a description of a model bias job definition. module Amazonka.SageMaker.DescribeModelBiasJobDefinition ( -- * Creating a Request DescribeModelBiasJobDefinition (..), newDescribeModelBiasJobDefinition, -- * Request Lenses describeModelBiasJobDefinition_jobDefinitionName, -- * Destructuring the Response DescribeModelBiasJobDefinitionResponse (..), newDescribeModelBiasJobDefinitionResponse, -- * Response Lenses describeModelBiasJobDefinitionResponse_modelBiasBaselineConfig, describeModelBiasJobDefinitionResponse_networkConfig, describeModelBiasJobDefinitionResponse_stoppingCondition, describeModelBiasJobDefinitionResponse_httpStatus, describeModelBiasJobDefinitionResponse_jobDefinitionArn, describeModelBiasJobDefinitionResponse_jobDefinitionName, describeModelBiasJobDefinitionResponse_creationTime, describeModelBiasJobDefinitionResponse_modelBiasAppSpecification, describeModelBiasJobDefinitionResponse_modelBiasJobInput, describeModelBiasJobDefinitionResponse_modelBiasJobOutputConfig, describeModelBiasJobDefinitionResponse_jobResources, describeModelBiasJobDefinitionResponse_roleArn, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response import Amazonka.SageMaker.Types -- | /See:/ 'newDescribeModelBiasJobDefinition' smart constructor. data DescribeModelBiasJobDefinition = DescribeModelBiasJobDefinition' { -- | The name of the model bias job definition. The name must be unique -- within an Amazon Web Services Region in the Amazon Web Services account. jobDefinitionName :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeModelBiasJobDefinition' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'jobDefinitionName', 'describeModelBiasJobDefinition_jobDefinitionName' - The name of the model bias job definition. The name must be unique -- within an Amazon Web Services Region in the Amazon Web Services account. newDescribeModelBiasJobDefinition :: -- | 'jobDefinitionName' Prelude.Text -> DescribeModelBiasJobDefinition newDescribeModelBiasJobDefinition pJobDefinitionName_ = DescribeModelBiasJobDefinition' { jobDefinitionName = pJobDefinitionName_ } -- | The name of the model bias job definition. The name must be unique -- within an Amazon Web Services Region in the Amazon Web Services account. describeModelBiasJobDefinition_jobDefinitionName :: Lens.Lens' DescribeModelBiasJobDefinition Prelude.Text describeModelBiasJobDefinition_jobDefinitionName = Lens.lens (\DescribeModelBiasJobDefinition' {jobDefinitionName} -> jobDefinitionName) (\s@DescribeModelBiasJobDefinition' {} a -> s {jobDefinitionName = a} :: DescribeModelBiasJobDefinition) instance Core.AWSRequest DescribeModelBiasJobDefinition where type AWSResponse DescribeModelBiasJobDefinition = DescribeModelBiasJobDefinitionResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeModelBiasJobDefinitionResponse' Prelude.<$> (x Data..?> "ModelBiasBaselineConfig") Prelude.<*> (x Data..?> "NetworkConfig") Prelude.<*> (x Data..?> "StoppingCondition") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> (x Data..:> "JobDefinitionArn") Prelude.<*> (x Data..:> "JobDefinitionName") Prelude.<*> (x Data..:> "CreationTime") Prelude.<*> (x Data..:> "ModelBiasAppSpecification") Prelude.<*> (x Data..:> "ModelBiasJobInput") Prelude.<*> (x Data..:> "ModelBiasJobOutputConfig") Prelude.<*> (x Data..:> "JobResources") Prelude.<*> (x Data..:> "RoleArn") ) instance Prelude.Hashable DescribeModelBiasJobDefinition where hashWithSalt _salt DescribeModelBiasJobDefinition' {..} = _salt `Prelude.hashWithSalt` jobDefinitionName instance Prelude.NFData DescribeModelBiasJobDefinition where rnf DescribeModelBiasJobDefinition' {..} = Prelude.rnf jobDefinitionName instance Data.ToHeaders DescribeModelBiasJobDefinition where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "SageMaker.DescribeModelBiasJobDefinition" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeModelBiasJobDefinition where toJSON DescribeModelBiasJobDefinition' {..} = Data.object ( Prelude.catMaybes [ Prelude.Just ("JobDefinitionName" Data..= jobDefinitionName) ] ) instance Data.ToPath DescribeModelBiasJobDefinition where toPath = Prelude.const "/" instance Data.ToQuery DescribeModelBiasJobDefinition where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeModelBiasJobDefinitionResponse' smart constructor. data DescribeModelBiasJobDefinitionResponse = DescribeModelBiasJobDefinitionResponse' { -- | The baseline configuration for a model bias job. modelBiasBaselineConfig :: Prelude.Maybe ModelBiasBaselineConfig, -- | Networking options for a model bias job. networkConfig :: Prelude.Maybe MonitoringNetworkConfig, stoppingCondition :: Prelude.Maybe MonitoringStoppingCondition, -- | The response's http status code. httpStatus :: Prelude.Int, -- | The Amazon Resource Name (ARN) of the model bias job. jobDefinitionArn :: Prelude.Text, -- | The name of the bias job definition. The name must be unique within an -- Amazon Web Services Region in the Amazon Web Services account. jobDefinitionName :: Prelude.Text, -- | The time at which the model bias job was created. creationTime :: Data.POSIX, -- | Configures the model bias job to run a specified Docker container image. modelBiasAppSpecification :: ModelBiasAppSpecification, -- | Inputs for the model bias job. modelBiasJobInput :: ModelBiasJobInput, modelBiasJobOutputConfig :: MonitoringOutputConfig, jobResources :: MonitoringResources, -- | 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. roleArn :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeModelBiasJobDefinitionResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'modelBiasBaselineConfig', 'describeModelBiasJobDefinitionResponse_modelBiasBaselineConfig' - The baseline configuration for a model bias job. -- -- 'networkConfig', 'describeModelBiasJobDefinitionResponse_networkConfig' - Networking options for a model bias job. -- -- 'stoppingCondition', 'describeModelBiasJobDefinitionResponse_stoppingCondition' - Undocumented member. -- -- 'httpStatus', 'describeModelBiasJobDefinitionResponse_httpStatus' - The response's http status code. -- -- 'jobDefinitionArn', 'describeModelBiasJobDefinitionResponse_jobDefinitionArn' - The Amazon Resource Name (ARN) of the model bias job. -- -- 'jobDefinitionName', 'describeModelBiasJobDefinitionResponse_jobDefinitionName' - The name of the bias job definition. The name must be unique within an -- Amazon Web Services Region in the Amazon Web Services account. -- -- 'creationTime', 'describeModelBiasJobDefinitionResponse_creationTime' - The time at which the model bias job was created. -- -- 'modelBiasAppSpecification', 'describeModelBiasJobDefinitionResponse_modelBiasAppSpecification' - Configures the model bias job to run a specified Docker container image. -- -- 'modelBiasJobInput', 'describeModelBiasJobDefinitionResponse_modelBiasJobInput' - Inputs for the model bias job. -- -- 'modelBiasJobOutputConfig', 'describeModelBiasJobDefinitionResponse_modelBiasJobOutputConfig' - Undocumented member. -- -- 'jobResources', 'describeModelBiasJobDefinitionResponse_jobResources' - Undocumented member. -- -- 'roleArn', 'describeModelBiasJobDefinitionResponse_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. newDescribeModelBiasJobDefinitionResponse :: -- | 'httpStatus' Prelude.Int -> -- | 'jobDefinitionArn' Prelude.Text -> -- | 'jobDefinitionName' Prelude.Text -> -- | 'creationTime' Prelude.UTCTime -> -- | 'modelBiasAppSpecification' ModelBiasAppSpecification -> -- | 'modelBiasJobInput' ModelBiasJobInput -> -- | 'modelBiasJobOutputConfig' MonitoringOutputConfig -> -- | 'jobResources' MonitoringResources -> -- | 'roleArn' Prelude.Text -> DescribeModelBiasJobDefinitionResponse newDescribeModelBiasJobDefinitionResponse pHttpStatus_ pJobDefinitionArn_ pJobDefinitionName_ pCreationTime_ pModelBiasAppSpecification_ pModelBiasJobInput_ pModelBiasJobOutputConfig_ pJobResources_ pRoleArn_ = DescribeModelBiasJobDefinitionResponse' { modelBiasBaselineConfig = Prelude.Nothing, networkConfig = Prelude.Nothing, stoppingCondition = Prelude.Nothing, httpStatus = pHttpStatus_, jobDefinitionArn = pJobDefinitionArn_, jobDefinitionName = pJobDefinitionName_, creationTime = Data._Time Lens.# pCreationTime_, modelBiasAppSpecification = pModelBiasAppSpecification_, modelBiasJobInput = pModelBiasJobInput_, modelBiasJobOutputConfig = pModelBiasJobOutputConfig_, jobResources = pJobResources_, roleArn = pRoleArn_ } -- | The baseline configuration for a model bias job. describeModelBiasJobDefinitionResponse_modelBiasBaselineConfig :: Lens.Lens' DescribeModelBiasJobDefinitionResponse (Prelude.Maybe ModelBiasBaselineConfig) describeModelBiasJobDefinitionResponse_modelBiasBaselineConfig = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {modelBiasBaselineConfig} -> modelBiasBaselineConfig) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {modelBiasBaselineConfig = a} :: DescribeModelBiasJobDefinitionResponse) -- | Networking options for a model bias job. describeModelBiasJobDefinitionResponse_networkConfig :: Lens.Lens' DescribeModelBiasJobDefinitionResponse (Prelude.Maybe MonitoringNetworkConfig) describeModelBiasJobDefinitionResponse_networkConfig = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {networkConfig} -> networkConfig) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {networkConfig = a} :: DescribeModelBiasJobDefinitionResponse) -- | Undocumented member. describeModelBiasJobDefinitionResponse_stoppingCondition :: Lens.Lens' DescribeModelBiasJobDefinitionResponse (Prelude.Maybe MonitoringStoppingCondition) describeModelBiasJobDefinitionResponse_stoppingCondition = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {stoppingCondition} -> stoppingCondition) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {stoppingCondition = a} :: DescribeModelBiasJobDefinitionResponse) -- | The response's http status code. describeModelBiasJobDefinitionResponse_httpStatus :: Lens.Lens' DescribeModelBiasJobDefinitionResponse Prelude.Int describeModelBiasJobDefinitionResponse_httpStatus = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {httpStatus} -> httpStatus) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {httpStatus = a} :: DescribeModelBiasJobDefinitionResponse) -- | The Amazon Resource Name (ARN) of the model bias job. describeModelBiasJobDefinitionResponse_jobDefinitionArn :: Lens.Lens' DescribeModelBiasJobDefinitionResponse Prelude.Text describeModelBiasJobDefinitionResponse_jobDefinitionArn = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {jobDefinitionArn} -> jobDefinitionArn) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {jobDefinitionArn = a} :: DescribeModelBiasJobDefinitionResponse) -- | The name of the bias job definition. The name must be unique within an -- Amazon Web Services Region in the Amazon Web Services account. describeModelBiasJobDefinitionResponse_jobDefinitionName :: Lens.Lens' DescribeModelBiasJobDefinitionResponse Prelude.Text describeModelBiasJobDefinitionResponse_jobDefinitionName = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {jobDefinitionName} -> jobDefinitionName) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {jobDefinitionName = a} :: DescribeModelBiasJobDefinitionResponse) -- | The time at which the model bias job was created. describeModelBiasJobDefinitionResponse_creationTime :: Lens.Lens' DescribeModelBiasJobDefinitionResponse Prelude.UTCTime describeModelBiasJobDefinitionResponse_creationTime = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {creationTime} -> creationTime) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {creationTime = a} :: DescribeModelBiasJobDefinitionResponse) Prelude.. Data._Time -- | Configures the model bias job to run a specified Docker container image. describeModelBiasJobDefinitionResponse_modelBiasAppSpecification :: Lens.Lens' DescribeModelBiasJobDefinitionResponse ModelBiasAppSpecification describeModelBiasJobDefinitionResponse_modelBiasAppSpecification = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {modelBiasAppSpecification} -> modelBiasAppSpecification) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {modelBiasAppSpecification = a} :: DescribeModelBiasJobDefinitionResponse) -- | Inputs for the model bias job. describeModelBiasJobDefinitionResponse_modelBiasJobInput :: Lens.Lens' DescribeModelBiasJobDefinitionResponse ModelBiasJobInput describeModelBiasJobDefinitionResponse_modelBiasJobInput = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {modelBiasJobInput} -> modelBiasJobInput) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {modelBiasJobInput = a} :: DescribeModelBiasJobDefinitionResponse) -- | Undocumented member. describeModelBiasJobDefinitionResponse_modelBiasJobOutputConfig :: Lens.Lens' DescribeModelBiasJobDefinitionResponse MonitoringOutputConfig describeModelBiasJobDefinitionResponse_modelBiasJobOutputConfig = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {modelBiasJobOutputConfig} -> modelBiasJobOutputConfig) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {modelBiasJobOutputConfig = a} :: DescribeModelBiasJobDefinitionResponse) -- | Undocumented member. describeModelBiasJobDefinitionResponse_jobResources :: Lens.Lens' DescribeModelBiasJobDefinitionResponse MonitoringResources describeModelBiasJobDefinitionResponse_jobResources = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {jobResources} -> jobResources) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {jobResources = a} :: DescribeModelBiasJobDefinitionResponse) -- | 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. describeModelBiasJobDefinitionResponse_roleArn :: Lens.Lens' DescribeModelBiasJobDefinitionResponse Prelude.Text describeModelBiasJobDefinitionResponse_roleArn = Lens.lens (\DescribeModelBiasJobDefinitionResponse' {roleArn} -> roleArn) (\s@DescribeModelBiasJobDefinitionResponse' {} a -> s {roleArn = a} :: DescribeModelBiasJobDefinitionResponse) instance Prelude.NFData DescribeModelBiasJobDefinitionResponse where rnf DescribeModelBiasJobDefinitionResponse' {..} = Prelude.rnf modelBiasBaselineConfig `Prelude.seq` Prelude.rnf networkConfig `Prelude.seq` Prelude.rnf stoppingCondition `Prelude.seq` Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf jobDefinitionArn `Prelude.seq` Prelude.rnf jobDefinitionName `Prelude.seq` Prelude.rnf creationTime `Prelude.seq` Prelude.rnf modelBiasAppSpecification `Prelude.seq` Prelude.rnf modelBiasJobInput `Prelude.seq` Prelude.rnf modelBiasJobOutputConfig `Prelude.seq` Prelude.rnf jobResources `Prelude.seq` Prelude.rnf roleArn