{-# 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.DescribeDataQualityJobDefinition -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Gets the details of a data quality monitoring job definition. module Amazonka.SageMaker.DescribeDataQualityJobDefinition ( -- * Creating a Request DescribeDataQualityJobDefinition (..), newDescribeDataQualityJobDefinition, -- * Request Lenses describeDataQualityJobDefinition_jobDefinitionName, -- * Destructuring the Response DescribeDataQualityJobDefinitionResponse (..), newDescribeDataQualityJobDefinitionResponse, -- * Response Lenses describeDataQualityJobDefinitionResponse_dataQualityBaselineConfig, describeDataQualityJobDefinitionResponse_networkConfig, describeDataQualityJobDefinitionResponse_stoppingCondition, describeDataQualityJobDefinitionResponse_httpStatus, describeDataQualityJobDefinitionResponse_jobDefinitionArn, describeDataQualityJobDefinitionResponse_jobDefinitionName, describeDataQualityJobDefinitionResponse_creationTime, describeDataQualityJobDefinitionResponse_dataQualityAppSpecification, describeDataQualityJobDefinitionResponse_dataQualityJobInput, describeDataQualityJobDefinitionResponse_dataQualityJobOutputConfig, describeDataQualityJobDefinitionResponse_jobResources, describeDataQualityJobDefinitionResponse_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:/ 'newDescribeDataQualityJobDefinition' smart constructor. data DescribeDataQualityJobDefinition = DescribeDataQualityJobDefinition' { -- | The name of the data quality monitoring job definition to describe. jobDefinitionName :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeDataQualityJobDefinition' 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', 'describeDataQualityJobDefinition_jobDefinitionName' - The name of the data quality monitoring job definition to describe. newDescribeDataQualityJobDefinition :: -- | 'jobDefinitionName' Prelude.Text -> DescribeDataQualityJobDefinition newDescribeDataQualityJobDefinition pJobDefinitionName_ = DescribeDataQualityJobDefinition' { jobDefinitionName = pJobDefinitionName_ } -- | The name of the data quality monitoring job definition to describe. describeDataQualityJobDefinition_jobDefinitionName :: Lens.Lens' DescribeDataQualityJobDefinition Prelude.Text describeDataQualityJobDefinition_jobDefinitionName = Lens.lens (\DescribeDataQualityJobDefinition' {jobDefinitionName} -> jobDefinitionName) (\s@DescribeDataQualityJobDefinition' {} a -> s {jobDefinitionName = a} :: DescribeDataQualityJobDefinition) instance Core.AWSRequest DescribeDataQualityJobDefinition where type AWSResponse DescribeDataQualityJobDefinition = DescribeDataQualityJobDefinitionResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeDataQualityJobDefinitionResponse' Prelude.<$> (x Data..?> "DataQualityBaselineConfig") 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..:> "DataQualityAppSpecification") Prelude.<*> (x Data..:> "DataQualityJobInput") Prelude.<*> (x Data..:> "DataQualityJobOutputConfig") Prelude.<*> (x Data..:> "JobResources") Prelude.<*> (x Data..:> "RoleArn") ) instance Prelude.Hashable DescribeDataQualityJobDefinition where hashWithSalt _salt DescribeDataQualityJobDefinition' {..} = _salt `Prelude.hashWithSalt` jobDefinitionName instance Prelude.NFData DescribeDataQualityJobDefinition where rnf DescribeDataQualityJobDefinition' {..} = Prelude.rnf jobDefinitionName instance Data.ToHeaders DescribeDataQualityJobDefinition where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "SageMaker.DescribeDataQualityJobDefinition" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeDataQualityJobDefinition where toJSON DescribeDataQualityJobDefinition' {..} = Data.object ( Prelude.catMaybes [ Prelude.Just ("JobDefinitionName" Data..= jobDefinitionName) ] ) instance Data.ToPath DescribeDataQualityJobDefinition where toPath = Prelude.const "/" instance Data.ToQuery DescribeDataQualityJobDefinition where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeDataQualityJobDefinitionResponse' smart constructor. data DescribeDataQualityJobDefinitionResponse = DescribeDataQualityJobDefinitionResponse' { -- | The constraints and baselines for the data quality monitoring job -- definition. dataQualityBaselineConfig :: Prelude.Maybe DataQualityBaselineConfig, -- | The networking configuration for the data quality monitoring 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 data quality monitoring job -- definition. jobDefinitionArn :: Prelude.Text, -- | The name of the data quality monitoring job definition. jobDefinitionName :: Prelude.Text, -- | The time that the data quality monitoring job definition was created. creationTime :: Data.POSIX, -- | Information about the container that runs the data quality monitoring -- job. dataQualityAppSpecification :: DataQualityAppSpecification, -- | The list of inputs for the data quality monitoring job. Currently -- endpoints are supported. dataQualityJobInput :: DataQualityJobInput, dataQualityJobOutputConfig :: MonitoringOutputConfig, jobResources :: MonitoringResources, -- | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can -- assume to perform tasks on your behalf. roleArn :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeDataQualityJobDefinitionResponse' 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: -- -- 'dataQualityBaselineConfig', 'describeDataQualityJobDefinitionResponse_dataQualityBaselineConfig' - The constraints and baselines for the data quality monitoring job -- definition. -- -- 'networkConfig', 'describeDataQualityJobDefinitionResponse_networkConfig' - The networking configuration for the data quality monitoring job. -- -- 'stoppingCondition', 'describeDataQualityJobDefinitionResponse_stoppingCondition' - Undocumented member. -- -- 'httpStatus', 'describeDataQualityJobDefinitionResponse_httpStatus' - The response's http status code. -- -- 'jobDefinitionArn', 'describeDataQualityJobDefinitionResponse_jobDefinitionArn' - The Amazon Resource Name (ARN) of the data quality monitoring job -- definition. -- -- 'jobDefinitionName', 'describeDataQualityJobDefinitionResponse_jobDefinitionName' - The name of the data quality monitoring job definition. -- -- 'creationTime', 'describeDataQualityJobDefinitionResponse_creationTime' - The time that the data quality monitoring job definition was created. -- -- 'dataQualityAppSpecification', 'describeDataQualityJobDefinitionResponse_dataQualityAppSpecification' - Information about the container that runs the data quality monitoring -- job. -- -- 'dataQualityJobInput', 'describeDataQualityJobDefinitionResponse_dataQualityJobInput' - The list of inputs for the data quality monitoring job. Currently -- endpoints are supported. -- -- 'dataQualityJobOutputConfig', 'describeDataQualityJobDefinitionResponse_dataQualityJobOutputConfig' - Undocumented member. -- -- 'jobResources', 'describeDataQualityJobDefinitionResponse_jobResources' - Undocumented member. -- -- 'roleArn', 'describeDataQualityJobDefinitionResponse_roleArn' - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can -- assume to perform tasks on your behalf. newDescribeDataQualityJobDefinitionResponse :: -- | 'httpStatus' Prelude.Int -> -- | 'jobDefinitionArn' Prelude.Text -> -- | 'jobDefinitionName' Prelude.Text -> -- | 'creationTime' Prelude.UTCTime -> -- | 'dataQualityAppSpecification' DataQualityAppSpecification -> -- | 'dataQualityJobInput' DataQualityJobInput -> -- | 'dataQualityJobOutputConfig' MonitoringOutputConfig -> -- | 'jobResources' MonitoringResources -> -- | 'roleArn' Prelude.Text -> DescribeDataQualityJobDefinitionResponse newDescribeDataQualityJobDefinitionResponse pHttpStatus_ pJobDefinitionArn_ pJobDefinitionName_ pCreationTime_ pDataQualityAppSpecification_ pDataQualityJobInput_ pDataQualityJobOutputConfig_ pJobResources_ pRoleArn_ = DescribeDataQualityJobDefinitionResponse' { dataQualityBaselineConfig = Prelude.Nothing, networkConfig = Prelude.Nothing, stoppingCondition = Prelude.Nothing, httpStatus = pHttpStatus_, jobDefinitionArn = pJobDefinitionArn_, jobDefinitionName = pJobDefinitionName_, creationTime = Data._Time Lens.# pCreationTime_, dataQualityAppSpecification = pDataQualityAppSpecification_, dataQualityJobInput = pDataQualityJobInput_, dataQualityJobOutputConfig = pDataQualityJobOutputConfig_, jobResources = pJobResources_, roleArn = pRoleArn_ } -- | The constraints and baselines for the data quality monitoring job -- definition. describeDataQualityJobDefinitionResponse_dataQualityBaselineConfig :: Lens.Lens' DescribeDataQualityJobDefinitionResponse (Prelude.Maybe DataQualityBaselineConfig) describeDataQualityJobDefinitionResponse_dataQualityBaselineConfig = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {dataQualityBaselineConfig} -> dataQualityBaselineConfig) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {dataQualityBaselineConfig = a} :: DescribeDataQualityJobDefinitionResponse) -- | The networking configuration for the data quality monitoring job. describeDataQualityJobDefinitionResponse_networkConfig :: Lens.Lens' DescribeDataQualityJobDefinitionResponse (Prelude.Maybe MonitoringNetworkConfig) describeDataQualityJobDefinitionResponse_networkConfig = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {networkConfig} -> networkConfig) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {networkConfig = a} :: DescribeDataQualityJobDefinitionResponse) -- | Undocumented member. describeDataQualityJobDefinitionResponse_stoppingCondition :: Lens.Lens' DescribeDataQualityJobDefinitionResponse (Prelude.Maybe MonitoringStoppingCondition) describeDataQualityJobDefinitionResponse_stoppingCondition = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {stoppingCondition} -> stoppingCondition) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {stoppingCondition = a} :: DescribeDataQualityJobDefinitionResponse) -- | The response's http status code. describeDataQualityJobDefinitionResponse_httpStatus :: Lens.Lens' DescribeDataQualityJobDefinitionResponse Prelude.Int describeDataQualityJobDefinitionResponse_httpStatus = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {httpStatus} -> httpStatus) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {httpStatus = a} :: DescribeDataQualityJobDefinitionResponse) -- | The Amazon Resource Name (ARN) of the data quality monitoring job -- definition. describeDataQualityJobDefinitionResponse_jobDefinitionArn :: Lens.Lens' DescribeDataQualityJobDefinitionResponse Prelude.Text describeDataQualityJobDefinitionResponse_jobDefinitionArn = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {jobDefinitionArn} -> jobDefinitionArn) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {jobDefinitionArn = a} :: DescribeDataQualityJobDefinitionResponse) -- | The name of the data quality monitoring job definition. describeDataQualityJobDefinitionResponse_jobDefinitionName :: Lens.Lens' DescribeDataQualityJobDefinitionResponse Prelude.Text describeDataQualityJobDefinitionResponse_jobDefinitionName = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {jobDefinitionName} -> jobDefinitionName) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {jobDefinitionName = a} :: DescribeDataQualityJobDefinitionResponse) -- | The time that the data quality monitoring job definition was created. describeDataQualityJobDefinitionResponse_creationTime :: Lens.Lens' DescribeDataQualityJobDefinitionResponse Prelude.UTCTime describeDataQualityJobDefinitionResponse_creationTime = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {creationTime} -> creationTime) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {creationTime = a} :: DescribeDataQualityJobDefinitionResponse) Prelude.. Data._Time -- | Information about the container that runs the data quality monitoring -- job. describeDataQualityJobDefinitionResponse_dataQualityAppSpecification :: Lens.Lens' DescribeDataQualityJobDefinitionResponse DataQualityAppSpecification describeDataQualityJobDefinitionResponse_dataQualityAppSpecification = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {dataQualityAppSpecification} -> dataQualityAppSpecification) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {dataQualityAppSpecification = a} :: DescribeDataQualityJobDefinitionResponse) -- | The list of inputs for the data quality monitoring job. Currently -- endpoints are supported. describeDataQualityJobDefinitionResponse_dataQualityJobInput :: Lens.Lens' DescribeDataQualityJobDefinitionResponse DataQualityJobInput describeDataQualityJobDefinitionResponse_dataQualityJobInput = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {dataQualityJobInput} -> dataQualityJobInput) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {dataQualityJobInput = a} :: DescribeDataQualityJobDefinitionResponse) -- | Undocumented member. describeDataQualityJobDefinitionResponse_dataQualityJobOutputConfig :: Lens.Lens' DescribeDataQualityJobDefinitionResponse MonitoringOutputConfig describeDataQualityJobDefinitionResponse_dataQualityJobOutputConfig = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {dataQualityJobOutputConfig} -> dataQualityJobOutputConfig) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {dataQualityJobOutputConfig = a} :: DescribeDataQualityJobDefinitionResponse) -- | Undocumented member. describeDataQualityJobDefinitionResponse_jobResources :: Lens.Lens' DescribeDataQualityJobDefinitionResponse MonitoringResources describeDataQualityJobDefinitionResponse_jobResources = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {jobResources} -> jobResources) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {jobResources = a} :: DescribeDataQualityJobDefinitionResponse) -- | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can -- assume to perform tasks on your behalf. describeDataQualityJobDefinitionResponse_roleArn :: Lens.Lens' DescribeDataQualityJobDefinitionResponse Prelude.Text describeDataQualityJobDefinitionResponse_roleArn = Lens.lens (\DescribeDataQualityJobDefinitionResponse' {roleArn} -> roleArn) (\s@DescribeDataQualityJobDefinitionResponse' {} a -> s {roleArn = a} :: DescribeDataQualityJobDefinitionResponse) instance Prelude.NFData DescribeDataQualityJobDefinitionResponse where rnf DescribeDataQualityJobDefinitionResponse' {..} = Prelude.rnf dataQualityBaselineConfig `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 dataQualityAppSpecification `Prelude.seq` Prelude.rnf dataQualityJobInput `Prelude.seq` Prelude.rnf dataQualityJobOutputConfig `Prelude.seq` Prelude.rnf jobResources `Prelude.seq` Prelude.rnf roleArn