Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface GetMetricStreamCommandOutputProtected

The output of GetMetricStreamCommand.

Hierarchy

Properties

$metadata: ResponseMetadata

Metadata pertaining to this request.

Arn?: string

The ARN of the metric stream.

CreationDate?: Date

The date that the metric stream was created.

ExcludeFilters?: 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?: string

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

IncludeFilters?: MetricStreamFilter[]

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

IncludeLinkedAccountsMetrics?: boolean

If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.

LastUpdateDate?: Date

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

Name?: string

The name of the metric stream.

OutputFormat?: string

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?: string

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

State?: string

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

StatisticsConfigurations?: 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.