| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.MediaStore.Types
Description
Synopsis
- defaultService :: Service
- _ContainerInUseException :: AsError a => Fold a ServiceError
- _ContainerNotFoundException :: AsError a => Fold a ServiceError
- _CorsPolicyNotFoundException :: AsError a => Fold a ServiceError
- _InternalServerError :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _PolicyNotFoundException :: AsError a => Fold a ServiceError
- newtype ContainerLevelMetrics where
- newtype ContainerStatus where
- ContainerStatus' { }
- pattern ContainerStatus_ACTIVE :: ContainerStatus
- pattern ContainerStatus_CREATING :: ContainerStatus
- pattern ContainerStatus_DELETING :: ContainerStatus
- newtype MethodName where
- MethodName' { }
- pattern MethodName_DELETE :: MethodName
- pattern MethodName_GET :: MethodName
- pattern MethodName_HEAD :: MethodName
- pattern MethodName_PUT :: MethodName
- data Container = Container' {}
- newContainer :: Container
- container_arn :: Lens' Container (Maybe Text)
- container_accessLoggingEnabled :: Lens' Container (Maybe Bool)
- container_creationTime :: Lens' Container (Maybe UTCTime)
- container_endpoint :: Lens' Container (Maybe Text)
- container_name :: Lens' Container (Maybe Text)
- container_status :: Lens' Container (Maybe ContainerStatus)
- data CorsRule = CorsRule' {}
- newCorsRule :: NonEmpty Text -> CorsRule
- corsRule_allowedMethods :: Lens' CorsRule (Maybe (NonEmpty MethodName))
- corsRule_exposeHeaders :: Lens' CorsRule (Maybe [Text])
- corsRule_maxAgeSeconds :: Lens' CorsRule (Maybe Natural)
- corsRule_allowedOrigins :: Lens' CorsRule (NonEmpty Text)
- corsRule_allowedHeaders :: Lens' CorsRule [Text]
- data MetricPolicy = MetricPolicy' {}
- newMetricPolicy :: ContainerLevelMetrics -> MetricPolicy
- metricPolicy_metricPolicyRules :: Lens' MetricPolicy (Maybe (NonEmpty MetricPolicyRule))
- metricPolicy_containerLevelMetrics :: Lens' MetricPolicy ContainerLevelMetrics
- data MetricPolicyRule = MetricPolicyRule' {}
- newMetricPolicyRule :: Text -> Text -> MetricPolicyRule
- metricPolicyRule_objectGroup :: Lens' MetricPolicyRule Text
- metricPolicyRule_objectGroupName :: Lens' MetricPolicyRule Text
- data Tag = Tag' {}
- newTag :: Text -> Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2017-09-01 of the Amazon Elemental MediaStore SDK configuration.
Errors
_ContainerInUseException :: AsError a => Fold a ServiceError Source #
The container that you specified in the request already exists or is being updated.
_ContainerNotFoundException :: AsError a => Fold a ServiceError Source #
The container that you specified in the request does not exist.
_CorsPolicyNotFoundException :: AsError a => Fold a ServiceError Source #
The CORS policy that you specified in the request does not exist.
_InternalServerError :: AsError a => Fold a ServiceError Source #
The service is temporarily unavailable.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A service limit has been exceeded.
_PolicyNotFoundException :: AsError a => Fold a ServiceError Source #
The policy that you specified in the request does not exist.
ContainerLevelMetrics
newtype ContainerLevelMetrics Source #
Constructors
| ContainerLevelMetrics' | |
Fields | |
Bundled Patterns
| pattern ContainerLevelMetrics_DISABLED :: ContainerLevelMetrics | |
| pattern ContainerLevelMetrics_ENABLED :: ContainerLevelMetrics |
Instances
ContainerStatus
newtype ContainerStatus Source #
Constructors
| ContainerStatus' | |
Fields | |
Bundled Patterns
| pattern ContainerStatus_ACTIVE :: ContainerStatus | |
| pattern ContainerStatus_CREATING :: ContainerStatus | |
| pattern ContainerStatus_DELETING :: ContainerStatus |
Instances
MethodName
newtype MethodName Source #
Constructors
| MethodName' | |
Fields | |
Bundled Patterns
| pattern MethodName_DELETE :: MethodName | |
| pattern MethodName_GET :: MethodName | |
| pattern MethodName_HEAD :: MethodName | |
| pattern MethodName_PUT :: MethodName |
Instances
Container
This section describes operations that you can perform on an AWS Elemental MediaStore container.
See: newContainer smart constructor.
Constructors
| Container' | |
Fields
| |
Instances
newContainer :: Container Source #
Create a value of Container 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:arn:Container', container_arn - 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
$sel:accessLoggingEnabled:Container', container_accessLoggingEnabled - 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.
$sel:creationTime:Container', container_creationTime - Unix timestamp.
$sel:endpoint:Container', container_endpoint - 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.
$sel:name:Container', container_name - The name of the container.
$sel:status:Container', container_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 the endpoint is
available, the status changes to ACTIVE.
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_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_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.
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.
CorsRule
A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.
See: newCorsRule smart constructor.
Constructors
| CorsRule' | |
Fields
| |
Instances
Create a value of CorsRule 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:allowedMethods:CorsRule', corsRule_allowedMethods - 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.
$sel:exposeHeaders:CorsRule', corsRule_exposeHeaders - 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.
$sel:maxAgeSeconds:CorsRule', corsRule_maxAgeSeconds - The time in seconds that your browser caches the preflight response for
the specified resource.
A CORS rule can have only one MaxAgeSeconds element.
$sel:allowedOrigins:CorsRule', corsRule_allowedOrigins - 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.
$sel:allowedHeaders:CorsRule', corsRule_allowedHeaders - 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 (*).
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_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_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_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
data MetricPolicy Source #
The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.
To view examples of how to construct a metric policy for your use case, see Example Metric Policies.
See: newMetricPolicy smart constructor.
Constructors
| MetricPolicy' | |
Fields
| |
Instances
Create a value of MetricPolicy 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:metricPolicyRules:MetricPolicy', metricPolicy_metricPolicyRules - 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.
$sel:containerLevelMetrics:MetricPolicy', metricPolicy_containerLevelMetrics - A setting to enable or disable metrics at the container level.
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
data MetricPolicyRule Source #
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.
See: newMetricPolicyRule smart constructor.
Constructors
| MetricPolicyRule' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> MetricPolicyRule |
Create a value of MetricPolicyRule 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:objectGroup:MetricPolicyRule', metricPolicyRule_objectGroup - A path or file name that defines which objects to include in the group.
Wildcards (*) are acceptable.
$sel:objectGroupName:MetricPolicyRule', metricPolicyRule_objectGroupName - A name that allows you to refer to the object group.
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
A collection of tags associated with a container. Each tag consists of a key:value pair, which can be anything you define. 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.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.MediaStore.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.MediaStore.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.MediaStore.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.MediaStore.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.MediaStore.Types.Tag" "amazonka-mediastore-2.0-BBurv4SFAUa5diuD6Q5z4D" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:value:Tag', tag_value - 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.
$sel:key:Tag', tag_key - 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.