amazonka-cloudwatch-2.0: Amazon CloudWatch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudWatch.PutMetricStream

Description

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party solutions.

For more information, see Using Metric Streams.

To create a metric stream, you must be signed in to an account that has the iam:PassRole permission and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream permission.

When you create or update a metric stream, you choose one of the following:

  • Stream metrics from all metric namespaces in the account.
  • Stream metrics from all metric namespaces in the account, except for the namespaces that you list in ExcludeFilters.
  • Stream metrics from only the metric namespaces that you list in IncludeFilters.

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use the StatisticsConfigurations parameter to have the metric stream send additional statistics in the stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing.

When you use PutMetricStream to create a new metric stream, the stream is created in the running state. If you use it to update an existing stream, the state of the stream is not changed.

Synopsis

Creating a Request

data PutMetricStream Source #

See: newPutMetricStream smart constructor.

Constructors

PutMetricStream' 

Fields

  • excludeFilters :: Maybe [MetricStreamFilter]

    If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

    You cannot include ExcludeFilters and IncludeFilters in the same operation.

  • includeFilters :: Maybe [MetricStreamFilter]

    If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

    You cannot include IncludeFilters and ExcludeFilters in the same operation.

  • statisticsConfigurations :: Maybe [MetricStreamStatisticsConfiguration]

    By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

    For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

  • tags :: Maybe [Tag]

    A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

  • name :: Text

    If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

    If you are updating a metric stream, specify the name of that stream here.

    Valid characters are A-Z, a-z, 0-9, "-" and "_".

  • firehoseArn :: Text

    The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.

  • roleArn :: Text

    The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:

    • firehose:PutRecord
    • firehose:PutRecordBatch
  • outputFormat :: 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.

Instances

Instances details
ToHeaders PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

ToPath PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

ToQuery PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

AWSRequest PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

Associated Types

type AWSResponse PutMetricStream #

Generic PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

Associated Types

type Rep PutMetricStream :: Type -> Type #

Read PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

Show PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

NFData PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

Methods

rnf :: PutMetricStream -> () #

Eq PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

Hashable PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

type AWSResponse PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

type Rep PutMetricStream Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

newPutMetricStream Source #

Create a value of PutMetricStream 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:excludeFilters:PutMetricStream', putMetricStream_excludeFilters - If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

You cannot include ExcludeFilters and IncludeFilters in the same operation.

$sel:includeFilters:PutMetricStream', putMetricStream_includeFilters - If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

You cannot include IncludeFilters and ExcludeFilters in the same operation.

$sel:statisticsConfigurations:PutMetricStream', putMetricStream_statisticsConfigurations - By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

PutMetricStream, putMetricStream_tags - A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

PutMetricStream, putMetricStream_name - If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

If you are updating a metric stream, specify the name of that stream here.

Valid characters are A-Z, a-z, 0-9, "-" and "_".

PutMetricStream, putMetricStream_firehoseArn - The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.

$sel:roleArn:PutMetricStream', putMetricStream_roleArn - The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:

  • firehose:PutRecord
  • firehose:PutRecordBatch

PutMetricStream, putMetricStream_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.

Request Lenses

putMetricStream_excludeFilters :: Lens' PutMetricStream (Maybe [MetricStreamFilter]) Source #

If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

You cannot include ExcludeFilters and IncludeFilters in the same operation.

putMetricStream_includeFilters :: Lens' PutMetricStream (Maybe [MetricStreamFilter]) Source #

If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

You cannot include IncludeFilters and ExcludeFilters in the same operation.

putMetricStream_statisticsConfigurations :: Lens' PutMetricStream (Maybe [MetricStreamStatisticsConfiguration]) Source #

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

putMetricStream_tags :: Lens' PutMetricStream (Maybe [Tag]) Source #

A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

putMetricStream_name :: Lens' PutMetricStream Text Source #

If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

If you are updating a metric stream, specify the name of that stream here.

Valid characters are A-Z, a-z, 0-9, "-" and "_".

putMetricStream_firehoseArn :: Lens' PutMetricStream Text Source #

The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.

putMetricStream_roleArn :: Lens' PutMetricStream Text Source #

The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:

  • firehose:PutRecord
  • firehose:PutRecordBatch

putMetricStream_outputFormat :: Lens' PutMetricStream 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.

Destructuring the Response

data PutMetricStreamResponse Source #

See: newPutMetricStreamResponse smart constructor.

Constructors

PutMetricStreamResponse' 

Fields

Instances

Instances details
Generic PutMetricStreamResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

Associated Types

type Rep PutMetricStreamResponse :: Type -> Type #

Read PutMetricStreamResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

Show PutMetricStreamResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

NFData PutMetricStreamResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

Methods

rnf :: PutMetricStreamResponse -> () #

Eq PutMetricStreamResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

type Rep PutMetricStreamResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutMetricStream

type Rep PutMetricStreamResponse = D1 ('MetaData "PutMetricStreamResponse" "Amazonka.CloudWatch.PutMetricStream" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "PutMetricStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutMetricStreamResponse Source #

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

PutMetricStreamResponse, putMetricStreamResponse_arn - The ARN of the metric stream.

$sel:httpStatus:PutMetricStreamResponse', putMetricStreamResponse_httpStatus - The response's http status code.

Response Lenses