UpdateOTelEnrichment
Replaces the filters that determine which CloudWatch vended metrics are enriched
with resource ARN and resource tag labels for the account. Enrichment must already be
running for the account. If it is not, this operation returns a
ResourceNotFoundException. To start enrichment, use StartOTelEnrichment.
The filters in the request completely replace the stored filters; they are not
merged with them. IncludeFilters and ExcludeFilters are
replaced as a pair, so a request that specifies only IncludeFilters also
clears the stored ExcludeFilters, and a request that specifies neither
clears both.
Request Parameters
- ExcludeFilters
-
The metric namespaces, and the metric names, to leave unenriched. If this parameter is omitted, nothing is excluded.
Amazon CloudWatch applies
ExcludeFiltersafterIncludeFilters, so a metric that both parameters match is not enriched.A maximum of 100 filters is allowed across
IncludeFiltersandExcludeFilterscombined.Type: Array of OTelEnrichmentMetricSelector objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
- IncludeFilters
-
The metric namespaces, and the metric names, to enrich. If this parameter is omitted, every namespace that Amazon CloudWatch supports for enrichment is in scope.
A maximum of 100 filters is allowed across
IncludeFiltersandExcludeFilterscombined.Type: Array of OTelEnrichmentMetricSelector objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
Response Elements
The following elements are returned by the service.
- CreatedAt
-
The date and time that enrichment started for the account.
Type: Timestamp
- ExcludeFilters
-
The exclude filters that are stored for the account after the replacement. This parameter is omitted when the request cleared the exclude filters, which means that nothing is excluded.
Type: Array of OTelEnrichmentMetricSelector objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
- IncludeFilters
-
The include filters that are stored for the account after the replacement. This parameter is omitted when the request cleared the include filters, which means that every supported namespace is in scope.
Type: Array of OTelEnrichmentMetricSelector objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
- UpdatedAt
-
The date and time that the enrichment configuration for the account was last stored.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Error Types.
- ResourceNotFoundException
-
The named resource does not exist.
HTTP Status Code: 404
- ValidationError
-
The request failed validation. One or more input parameters do not satisfy the constraints that the operation requires.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
