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.LookoutMetrics.DescribeMetricSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a dataset.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

Synopsis

data DescribeMetricSet = DescribeMetricSet' {
- metricSetArn :: Text
}
newDescribeMetricSet :: Text -> DescribeMetricSet
describeMetricSet_metricSetArn :: Lens' DescribeMetricSet Text
data DescribeMetricSetResponse = DescribeMetricSetResponse' {
- anomalyDetectorArn :: Maybe Text
- creationTime :: Maybe POSIX
- dimensionFilterList :: Maybe [MetricSetDimensionFilter]
- dimensionList :: Maybe (NonEmpty Text)
- lastModificationTime :: Maybe POSIX
- metricList :: Maybe (NonEmpty Metric)
- metricSetArn :: Maybe Text
- metricSetDescription :: Maybe Text
- metricSetFrequency :: Maybe Frequency
- metricSetName :: Maybe Text
- metricSource :: Maybe MetricSource
- offset :: Maybe Natural
- timestampColumn :: Maybe TimestampColumn
- timezone :: Maybe Text
- httpStatus :: Int
}
newDescribeMetricSetResponse :: Int -> DescribeMetricSetResponse
describeMetricSetResponse_anomalyDetectorArn :: Lens' DescribeMetricSetResponse (Maybe Text)
describeMetricSetResponse_creationTime :: Lens' DescribeMetricSetResponse (Maybe UTCTime)
describeMetricSetResponse_dimensionFilterList :: Lens' DescribeMetricSetResponse (Maybe [MetricSetDimensionFilter])
describeMetricSetResponse_dimensionList :: Lens' DescribeMetricSetResponse (Maybe (NonEmpty Text))
describeMetricSetResponse_lastModificationTime :: Lens' DescribeMetricSetResponse (Maybe UTCTime)
describeMetricSetResponse_metricList :: Lens' DescribeMetricSetResponse (Maybe (NonEmpty Metric))
describeMetricSetResponse_metricSetArn :: Lens' DescribeMetricSetResponse (Maybe Text)
describeMetricSetResponse_metricSetDescription :: Lens' DescribeMetricSetResponse (Maybe Text)
describeMetricSetResponse_metricSetFrequency :: Lens' DescribeMetricSetResponse (Maybe Frequency)
describeMetricSetResponse_metricSetName :: Lens' DescribeMetricSetResponse (Maybe Text)
describeMetricSetResponse_metricSource :: Lens' DescribeMetricSetResponse (Maybe MetricSource)
describeMetricSetResponse_offset :: Lens' DescribeMetricSetResponse (Maybe Natural)
describeMetricSetResponse_timestampColumn :: Lens' DescribeMetricSetResponse (Maybe TimestampColumn)
describeMetricSetResponse_timezone :: Lens' DescribeMetricSetResponse (Maybe Text)
describeMetricSetResponse_httpStatus :: Lens' DescribeMetricSetResponse Int

Creating a Request

data DescribeMetricSet Source #

See: newDescribeMetricSet smart constructor.

Constructors

DescribeMetricSet'
Fields metricSetArn :: Text The ARN of the dataset.

Instances

Instances details

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

newDescribeMetricSet Source #

Arguments

:: Text	`DescribeMetricSet`
-> DescribeMetricSet

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

DescribeMetricSet, describeMetricSet_metricSetArn - The ARN of the dataset.

Request Lenses

describeMetricSet_metricSetArn :: Lens' DescribeMetricSet Text Source #

The ARN of the dataset.

Destructuring the Response

data DescribeMetricSetResponse Source #

See: newDescribeMetricSetResponse smart constructor.

Constructors

DescribeMetricSetResponse'

Fields

