Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Kinesis.DisableEnhancedMonitoring

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Disables enhanced monitoring.

Synopsis

Creating a Request

data DisableEnhancedMonitoring Source #

Represents the input for DisableEnhancedMonitoring.

See: newDisableEnhancedMonitoring smart constructor.

Constructors

DisableEnhancedMonitoring'

Fields

streamName :: Text
The name of the Kinesis data stream for which to disable enhanced monitoring.
shardLevelMetrics :: [MetricsName]
List of shard-level metrics to disable.
The following are the valid shard-level metrics. The value "ALL" disables 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

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

newDisableEnhancedMonitoring Source #

Arguments

:: Text	`$sel:streamName:DisableEnhancedMonitoring'`
-> DisableEnhancedMonitoring

Create a value of DisableEnhancedMonitoring 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:streamName:DisableEnhancedMonitoring', disableEnhancedMonitoring_streamName - The name of the Kinesis data stream for which to disable enhanced monitoring.

$sel:shardLevelMetrics:DisableEnhancedMonitoring', disableEnhancedMonitoring_shardLevelMetrics - List of shard-level metrics to disable.

The following are the valid shard-level metrics. The value "ALL" disables 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

disableEnhancedMonitoring_streamName :: Lens' DisableEnhancedMonitoring Text Source #

The name of the Kinesis data stream for which to disable enhanced monitoring.

disableEnhancedMonitoring_shardLevelMetrics :: Lens' DisableEnhancedMonitoring [MetricsName] Source #

List of shard-level metrics to disable.

The following are the valid shard-level metrics. The value "ALL" disables 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 desiredShardLevelMetrics :: Maybe [MetricsName] Represents the list of all the metrics that would be in the enhanced state after the operation. currentShardLevelMetrics :: Maybe [MetricsName] Represents the current state of the metrics that are in the enhanced state before the operation. streamName :: Maybe Text The name of the Kinesis data stream.

Instances

Instances details

Eq EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods (==) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool # (/=) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool #
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 #
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 #
NFData EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods rnf :: EnhancedMonitoringOutput -> () #
Hashable EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods hashWithSalt :: Int -> EnhancedMonitoringOutput -> Int # hash :: EnhancedMonitoringOutput -> Int #
FromJSON EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods parseJSON :: Value -> Parser EnhancedMonitoringOutput # parseJSONList :: Value -> Parser [EnhancedMonitoringOutput] #
type Rep EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput type Rep EnhancedMonitoringOutput = D1 ('MetaData "EnhancedMonitoringOutput" "Amazonka.Kinesis.Types.EnhancedMonitoringOutput" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "EnhancedMonitoringOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "desiredShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: (S1 ('MetaSel ('Just "currentShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: 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:desiredShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_desiredShardLevelMetrics - Represents the list of all the metrics that would be in the enhanced state after the operation.

$sel:currentShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_currentShardLevelMetrics - Represents the current state of the metrics that are in the enhanced state before the operation.

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

Response Lenses

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_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #

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

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

The name of the Kinesis data stream.