libZSservicesZSamazonka-mediastoreZSamazonka-mediastore
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaStore.PutMetricPolicy

Description

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.

Synopsis

Creating a Request

data PutMetricPolicy Source #

See: newPutMetricPolicy smart constructor.

Constructors

PutMetricPolicy' 

Fields

  • containerName :: Text

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

  • metricPolicy :: 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).

Instances

Instances details
Eq PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Read PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Show PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Generic PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Associated Types

type Rep PutMetricPolicy :: Type -> Type #

NFData PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Methods

rnf :: PutMetricPolicy -> () #

Hashable PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

ToJSON PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

AWSRequest PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Associated Types

type AWSResponse PutMetricPolicy #

ToHeaders PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

ToPath PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

ToQuery PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

type Rep PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

type Rep PutMetricPolicy = D1 ('MetaData "PutMetricPolicy" "Amazonka.MediaStore.PutMetricPolicy" "libZSservicesZSamazonka-mediastoreZSamazonka-mediastore" 'False) (C1 ('MetaCons "PutMetricPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "metricPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricPolicy)))
type AWSResponse PutMetricPolicy Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

newPutMetricPolicy Source #

Create a value of PutMetricPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerName:PutMetricPolicy', putMetricPolicy_containerName - The name of the container that you want to add the metric policy to.

$sel:metricPolicy:PutMetricPolicy', putMetricPolicy_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).

Request Lenses

putMetricPolicy_containerName :: Lens' PutMetricPolicy Text Source #

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

putMetricPolicy_metricPolicy :: Lens' PutMetricPolicy MetricPolicy Source #

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

Destructuring the Response

data PutMetricPolicyResponse Source #

See: newPutMetricPolicyResponse smart constructor.

Constructors

PutMetricPolicyResponse' 

Fields

Instances

Instances details
Eq PutMetricPolicyResponse Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Read PutMetricPolicyResponse Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Show PutMetricPolicyResponse Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Generic PutMetricPolicyResponse Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Associated Types

type Rep PutMetricPolicyResponse :: Type -> Type #

NFData PutMetricPolicyResponse Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

Methods

rnf :: PutMetricPolicyResponse -> () #

type Rep PutMetricPolicyResponse Source # 
Instance details

Defined in Amazonka.MediaStore.PutMetricPolicy

type Rep PutMetricPolicyResponse = D1 ('MetaData "PutMetricPolicyResponse" "Amazonka.MediaStore.PutMetricPolicy" "libZSservicesZSamazonka-mediastoreZSamazonka-mediastore" 'False) (C1 ('MetaCons "PutMetricPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutMetricPolicyResponse Source #

Create a value of PutMetricPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:PutMetricPolicyResponse', putMetricPolicyResponse_httpStatus - The response's http status code.

Response Lenses