anomalyDetectorArn :: Maybe Text
The ARN of the detector that contains the dataset.
creationTime :: Maybe POSIX
The time at which the dataset was created.
dimensionFilterList :: Maybe [MetricSetDimensionFilter]
The dimensions and their values that were used to filter the dataset.
dimensionList :: Maybe (NonEmpty Text)
A list of the dimensions chosen for analysis.
lastModificationTime :: Maybe POSIX
The time at which the dataset was last modified.
metricList :: Maybe (NonEmpty Metric)
A list of the metrics defined by the dataset.
metricSetArn :: Maybe Text
The ARN of the dataset.
metricSetDescription :: Maybe Text
The dataset's description.
metricSetFrequency :: Maybe Frequency
The interval at which the data will be analyzed for anomalies.
metricSetName :: Maybe Text
The name of the dataset.
metricSource :: Maybe MetricSource
Contains information about the dataset's source data.
offset :: Maybe Natural
After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
timestampColumn :: Maybe TimestampColumn
Contains information about the column used for tracking time in your source data.
timezone :: Maybe Text
The time zone in which the dataset's data was recorded.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeMetricSetResponse Source #
Instance details Defined in Amazonka.LookoutMetrics.DescribeMetricSet Associated Types type Rep DescribeMetricSetResponse :: Type -> Type # Methods from :: DescribeMetricSetResponse -> Rep DescribeMetricSetResponse x # to :: Rep DescribeMetricSetResponse x -> DescribeMetricSetResponse #
Read DescribeMetricSetResponse Source #
Instance details Defined in Amazonka.LookoutMetrics.DescribeMetricSet Methods readsPrec :: Int -> ReadS DescribeMetricSetResponse # readList :: ReadS [DescribeMetricSetResponse] # readPrec :: ReadPrec DescribeMetricSetResponse # readListPrec :: ReadPrec [DescribeMetricSetResponse] #
Show DescribeMetricSetResponse Source #
Instance details Defined in Amazonka.LookoutMetrics.DescribeMetricSet Methods showsPrec :: Int -> DescribeMetricSetResponse -> ShowS # show :: DescribeMetricSetResponse -> String # showList :: [DescribeMetricSetResponse] -> ShowS #
NFData DescribeMetricSetResponse Source #
Instance details Defined in Amazonka.LookoutMetrics.DescribeMetricSet Methods rnf :: DescribeMetricSetResponse -> () #
Eq DescribeMetricSetResponse Source #
Instance details Defined in Amazonka.LookoutMetrics.DescribeMetricSet Methods (==) :: DescribeMetricSetResponse -> DescribeMetricSetResponse -> Bool # (/=) :: DescribeMetricSetResponse -> DescribeMetricSetResponse -> Bool #
type Rep DescribeMetricSetResponse Source #
Instance details Defined in Amazonka.LookoutMetrics.DescribeMetricSet type Rep DescribeMetricSetResponse = D1 ('MetaData "DescribeMetricSetResponse" "Amazonka.LookoutMetrics.DescribeMetricSet" "amazonka-lookoutmetrics-2.0-5gJoMWEA4GrGsqHAPh1b9h" 'False) (C1 ('MetaCons "DescribeMetricSetResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "anomalyDetectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "dimensionFilterList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricSetDimensionFilter])))) :: ((S1 ('MetaSel ('Just "dimensionList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "metricList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Metric))) :: S1 ('MetaSel ('Just "metricSetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "metricSetDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "metricSetFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Frequency))) :: (S1 ('MetaSel ('Just "metricSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "metricSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricSource)))) :: ((S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "timestampColumn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimestampColumn))) :: (S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeMetricSetResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeMetricSetResponse'`
-> DescribeMetricSetResponse

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

DescribeMetricSetResponse, describeMetricSetResponse_anomalyDetectorArn - The ARN of the detector that contains the dataset.

DescribeMetricSetResponse, describeMetricSetResponse_creationTime - The time at which the dataset was created.

DescribeMetricSetResponse, describeMetricSetResponse_dimensionFilterList - The dimensions and their values that were used to filter the dataset.

DescribeMetricSetResponse, describeMetricSetResponse_dimensionList - A list of the dimensions chosen for analysis.

DescribeMetricSetResponse, describeMetricSetResponse_lastModificationTime - The time at which the dataset was last modified.

DescribeMetricSetResponse, describeMetricSetResponse_metricList - A list of the metrics defined by the dataset.

DescribeMetricSet, describeMetricSetResponse_metricSetArn - The ARN of the dataset.

DescribeMetricSetResponse, describeMetricSetResponse_metricSetDescription - The dataset's description.

DescribeMetricSetResponse, describeMetricSetResponse_metricSetFrequency - The interval at which the data will be analyzed for anomalies.

DescribeMetricSetResponse, describeMetricSetResponse_metricSetName - The name of the dataset.

DescribeMetricSetResponse, describeMetricSetResponse_metricSource - Contains information about the dataset's source data.

DescribeMetricSetResponse, describeMetricSetResponse_offset - After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

$sel:timestampColumn:DescribeMetricSetResponse', describeMetricSetResponse_timestampColumn - Contains information about the column used for tracking time in your source data.

$sel:timezone:DescribeMetricSetResponse', describeMetricSetResponse_timezone - The time zone in which the dataset's data was recorded.

$sel:httpStatus:DescribeMetricSetResponse', describeMetricSetResponse_httpStatus - The response's http status code.

Response Lenses

describeMetricSetResponse_anomalyDetectorArn :: Lens' DescribeMetricSetResponse (Maybe Text) Source #

The ARN of the detector that contains the dataset.

describeMetricSetResponse_creationTime :: Lens' DescribeMetricSetResponse (Maybe UTCTime) Source #

The time at which the dataset was created.

describeMetricSetResponse_dimensionFilterList :: Lens' DescribeMetricSetResponse (Maybe [MetricSetDimensionFilter]) Source #

The dimensions and their values that were used to filter the dataset.

describeMetricSetResponse_dimensionList :: Lens' DescribeMetricSetResponse (Maybe (NonEmpty Text)) Source #

A list of the dimensions chosen for analysis.

describeMetricSetResponse_lastModificationTime :: Lens' DescribeMetricSetResponse (Maybe UTCTime) Source #

The time at which the dataset was last modified.

describeMetricSetResponse_metricList :: Lens' DescribeMetricSetResponse (Maybe (NonEmpty Metric)) Source #

A list of the metrics defined by the dataset.

describeMetricSetResponse_metricSetArn :: Lens' DescribeMetricSetResponse (Maybe Text) Source #

The ARN of the dataset.

describeMetricSetResponse_metricSetDescription :: Lens' DescribeMetricSetResponse (Maybe Text) Source #

The dataset's description.

describeMetricSetResponse_metricSetFrequency :: Lens' DescribeMetricSetResponse (Maybe Frequency) Source #

The interval at which the data will be analyzed for anomalies.

describeMetricSetResponse_metricSetName :: Lens' DescribeMetricSetResponse (Maybe Text) Source #

The name of the dataset.

describeMetricSetResponse_metricSource :: Lens' DescribeMetricSetResponse (Maybe MetricSource) Source #

Contains information about the dataset's source data.

describeMetricSetResponse_offset :: Lens' DescribeMetricSetResponse (Maybe Natural) Source #

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

describeMetricSetResponse_timestampColumn :: Lens' DescribeMetricSetResponse (Maybe TimestampColumn) Source #

Contains information about the column used for tracking time in your source data.

describeMetricSetResponse_timezone :: Lens' DescribeMetricSetResponse (Maybe Text) Source #

The time zone in which the dataset's data was recorded.

describeMetricSetResponse_httpStatus :: Lens' DescribeMetricSetResponse Int Source #

The response's http status code.