MediaStore / Client / put_metric_policy

put_metric_policy#

MediaStore.Client.put_metric_policy(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.put_metric_policy(
    ContainerName='string',
    MetricPolicy={
        'ContainerLevelMetrics': 'ENABLED'|'DISABLED',
        'MetricPolicyRules': [
            {
                'ObjectGroup': 'string',
                'ObjectGroupName': 'string'
            },
        ]
    }
)
Parameters:

  • ContainerName (string) –

    [REQUIRED]

    The name of the container that you want to add the metric policy to.

  • MetricPolicy (dict) –

    [REQUIRED]

    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).

    • ContainerLevelMetrics (string) – [REQUIRED]

      A setting to enable or disable metrics at the container level.

    • MetricPolicyRules (list) –

      A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy.

      • (dict) –

        A setting that enables metrics at the object level. Each rule contains an object group and an object group name. If the policy includes the MetricPolicyRules parameter, you must include at least one rule. Each metric policy can include up to five rules by default. You can also request a quota increase to allow up to 300 rules per policy.

        • ObjectGroup (string) – [REQUIRED]

          A path or file name that defines which objects to include in the group. Wildcards (*) are acceptable.

        • ObjectGroupName (string) – [REQUIRED]

          A name that allows you to refer to the object group.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • MediaStore.Client.exceptions.ContainerInUseException

  • MediaStore.Client.exceptions.ContainerNotFoundException

  • MediaStore.Client.exceptions.InternalServerError