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.Kinesis.EnableEnhancedMonitoring

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

Synopsis

Creating a Request

data EnableEnhancedMonitoring Source #

Represents the input for EnableEnhancedMonitoring.

See: newEnableEnhancedMonitoring smart constructor.

Constructors

EnableEnhancedMonitoring'

Fields

streamARN :: Maybe Text
The ARN of the stream.
streamName :: Maybe Text
The name of the stream for which to enable enhanced monitoring.
shardLevelMetrics :: [MetricsName]
List of shard-level metrics to enable.
The following are the valid shard-level metrics. The value "ALL" enables every metric.
- ```
IncomingBytes
```
- ```
IncomingRecords
```
- ```
OutgoingBytes
```
- ```
OutgoingRecords
```
- ```
WriteProvisionedThroughputExceeded
```
- ```
ReadProvisionedThroughputExceeded
```
- ```
IteratorAgeMilliseconds
```
- ```
ALL
```
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

Instances

Instances details

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

newEnableEnhancedMonitoring :: EnableEnhancedMonitoring Source #

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

EnableEnhancedMonitoring, enableEnhancedMonitoring_streamARN - The ARN of the stream.

EnableEnhancedMonitoring, enableEnhancedMonitoring_streamName - The name of the stream for which to enable enhanced monitoring.

EnableEnhancedMonitoring, enableEnhancedMonitoring_shardLevelMetrics - List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value "ALL" enables every metric.

```
IncomingBytes
```
```
IncomingRecords
```
```
OutgoingBytes
```
```
OutgoingRecords
```
```
WriteProvisionedThroughputExceeded
```
```
ReadProvisionedThroughputExceeded
```
```
IteratorAgeMilliseconds
```
```
ALL
```

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

Request Lenses

enableEnhancedMonitoring_streamARN :: Lens' EnableEnhancedMonitoring (Maybe Text) Source #

The ARN of the stream.

enableEnhancedMonitoring_streamName :: Lens' EnableEnhancedMonitoring (Maybe Text) Source #

The name of the stream for which to enable enhanced monitoring.

enableEnhancedMonitoring_shardLevelMetrics :: Lens' EnableEnhancedMonitoring [MetricsName] Source #

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value "ALL" enables every metric.

```
IncomingBytes
```
```
IncomingRecords
```
```
OutgoingBytes
```
```
OutgoingRecords
```
```
WriteProvisionedThroughputExceeded
```
```
ReadProvisionedThroughputExceeded
```
```
IteratorAgeMilliseconds
```
```
ALL
```

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

Destructuring the Response

data EnhancedMonitoringOutput Source #

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

See: newEnhancedMonitoringOutput smart constructor.

Constructors

EnhancedMonitoringOutput'

Fields

currentShardLevelMetrics :: Maybe [MetricsName]
Represents the current state of the metrics that are in the enhanced state before the operation.
desiredShardLevelMetrics :: Maybe [MetricsName]
Represents the list of all the metrics that would be in the enhanced state after the operation.
streamARN :: Maybe Text
The ARN of the stream.
streamName :: Maybe Text
The name of the Kinesis data stream.

Instances

Instances details

FromJSON EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods parseJSON :: Value -> Parser EnhancedMonitoringOutput # parseJSONList :: Value -> Parser [EnhancedMonitoringOutput] #
Generic EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Associated Types type Rep EnhancedMonitoringOutput :: Type -> Type # Methods from :: EnhancedMonitoringOutput -> Rep EnhancedMonitoringOutput x # to :: Rep EnhancedMonitoringOutput x -> EnhancedMonitoringOutput #
Read EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods readsPrec :: Int -> ReadS EnhancedMonitoringOutput # readList :: ReadS [EnhancedMonitoringOutput] # readPrec :: ReadPrec EnhancedMonitoringOutput # readListPrec :: ReadPrec [EnhancedMonitoringOutput] #
Show EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods showsPrec :: Int -> EnhancedMonitoringOutput -> ShowS # show :: EnhancedMonitoringOutput -> String # showList :: [EnhancedMonitoringOutput] -> ShowS #
NFData EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods rnf :: EnhancedMonitoringOutput -> () #
Eq EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods (==) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool # (/=) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool #
Hashable EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods hashWithSalt :: Int -> EnhancedMonitoringOutput -> Int # hash :: EnhancedMonitoringOutput -> Int #
type Rep EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput type Rep EnhancedMonitoringOutput = D1 ('MetaData "EnhancedMonitoringOutput" "Amazonka.Kinesis.Types.EnhancedMonitoringOutput" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "EnhancedMonitoringOutput'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "currentShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: S1 ('MetaSel ('Just "desiredShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName]))) :: (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newEnhancedMonitoringOutput :: EnhancedMonitoringOutput Source #

Create a value of EnhancedMonitoringOutput 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:currentShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_currentShardLevelMetrics - Represents the current state of the metrics that are in the enhanced state before the operation.

$sel:desiredShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_desiredShardLevelMetrics - Represents the list of all the metrics that would be in the enhanced state after the operation.

$sel:streamARN:EnhancedMonitoringOutput', enhancedMonitoringOutput_streamARN - The ARN of the stream.

$sel:streamName:EnhancedMonitoringOutput', enhancedMonitoringOutput_streamName - The name of the Kinesis data stream.

Response Lenses

enhancedMonitoringOutput_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #

Represents the current state of the metrics that are in the enhanced state before the operation.

enhancedMonitoringOutput_desiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #

Represents the list of all the metrics that would be in the enhanced state after the operation.

enhancedMonitoringOutput_streamARN :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #

The ARN of the stream.

enhancedMonitoringOutput_streamName :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #

The name of the Kinesis data stream.