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

Description

 
Synopsis

Operations

StopAccessLogging

stopAccessLogging_containerName :: Lens' StopAccessLogging Text Source #

The name of the container that you want to stop access logging on.

PutLifecyclePolicy

putLifecyclePolicy_containerName :: Lens' PutLifecyclePolicy Text Source #

The name of the container that you want to assign the object lifecycle policy to.

putLifecyclePolicy_lifecyclePolicy :: Lens' PutLifecyclePolicy Text Source #

The object lifecycle policy to apply to the container.

DeleteLifecyclePolicy

deleteLifecyclePolicy_containerName :: Lens' DeleteLifecyclePolicy Text Source #

The name of the container that holds the object lifecycle policy.

ListTagsForResource

listTagsForResource_resource :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) for the container.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

An array of key:value pairs that are assigned to the container.

CreateContainer

createContainer_tags :: Lens' CreateContainer (Maybe (NonEmpty Tag)) Source #

An array of key:value pairs that you define. These values can be anything that you want. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

createContainer_containerName :: Lens' CreateContainer Text Source #

The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

createContainerResponse_container :: Lens' CreateContainerResponse Container Source #

ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:<region>:<account that owns this container>:container/<name of container>. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

ContainerName: The container name as specified in the request.

CreationTime: Unix time stamp.

Status: The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When an endpoint is available, the status changes to ACTIVE.

The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using DescribeContainer or ListContainers.

ListContainers

listContainers_nextToken :: Lens' ListContainers (Maybe Text) Source #

Only if you used MaxResults in the first command, enter the token (which was included in the previous response) to obtain the next set of containers. This token is included in a response only if there actually are more containers to list.

listContainers_maxResults :: Lens' ListContainers (Maybe Natural) Source #

Enter the maximum number of containers in the response. Use from 1 to 255 characters.

listContainersResponse_nextToken :: Lens' ListContainersResponse (Maybe Text) Source #

NextToken is the token to use in the next call to ListContainers. This token is returned only if you included the MaxResults tag in the original command, and only if there are still containers to return.

DeleteContainer

deleteContainer_containerName :: Lens' DeleteContainer Text Source #

The name of the container to delete.

PutCorsPolicy

putCorsPolicy_containerName :: Lens' PutCorsPolicy Text Source #

The name of the container that you want to assign the CORS policy to.

putCorsPolicy_corsPolicy :: Lens' PutCorsPolicy (NonEmpty CorsRule) Source #

The CORS policy to apply to the container.

DeleteCorsPolicy

deleteCorsPolicy_containerName :: Lens' DeleteCorsPolicy Text Source #

The name of the container to remove the policy from.

StartAccessLogging

startAccessLogging_containerName :: Lens' StartAccessLogging Text Source #

The name of the container that you want to start access logging on.

DescribeContainer

describeContainer_containerName :: Lens' DescribeContainer (Maybe Text) Source #

The name of the container to query.

GetMetricPolicy

getMetricPolicy_containerName :: Lens' GetMetricPolicy Text Source #

The name of the container that is associated with the metric policy.

getMetricPolicyResponse_metricPolicy :: Lens' GetMetricPolicyResponse MetricPolicy Source #

The metric policy that is associated with the specific container.

DeleteMetricPolicy

deleteMetricPolicy_containerName :: Lens' DeleteMetricPolicy Text Source #

The name of the container that is associated with the metric policy that you want to delete.

PutMetricPolicy

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

GetLifecyclePolicy

getLifecyclePolicy_containerName :: Lens' GetLifecyclePolicy Text Source #

The name of the container that the object lifecycle policy is assigned to.

getLifecyclePolicyResponse_lifecyclePolicy :: Lens' GetLifecyclePolicyResponse Text Source #

The object lifecycle policy that is assigned to the container.

TagResource

tagResource_resource :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) for the container.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

An array of key:value pairs that you want to add to the container. You need to specify only the tags that you want to add or update. For example, suppose a container already has two tags (customer:CompanyA and priority:High). You want to change the priority tag and also add a third tag (type:Contract). For TagResource, you specify the following tags: priority:Medium, type:Contract. The result is that your container has three tags: customer:CompanyA, priority:Medium, and type:Contract.

GetCorsPolicy

getCorsPolicy_containerName :: Lens' GetCorsPolicy Text Source #

The name of the container that the policy is assigned to.

UntagResource

untagResource_resource :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) for the container.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A comma-separated list of keys for tags that you want to remove from the container. For example, if your container has two tags (customer:CompanyA and priority:High) and you want to remove one of the tags (priority:High), you specify the key for the tag that you want to remove (priority).

DeleteContainerPolicy

deleteContainerPolicy_containerName :: Lens' DeleteContainerPolicy Text Source #

The name of the container that holds the policy.

PutContainerPolicy

putContainerPolicy_policy :: Lens' PutContainerPolicy Text Source #

The contents of the policy, which includes the following:

  • One Version tag
  • One Statement tag that contains the standard tags for the policy.

GetContainerPolicy

Types

Container

container_status :: Lens' Container (Maybe ContainerStatus) Source #

The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When the endpoint is available, the status changes to ACTIVE.

container_accessLoggingEnabled :: Lens' Container (Maybe Bool) Source #

The state of access logging on the container. This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true, indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs.

container_arn :: Lens' Container (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container. The ARN has the following format:

arn:aws:<region>:<account that owns this container>:container/<name of container>

For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

container_name :: Lens' Container (Maybe Text) Source #

The name of the container.

container_endpoint :: Lens' Container (Maybe Text) Source #

The DNS endpoint of the container. Use the endpoint to identify the specific container when sending requests to the data plane. The service assigns this value when the container is created. Once the value has been assigned, it does not change.

CorsRule

corsRule_allowedMethods :: Lens' CorsRule (Maybe (NonEmpty MethodName)) Source #

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.

corsRule_maxAgeSeconds :: Lens' CorsRule (Maybe Natural) Source #

The time in seconds that your browser caches the preflight response for the specified resource.

A CORS rule can have only one MaxAgeSeconds element.

corsRule_exposeHeaders :: Lens' CorsRule (Maybe [Text]) Source #

One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

This element is optional for each rule.

corsRule_allowedOrigins :: Lens' CorsRule (NonEmpty Text) Source #

One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

corsRule_allowedHeaders :: Lens' CorsRule [Text] Source #

Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

This element can contain only one wildcard character (*).

MetricPolicy

metricPolicy_metricPolicyRules :: Lens' MetricPolicy (Maybe (NonEmpty MetricPolicyRule)) Source #

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.

metricPolicy_containerLevelMetrics :: Lens' MetricPolicy ContainerLevelMetrics Source #

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

MetricPolicyRule

metricPolicyRule_objectGroup :: Lens' MetricPolicyRule Text Source #

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

metricPolicyRule_objectGroupName :: Lens' MetricPolicyRule Text Source #

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

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

tag_key :: Lens' Tag Text Source #

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.