Skip to content

GetMetricStreamOutput

Source code in docs_src/capo_cloudwatch/types/get_metric_stream_output.py
class GetMetricStreamOutput(TypedDict, closed=True):
    arn: NotRequired["capo_cloudwatch.types.amazon_resource_name.AmazonResourceName"]
    """<p>The ARN of the metric stream.</p>"""
    name: NotRequired["capo_cloudwatch.types.metric_stream_name.MetricStreamName"]
    """<p>The name of the metric stream.</p>"""
    include_filters: NotRequired[
        "capo_cloudwatch.types.metric_stream_filters.MetricStreamFilters"
    ]
    """<p>If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.</p>"""
    exclude_filters: NotRequired[
        "capo_cloudwatch.types.metric_stream_filters.MetricStreamFilters"
    ]
    """<p>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.</p>"""
    firehose_arn: NotRequired[
        "capo_cloudwatch.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.</p>"""
    role_arn: NotRequired[
        "capo_cloudwatch.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the IAM role that is used by this metric stream.</p>"""
    state: NotRequired["capo_cloudwatch.types.metric_stream_state.MetricStreamState"]
    """<p>The state of the metric stream. The possible values are <code>running</code> and <code>stopped</code>.</p>"""
    creation_date: NotRequired["capo_cloudwatch.types.timestamp.Timestamp"]
    """<p>The date that the metric stream was created.</p>"""
    last_update_date: NotRequired["capo_cloudwatch.types.timestamp.Timestamp"]
    """<p>The date of the most recent update to the metric stream's configuration.</p>"""
    output_format: NotRequired[
        "capo_cloudwatch.types.metric_stream_output_format.MetricStreamOutputFormat"
    ]
    """<p>The output format for the stream. Valid values are <code>json</code>, <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>. For more information about metric stream output formats, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">Metric streams output formats</a>.</p>"""
    statistics_configurations: NotRequired[
        "capo_cloudwatch.types.metric_stream_statistics_configurations.MetricStreamStatisticsConfigurations"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html"> CloudWatch statistics definitions</a>. </p>"""
    include_linked_accounts_metrics: NotRequired[
        "capo_cloudwatch.types.include_linked_accounts_metrics.IncludeLinkedAccountsMetrics"
    ]
    """<p>If this is <code>true</code> and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.</p>"""

arn instance-attribute

arn: NotRequired[AmazonResourceName]

The ARN of the metric stream.

creation_date instance-attribute

creation_date: NotRequired[Timestamp]

The date that the metric stream was created.

exclude_filters instance-attribute

exclude_filters: NotRequired[MetricStreamFilters]

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.

firehose_arn instance-attribute

firehose_arn: NotRequired[AmazonResourceName]

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

include_filters instance-attribute

include_filters: NotRequired[MetricStreamFilters]

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

include_linked_accounts_metrics instance-attribute

include_linked_accounts_metrics: NotRequired[IncludeLinkedAccountsMetrics]

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.

last_update_date instance-attribute

last_update_date: NotRequired[Timestamp]

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

name instance-attribute

name: NotRequired[MetricStreamName]

The name of the metric stream.

output_format instance-attribute

output_format: NotRequired[MetricStreamOutputFormat]

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

role_arn instance-attribute

role_arn: NotRequired[AmazonResourceName]

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

state instance-attribute

state: NotRequired[MetricStreamState]

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

statistics_configurations instance-attribute

statistics_configurations: NotRequired[MetricStreamStatisticsConfigurations]

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.