AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the GetMetricStream operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.CloudWatch.Model.GetMetricStreamResponse

Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

C#
public class GetMetricStreamResponse : AmazonWebServiceResponse

The GetMetricStreamResponse type exposes the following members

Constructors

NameDescription
Public Method GetMetricStreamResponse()

Properties

NameTypeDescription
Public Property Arn System.String

Gets and sets the property Arn.

The ARN of the metric stream.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreationDate System.Nullable<System.DateTime>

Gets and sets the property CreationDate.

The date that the metric stream was created.

Public Property ExcludeFilters System.Collections.Generic.List<Amazon.CloudWatch.Model.MetricStreamFilter>

Gets and sets the property 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.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property FirehoseArn System.String

Gets and sets the property FirehoseArn.

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

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property IncludeFilters System.Collections.Generic.List<Amazon.CloudWatch.Model.MetricStreamFilter>

Gets and sets the property IncludeFilters.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property IncludeLinkedAccountsMetrics System.Nullable<System.Boolean>

Gets and sets the property 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.

Public Property LastUpdateDate System.Nullable<System.DateTime>

Gets and sets the property LastUpdateDate.

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

Public Property Name System.String

Gets and sets the property Name.

The name of the metric stream.

Public Property OutputFormat Amazon.CloudWatch.MetricStreamOutputFormat

Gets and sets the property OutputFormat.

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.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property RoleArn System.String

Gets and sets the property RoleArn.

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

Public Property State System.String

Gets and sets the property State.

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

Public Property StatisticsConfigurations System.Collections.Generic.List<Amazon.CloudWatch.Model.MetricStreamStatisticsConfiguration>

Gets and sets the property 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.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer