PutMetricPolicy
The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.
Request Syntax
{
"ContainerName": "string
",
"MetricPolicy": {
"ContainerLevelMetrics": "string
",
"MetricPolicyRules": [
{
"ObjectGroup": "string
",
"ObjectGroupName": "string
"
}
]
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ContainerName
-
The name of the container that you want to add the metric policy to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\w-]+
Required: Yes
- MetricPolicy
-
The metric policy that you want to associate with the container. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include up to five rules to define groups of objects that you want MediaStore to send object-level metrics for. If you include rules in the policy, construct each rule with both of the following:
-
An object group that defines which objects to include in the group. The definition can be a path or a file name, but it can't have more than 900 characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable.
-
An object group name that allows you to refer to the object group. The name can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ (underscore).
Type: MetricPolicy object
Required: Yes
-
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ContainerInUseException
-
The container that you specified in the request already exists or is being updated.
HTTP Status Code: 400
- ContainerNotFoundException
-
The container that you specified in the request does not exist.
HTTP Status Code: 400
- InternalServerError
-
The service is temporarily unavailable.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: