PutMetricPolicyCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MediaStoreClient, PutMetricPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import
// const { MediaStoreClient, PutMetricPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import
const client = new MediaStoreClient(config);
const input = { // PutMetricPolicyInput
  ContainerName: "STRING_VALUE", // required
  MetricPolicy: { // MetricPolicy
    ContainerLevelMetrics: "ENABLED" || "DISABLED", // required
    MetricPolicyRules: [ // MetricPolicyRules
      { // MetricPolicyRule
        ObjectGroup: "STRING_VALUE", // required
        ObjectGroupName: "STRING_VALUE", // required
      },
    ],
  },
};
const command = new PutMetricPolicyCommand(input);
const response = await client.send(command);
// {};

PutMetricPolicyCommand Input

See PutMetricPolicyCommandInput for more details

Parameter
Type
Description
ContainerName
Required
string | undefined

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

MetricPolicy
Required
MetricPolicy | undefined

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

PutMetricPolicyCommand Output

See PutMetricPolicyCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ContainerInUseException
client

The container that you specified in the request already exists or is being updated.

ContainerNotFoundException
client

The container that you specified in the request does not exist.

InternalServerError
server

The service is temporarily unavailable.

MediaStoreServiceException
Base exception class for all service exceptions from MediaStore service.