GetMetricStream
Returns information about the metric stream that you specify.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Name
-
The name of the metric stream to retrieve information about.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Response Elements
The following elements are returned by the service.
- Arn
-
The ARN of the metric stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- CreationDate
-
The date that the metric stream was created.
Type: Timestamp
- ExcludeFilters.member.N
-
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.
Type: Array of MetricStreamFilter objects
- FirehoseArn
-
The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- IncludeFilters.member.N
-
If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
Type: Array of MetricStreamFilter objects
- IncludeLinkedAccountsMetrics
-
If this is
trueand this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.Type: Boolean
- LastUpdateDate
-
The date of the most recent update to the metric stream's configuration.
Type: Timestamp
- Name
-
The name of the metric stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- OutputFormat
-
The output format for the stream. Valid values are
json,opentelemetry1.0, andopentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Valid Values:
json | opentelemetry0.7 | opentelemetry1.0 - RoleArn
-
The ARN of the IAM role that is used by this metric stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- State
-
The state of the metric stream. The possible values are
runningandstopped.Type: String
- StatisticsConfigurations.member.N
-
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.
Type: Array of MetricStreamStatisticsConfiguration objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
Request processing has failed due to some unknown error, exception, or failure.
HTTP Status Code: 500
- InvalidParameterCombination
-
Parameters were used together that cannot be used together.
HTTP Status Code: 400
- InvalidParameterValue
-
The value of an input parameter is bad or out-of-range.
HTTP Status Code: 400
- MissingParameter
-
An input parameter that is required is missing.
HTTP Status Code: 400
- ResourceNotFound
-
The named resource does not exist.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
