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.CloudWatch.GetMetricStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the metric stream that you specify.

Synopsis

data GetMetricStream = GetMetricStream' {
- name :: Text
}
newGetMetricStream :: Text -> GetMetricStream
getMetricStream_name :: Lens' GetMetricStream Text
data GetMetricStreamResponse = GetMetricStreamResponse' {
- includeFilters :: Maybe [MetricStreamFilter]
- state :: Maybe Text
- excludeFilters :: Maybe [MetricStreamFilter]
- arn :: Maybe Text
- firehoseArn :: Maybe Text
- outputFormat :: Maybe MetricStreamOutputFormat
- lastUpdateDate :: Maybe ISO8601
- name :: Maybe Text
- creationDate :: Maybe ISO8601
- roleArn :: Maybe Text
- httpStatus :: Int
}
newGetMetricStreamResponse :: Int -> GetMetricStreamResponse
getMetricStreamResponse_includeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter])
getMetricStreamResponse_state :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_excludeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter])
getMetricStreamResponse_arn :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_firehoseArn :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_outputFormat :: Lens' GetMetricStreamResponse (Maybe MetricStreamOutputFormat)
getMetricStreamResponse_lastUpdateDate :: Lens' GetMetricStreamResponse (Maybe UTCTime)
getMetricStreamResponse_name :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_creationDate :: Lens' GetMetricStreamResponse (Maybe UTCTime)
getMetricStreamResponse_roleArn :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_httpStatus :: Lens' GetMetricStreamResponse Int

Creating a Request

data GetMetricStream Source #

See: newGetMetricStream smart constructor.

Constructors

GetMetricStream'
Fields name :: Text The name of the metric stream to retrieve information about.

Instances

Instances details

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

newGetMetricStream Source #

Arguments

:: Text	`$sel:name:GetMetricStream'`
-> GetMetricStream

Create a value of GetMetricStream 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:name:GetMetricStream', getMetricStream_name - The name of the metric stream to retrieve information about.

Request Lenses

getMetricStream_name :: Lens' GetMetricStream Text Source #

The name of the metric stream to retrieve information about.

Destructuring the Response

data GetMetricStreamResponse Source #

See: newGetMetricStreamResponse smart constructor.

Constructors

GetMetricStreamResponse'

Fields

includeFilters :: Maybe [MetricStreamFilter]
If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
state :: Maybe Text
The state of the metric stream. The possible values are running and stopped.
excludeFilters :: Maybe [MetricStreamFilter]
If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.
arn :: Maybe Text
The ARN of the metric stream.
firehoseArn :: Maybe Text
The ARN of the Amazon Kinesis Firehose delivery stream that is used by this metric stream.
outputFormat :: Maybe MetricStreamOutputFormat
lastUpdateDate :: Maybe ISO8601
The date of the most recent update to the metric stream's configuration.
name :: Maybe Text
The name of the metric stream.
creationDate :: Maybe ISO8601
The date that the metric stream was created.
roleArn :: Maybe Text
The ARN of the IAM role that is used by this metric stream.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods (==) :: GetMetricStreamResponse -> GetMetricStreamResponse -> Bool # (/=) :: GetMetricStreamResponse -> GetMetricStreamResponse -> Bool #
Read GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods readsPrec :: Int -> ReadS GetMetricStreamResponse # readList :: ReadS [GetMetricStreamResponse] # readPrec :: ReadPrec GetMetricStreamResponse # readListPrec :: ReadPrec [GetMetricStreamResponse] #
Show GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods showsPrec :: Int -> GetMetricStreamResponse -> ShowS # show :: GetMetricStreamResponse -> String # showList :: [GetMetricStreamResponse] -> ShowS #
Generic GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Associated Types type Rep GetMetricStreamResponse :: Type -> Type # Methods from :: GetMetricStreamResponse -> Rep GetMetricStreamResponse x # to :: Rep GetMetricStreamResponse x -> GetMetricStreamResponse #
NFData GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods rnf :: GetMetricStreamResponse -> () #
type Rep GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream type Rep GetMetricStreamResponse = D1 ('MetaData "GetMetricStreamResponse" "Amazonka.CloudWatch.GetMetricStream" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "GetMetricStreamResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "includeFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricStreamFilter])) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "excludeFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricStreamFilter])) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "firehoseArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "outputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricStreamOutputFormat)) :: (S1 ('MetaSel ('Just "lastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetMetricStreamResponse Source #

Arguments

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

Create a value of GetMetricStreamResponse 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:includeFilters:GetMetricStreamResponse', getMetricStreamResponse_includeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

$sel:state:GetMetricStreamResponse', getMetricStreamResponse_state - The state of the metric stream. The possible values are running and stopped.

$sel:excludeFilters:GetMetricStreamResponse', getMetricStreamResponse_excludeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

$sel:arn:GetMetricStreamResponse', getMetricStreamResponse_arn - The ARN of the metric stream.

$sel:firehoseArn:GetMetricStreamResponse', getMetricStreamResponse_firehoseArn - The ARN of the Amazon Kinesis Firehose delivery stream that is used by this metric stream.

$sel:outputFormat:GetMetricStreamResponse', getMetricStreamResponse_outputFormat -

$sel:lastUpdateDate:GetMetricStreamResponse', getMetricStreamResponse_lastUpdateDate - The date of the most recent update to the metric stream's configuration.

$sel:name:GetMetricStream', getMetricStreamResponse_name - The name of the metric stream.

$sel:creationDate:GetMetricStreamResponse', getMetricStreamResponse_creationDate - The date that the metric stream was created.

$sel:roleArn:GetMetricStreamResponse', getMetricStreamResponse_roleArn - The ARN of the IAM role that is used by this metric stream.

$sel:httpStatus:GetMetricStreamResponse', getMetricStreamResponse_httpStatus - The response's http status code.

Response Lenses

getMetricStreamResponse_includeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter]) Source #

If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

getMetricStreamResponse_state :: Lens' GetMetricStreamResponse (Maybe Text) Source #

The state of the metric stream. The possible values are running and stopped.

getMetricStreamResponse_excludeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter]) Source #

If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

getMetricStreamResponse_arn :: Lens' GetMetricStreamResponse (Maybe Text) Source #

The ARN of the metric stream.

getMetricStreamResponse_firehoseArn :: Lens' GetMetricStreamResponse (Maybe Text) Source #

The ARN of the Amazon Kinesis Firehose delivery stream that is used by this metric stream.

getMetricStreamResponse_outputFormat :: Lens' GetMetricStreamResponse (Maybe MetricStreamOutputFormat) Source #

getMetricStreamResponse_lastUpdateDate :: Lens' GetMetricStreamResponse (Maybe UTCTime) Source #

The date of the most recent update to the metric stream's configuration.

getMetricStreamResponse_name :: Lens' GetMetricStreamResponse (Maybe Text) Source #

The name of the metric stream.

getMetricStreamResponse_creationDate :: Lens' GetMetricStreamResponse (Maybe UTCTime) Source #

The date that the metric stream was created.

getMetricStreamResponse_roleArn :: Lens' GetMetricStreamResponse (Maybe Text) Source #

The ARN of the IAM role that is used by this metric stream.

getMetricStreamResponse_httpStatus :: Lens' GetMetricStreamResponse Int Source #

The response's http status code.