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.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' {
- arn :: Maybe Text
- creationDate :: Maybe ISO8601
- excludeFilters :: Maybe [MetricStreamFilter]
- firehoseArn :: Maybe Text
- includeFilters :: Maybe [MetricStreamFilter]
- lastUpdateDate :: Maybe ISO8601
- name :: Maybe Text
- outputFormat :: Maybe MetricStreamOutputFormat
- roleArn :: Maybe Text
- state :: Maybe Text
- statisticsConfigurations :: Maybe [MetricStreamStatisticsConfiguration]
- httpStatus :: Int
}
newGetMetricStreamResponse :: Int -> GetMetricStreamResponse
getMetricStreamResponse_arn :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_creationDate :: Lens' GetMetricStreamResponse (Maybe UTCTime)
getMetricStreamResponse_excludeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter])
getMetricStreamResponse_firehoseArn :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_includeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter])
getMetricStreamResponse_lastUpdateDate :: Lens' GetMetricStreamResponse (Maybe UTCTime)
getMetricStreamResponse_name :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_outputFormat :: Lens' GetMetricStreamResponse (Maybe MetricStreamOutputFormat)
getMetricStreamResponse_roleArn :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_state :: Lens' GetMetricStreamResponse (Maybe Text)
getMetricStreamResponse_statisticsConfigurations :: Lens' GetMetricStreamResponse (Maybe [MetricStreamStatisticsConfiguration])
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

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 #
AWSRequest GetMetricStream Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Associated Types type AWSResponse GetMetricStream # Methods request :: (Service -> Service) -> GetMetricStream -> Request GetMetricStream # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetMetricStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMetricStream))) #
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 #
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 #
NFData GetMetricStream Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods rnf :: GetMetricStream -> () #
Eq GetMetricStream Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods (==) :: GetMetricStream -> GetMetricStream -> Bool # (/=) :: GetMetricStream -> GetMetricStream -> Bool #
Hashable GetMetricStream Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods hashWithSalt :: Int -> GetMetricStream -> Int # hash :: GetMetricStream -> Int #
type AWSResponse GetMetricStream Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream type AWSResponse GetMetricStream = GetMetricStreamResponse
type Rep GetMetricStream Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream type Rep GetMetricStream = D1 ('MetaData "GetMetricStream" "Amazonka.CloudWatch.GetMetricStream" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "GetMetricStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetMetricStream Source #

Arguments

:: Text	`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:

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

arn :: Maybe Text
The ARN of the metric stream.
creationDate :: Maybe ISO8601
The date that the metric stream was created.
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.
firehoseArn :: Maybe Text
The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
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.
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.
outputFormat :: Maybe MetricStreamOutputFormat
The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
roleArn :: Maybe Text
The ARN of the IAM role that is used by this metric stream.
state :: Maybe Text
The state of the metric stream. The possible values are running and stopped.
statisticsConfigurations :: Maybe [MetricStreamStatisticsConfiguration]
Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods rnf :: GetMetricStreamResponse -> () #
Eq GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream Methods (==) :: GetMetricStreamResponse -> GetMetricStreamResponse -> Bool # (/=) :: GetMetricStreamResponse -> GetMetricStreamResponse -> Bool #
type Rep GetMetricStreamResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetMetricStream type Rep GetMetricStreamResponse = D1 ('MetaData "GetMetricStreamResponse" "Amazonka.CloudWatch.GetMetricStream" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "GetMetricStreamResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "excludeFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricStreamFilter])))) :: (S1 ('MetaSel ('Just "firehoseArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "includeFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricStreamFilter])) :: S1 ('MetaSel ('Just "lastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "outputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricStreamOutputFormat)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "statisticsConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricStreamStatisticsConfiguration])) :*: 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:

GetMetricStreamResponse, getMetricStreamResponse_arn - The ARN of the metric stream.

GetMetricStreamResponse, getMetricStreamResponse_creationDate - The date that the metric stream was created.

$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.

GetMetricStreamResponse, getMetricStreamResponse_firehoseArn - The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.

$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.

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

GetMetricStream, getMetricStreamResponse_name - The name of the metric stream.

GetMetricStreamResponse, getMetricStreamResponse_outputFormat - The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

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

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

$sel:statisticsConfigurations:GetMetricStreamResponse', getMetricStreamResponse_statisticsConfigurations - Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

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

Response Lenses

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

The ARN of the metric stream.

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

The date that the metric stream was created.

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_firehoseArn :: Lens' GetMetricStreamResponse (Maybe Text) Source #

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

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_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_outputFormat :: Lens' GetMetricStreamResponse (Maybe MetricStreamOutputFormat) Source #

The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

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

The ARN of the IAM role that is used 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_statisticsConfigurations :: Lens' GetMetricStreamResponse (Maybe [MetricStreamStatisticsConfiguration]) Source #

Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

getMetricStreamResponse_httpStatus :: Lens' GetMetricStreamResponse Int Source #

The response's http status code.