/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / mediastore.d.ts
mediastore.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class MediaStore extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: MediaStore.Types.ClientConfiguration) 13 config: Config & MediaStore.Types.ClientConfiguration; 14 /** 15 * Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service. 16 */ 17 createContainer(params: MediaStore.Types.CreateContainerInput, callback?: (err: AWSError, data: MediaStore.Types.CreateContainerOutput) => void): Request<MediaStore.Types.CreateContainerOutput, AWSError>; 18 /** 19 * Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service. 20 */ 21 createContainer(callback?: (err: AWSError, data: MediaStore.Types.CreateContainerOutput) => void): Request<MediaStore.Types.CreateContainerOutput, AWSError>; 22 /** 23 * Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers. 24 */ 25 deleteContainer(params: MediaStore.Types.DeleteContainerInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteContainerOutput) => void): Request<MediaStore.Types.DeleteContainerOutput, AWSError>; 26 /** 27 * Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers. 28 */ 29 deleteContainer(callback?: (err: AWSError, data: MediaStore.Types.DeleteContainerOutput) => void): Request<MediaStore.Types.DeleteContainerOutput, AWSError>; 30 /** 31 * Deletes the access policy that is associated with the specified container. 32 */ 33 deleteContainerPolicy(params: MediaStore.Types.DeleteContainerPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteContainerPolicyOutput) => void): Request<MediaStore.Types.DeleteContainerPolicyOutput, AWSError>; 34 /** 35 * Deletes the access policy that is associated with the specified container. 36 */ 37 deleteContainerPolicy(callback?: (err: AWSError, data: MediaStore.Types.DeleteContainerPolicyOutput) => void): Request<MediaStore.Types.DeleteContainerPolicyOutput, AWSError>; 38 /** 39 * Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others. 40 */ 41 deleteCorsPolicy(params: MediaStore.Types.DeleteCorsPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteCorsPolicyOutput) => void): Request<MediaStore.Types.DeleteCorsPolicyOutput, AWSError>; 42 /** 43 * Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others. 44 */ 45 deleteCorsPolicy(callback?: (err: AWSError, data: MediaStore.Types.DeleteCorsPolicyOutput) => void): Request<MediaStore.Types.DeleteCorsPolicyOutput, AWSError>; 46 /** 47 * Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect. 48 */ 49 deleteLifecyclePolicy(params: MediaStore.Types.DeleteLifecyclePolicyInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteLifecyclePolicyOutput) => void): Request<MediaStore.Types.DeleteLifecyclePolicyOutput, AWSError>; 50 /** 51 * Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect. 52 */ 53 deleteLifecyclePolicy(callback?: (err: AWSError, data: MediaStore.Types.DeleteLifecyclePolicyOutput) => void): Request<MediaStore.Types.DeleteLifecyclePolicyOutput, AWSError>; 54 /** 55 * Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch. 56 */ 57 deleteMetricPolicy(params: MediaStore.Types.DeleteMetricPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteMetricPolicyOutput) => void): Request<MediaStore.Types.DeleteMetricPolicyOutput, AWSError>; 58 /** 59 * Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch. 60 */ 61 deleteMetricPolicy(callback?: (err: AWSError, data: MediaStore.Types.DeleteMetricPolicyOutput) => void): Request<MediaStore.Types.DeleteMetricPolicyOutput, AWSError>; 62 /** 63 * Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers. 64 */ 65 describeContainer(params: MediaStore.Types.DescribeContainerInput, callback?: (err: AWSError, data: MediaStore.Types.DescribeContainerOutput) => void): Request<MediaStore.Types.DescribeContainerOutput, AWSError>; 66 /** 67 * Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers. 68 */ 69 describeContainer(callback?: (err: AWSError, data: MediaStore.Types.DescribeContainerOutput) => void): Request<MediaStore.Types.DescribeContainerOutput, AWSError>; 70 /** 71 * Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. 72 */ 73 getContainerPolicy(params: MediaStore.Types.GetContainerPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.GetContainerPolicyOutput) => void): Request<MediaStore.Types.GetContainerPolicyOutput, AWSError>; 74 /** 75 * Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. 76 */ 77 getContainerPolicy(callback?: (err: AWSError, data: MediaStore.Types.GetContainerPolicyOutput) => void): Request<MediaStore.Types.GetContainerPolicyOutput, AWSError>; 78 /** 79 * Returns the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others. 80 */ 81 getCorsPolicy(params: MediaStore.Types.GetCorsPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.GetCorsPolicyOutput) => void): Request<MediaStore.Types.GetCorsPolicyOutput, AWSError>; 82 /** 83 * Returns the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others. 84 */ 85 getCorsPolicy(callback?: (err: AWSError, data: MediaStore.Types.GetCorsPolicyOutput) => void): Request<MediaStore.Types.GetCorsPolicyOutput, AWSError>; 86 /** 87 * Retrieves the object lifecycle policy that is assigned to a container. 88 */ 89 getLifecyclePolicy(params: MediaStore.Types.GetLifecyclePolicyInput, callback?: (err: AWSError, data: MediaStore.Types.GetLifecyclePolicyOutput) => void): Request<MediaStore.Types.GetLifecyclePolicyOutput, AWSError>; 90 /** 91 * Retrieves the object lifecycle policy that is assigned to a container. 92 */ 93 getLifecyclePolicy(callback?: (err: AWSError, data: MediaStore.Types.GetLifecyclePolicyOutput) => void): Request<MediaStore.Types.GetLifecyclePolicyOutput, AWSError>; 94 /** 95 * Returns the metric policy for the specified container. 96 */ 97 getMetricPolicy(params: MediaStore.Types.GetMetricPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.GetMetricPolicyOutput) => void): Request<MediaStore.Types.GetMetricPolicyOutput, AWSError>; 98 /** 99 * Returns the metric policy for the specified container. 100 */ 101 getMetricPolicy(callback?: (err: AWSError, data: MediaStore.Types.GetMetricPolicyOutput) => void): Request<MediaStore.Types.GetMetricPolicyOutput, AWSError>; 102 /** 103 * Lists the properties of all containers in AWS Elemental MediaStore. You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive. See also DescribeContainer, which gets the properties of one container. 104 */ 105 listContainers(params: MediaStore.Types.ListContainersInput, callback?: (err: AWSError, data: MediaStore.Types.ListContainersOutput) => void): Request<MediaStore.Types.ListContainersOutput, AWSError>; 106 /** 107 * Lists the properties of all containers in AWS Elemental MediaStore. You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive. See also DescribeContainer, which gets the properties of one container. 108 */ 109 listContainers(callback?: (err: AWSError, data: MediaStore.Types.ListContainersOutput) => void): Request<MediaStore.Types.ListContainersOutput, AWSError>; 110 /** 111 * Returns a list of the tags assigned to the specified container. 112 */ 113 listTagsForResource(params: MediaStore.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: MediaStore.Types.ListTagsForResourceOutput) => void): Request<MediaStore.Types.ListTagsForResourceOutput, AWSError>; 114 /** 115 * Returns a list of the tags assigned to the specified container. 116 */ 117 listTagsForResource(callback?: (err: AWSError, data: MediaStore.Types.ListTagsForResourceOutput) => void): Request<MediaStore.Types.ListTagsForResourceOutput, AWSError>; 118 /** 119 * Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy. 120 */ 121 putContainerPolicy(params: MediaStore.Types.PutContainerPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.PutContainerPolicyOutput) => void): Request<MediaStore.Types.PutContainerPolicyOutput, AWSError>; 122 /** 123 * Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy. 124 */ 125 putContainerPolicy(callback?: (err: AWSError, data: MediaStore.Types.PutContainerPolicyOutput) => void): Request<MediaStore.Types.PutContainerPolicyOutput, AWSError>; 126 /** 127 * Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability. To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. 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. To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore. 128 */ 129 putCorsPolicy(params: MediaStore.Types.PutCorsPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.PutCorsPolicyOutput) => void): Request<MediaStore.Types.PutCorsPolicyOutput, AWSError>; 130 /** 131 * Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability. To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. 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. To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore. 132 */ 133 putCorsPolicy(callback?: (err: AWSError, data: MediaStore.Types.PutCorsPolicyOutput) => void): Request<MediaStore.Types.PutCorsPolicyOutput, AWSError>; 134 /** 135 * Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect. For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy. 136 */ 137 putLifecyclePolicy(params: MediaStore.Types.PutLifecyclePolicyInput, callback?: (err: AWSError, data: MediaStore.Types.PutLifecyclePolicyOutput) => void): Request<MediaStore.Types.PutLifecyclePolicyOutput, AWSError>; 138 /** 139 * Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect. For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy. 140 */ 141 putLifecyclePolicy(callback?: (err: AWSError, data: MediaStore.Types.PutLifecyclePolicyOutput) => void): Request<MediaStore.Types.PutLifecyclePolicyOutput, AWSError>; 142 /** 143 * 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. 144 */ 145 putMetricPolicy(params: MediaStore.Types.PutMetricPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.PutMetricPolicyOutput) => void): Request<MediaStore.Types.PutMetricPolicyOutput, AWSError>; 146 /** 147 * 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. 148 */ 149 putMetricPolicy(callback?: (err: AWSError, data: MediaStore.Types.PutMetricPolicyOutput) => void): Request<MediaStore.Types.PutMetricPolicyOutput, AWSError>; 150 /** 151 * Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs. 152 */ 153 startAccessLogging(params: MediaStore.Types.StartAccessLoggingInput, callback?: (err: AWSError, data: MediaStore.Types.StartAccessLoggingOutput) => void): Request<MediaStore.Types.StartAccessLoggingOutput, AWSError>; 154 /** 155 * Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs. 156 */ 157 startAccessLogging(callback?: (err: AWSError, data: MediaStore.Types.StartAccessLoggingOutput) => void): Request<MediaStore.Types.StartAccessLoggingOutput, AWSError>; 158 /** 159 * Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable. 160 */ 161 stopAccessLogging(params: MediaStore.Types.StopAccessLoggingInput, callback?: (err: AWSError, data: MediaStore.Types.StopAccessLoggingOutput) => void): Request<MediaStore.Types.StopAccessLoggingOutput, AWSError>; 162 /** 163 * Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable. 164 */ 165 stopAccessLogging(callback?: (err: AWSError, data: MediaStore.Types.StopAccessLoggingOutput) => void): Request<MediaStore.Types.StopAccessLoggingOutput, AWSError>; 166 /** 167 * Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. 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. 168 */ 169 tagResource(params: MediaStore.Types.TagResourceInput, callback?: (err: AWSError, data: MediaStore.Types.TagResourceOutput) => void): Request<MediaStore.Types.TagResourceOutput, AWSError>; 170 /** 171 * Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. 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. 172 */ 173 tagResource(callback?: (err: AWSError, data: MediaStore.Types.TagResourceOutput) => void): Request<MediaStore.Types.TagResourceOutput, AWSError>; 174 /** 175 * Removes tags from the specified container. You can specify one or more tags to remove. 176 */ 177 untagResource(params: MediaStore.Types.UntagResourceInput, callback?: (err: AWSError, data: MediaStore.Types.UntagResourceOutput) => void): Request<MediaStore.Types.UntagResourceOutput, AWSError>; 178 /** 179 * Removes tags from the specified container. You can specify one or more tags to remove. 180 */ 181 untagResource(callback?: (err: AWSError, data: MediaStore.Types.UntagResourceOutput) => void): Request<MediaStore.Types.UntagResourceOutput, AWSError>; 182 } 183 declare namespace MediaStore { 184 export type AllowedHeaders = Header[]; 185 export type AllowedMethods = MethodName[]; 186 export type AllowedOrigins = Origin[]; 187 export interface Container { 188 /** 189 * 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. 190 */ 191 Endpoint?: Endpoint; 192 /** 193 * Unix timestamp. 194 */ 195 CreationTime?: TimeStamp; 196 /** 197 * 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 198 */ 199 ARN?: ContainerARN; 200 /** 201 * The name of the container. 202 */ 203 Name?: ContainerName; 204 /** 205 * 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. 206 */ 207 Status?: ContainerStatus; 208 /** 209 * 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. 210 */ 211 AccessLoggingEnabled?: ContainerAccessLoggingEnabled; 212 } 213 export type ContainerARN = string; 214 export type ContainerAccessLoggingEnabled = boolean; 215 export type ContainerLevelMetrics = "ENABLED"|"DISABLED"|string; 216 export type ContainerList = Container[]; 217 export type ContainerListLimit = number; 218 export type ContainerName = string; 219 export type ContainerPolicy = string; 220 export type ContainerStatus = "ACTIVE"|"CREATING"|"DELETING"|string; 221 export type CorsPolicy = CorsRule[]; 222 export interface CorsRule { 223 /** 224 * 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. 225 */ 226 AllowedOrigins: AllowedOrigins; 227 /** 228 * 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. 229 */ 230 AllowedMethods?: AllowedMethods; 231 /** 232 * 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 (*). 233 */ 234 AllowedHeaders: AllowedHeaders; 235 /** 236 * The time in seconds that your browser caches the preflight response for the specified resource. A CORS rule can have only one MaxAgeSeconds element. 237 */ 238 MaxAgeSeconds?: MaxAgeSeconds; 239 /** 240 * 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. 241 */ 242 ExposeHeaders?: ExposeHeaders; 243 } 244 export interface CreateContainerInput { 245 /** 246 * 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. 247 */ 248 ContainerName: ContainerName; 249 /** 250 * 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. 251 */ 252 Tags?: TagList; 253 } 254 export interface CreateContainerOutput { 255 /** 256 * 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. 257 */ 258 Container: Container; 259 } 260 export interface DeleteContainerInput { 261 /** 262 * The name of the container to delete. 263 */ 264 ContainerName: ContainerName; 265 } 266 export interface DeleteContainerOutput { 267 } 268 export interface DeleteContainerPolicyInput { 269 /** 270 * The name of the container that holds the policy. 271 */ 272 ContainerName: ContainerName; 273 } 274 export interface DeleteContainerPolicyOutput { 275 } 276 export interface DeleteCorsPolicyInput { 277 /** 278 * The name of the container to remove the policy from. 279 */ 280 ContainerName: ContainerName; 281 } 282 export interface DeleteCorsPolicyOutput { 283 } 284 export interface DeleteLifecyclePolicyInput { 285 /** 286 * The name of the container that holds the object lifecycle policy. 287 */ 288 ContainerName: ContainerName; 289 } 290 export interface DeleteLifecyclePolicyOutput { 291 } 292 export interface DeleteMetricPolicyInput { 293 /** 294 * The name of the container that is associated with the metric policy that you want to delete. 295 */ 296 ContainerName: ContainerName; 297 } 298 export interface DeleteMetricPolicyOutput { 299 } 300 export interface DescribeContainerInput { 301 /** 302 * The name of the container to query. 303 */ 304 ContainerName?: ContainerName; 305 } 306 export interface DescribeContainerOutput { 307 /** 308 * The name of the queried container. 309 */ 310 Container?: Container; 311 } 312 export type Endpoint = string; 313 export type ExposeHeaders = Header[]; 314 export interface GetContainerPolicyInput { 315 /** 316 * The name of the container. 317 */ 318 ContainerName: ContainerName; 319 } 320 export interface GetContainerPolicyOutput { 321 /** 322 * The contents of the access policy. 323 */ 324 Policy: ContainerPolicy; 325 } 326 export interface GetCorsPolicyInput { 327 /** 328 * The name of the container that the policy is assigned to. 329 */ 330 ContainerName: ContainerName; 331 } 332 export interface GetCorsPolicyOutput { 333 /** 334 * The CORS policy assigned to the container. 335 */ 336 CorsPolicy: CorsPolicy; 337 } 338 export interface GetLifecyclePolicyInput { 339 /** 340 * The name of the container that the object lifecycle policy is assigned to. 341 */ 342 ContainerName: ContainerName; 343 } 344 export interface GetLifecyclePolicyOutput { 345 /** 346 * The object lifecycle policy that is assigned to the container. 347 */ 348 LifecyclePolicy: LifecyclePolicy; 349 } 350 export interface GetMetricPolicyInput { 351 /** 352 * The name of the container that is associated with the metric policy. 353 */ 354 ContainerName: ContainerName; 355 } 356 export interface GetMetricPolicyOutput { 357 /** 358 * The metric policy that is associated with the specific container. 359 */ 360 MetricPolicy: MetricPolicy; 361 } 362 export type Header = string; 363 export type LifecyclePolicy = string; 364 export interface ListContainersInput { 365 /** 366 * 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. 367 */ 368 NextToken?: PaginationToken; 369 /** 370 * Enter the maximum number of containers in the response. Use from 1 to 255 characters. 371 */ 372 MaxResults?: ContainerListLimit; 373 } 374 export interface ListContainersOutput { 375 /** 376 * The names of the containers. 377 */ 378 Containers: ContainerList; 379 /** 380 * 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. 381 */ 382 NextToken?: PaginationToken; 383 } 384 export interface ListTagsForResourceInput { 385 /** 386 * The Amazon Resource Name (ARN) for the container. 387 */ 388 Resource: ContainerARN; 389 } 390 export interface ListTagsForResourceOutput { 391 /** 392 * An array of key:value pairs that are assigned to the container. 393 */ 394 Tags?: TagList; 395 } 396 export type MaxAgeSeconds = number; 397 export type MethodName = "PUT"|"GET"|"DELETE"|"HEAD"|string; 398 export interface MetricPolicy { 399 /** 400 * A setting to enable or disable metrics at the container level. 401 */ 402 ContainerLevelMetrics: ContainerLevelMetrics; 403 /** 404 * 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. 405 */ 406 MetricPolicyRules?: MetricPolicyRules; 407 } 408 export interface MetricPolicyRule { 409 /** 410 * A path or file name that defines which objects to include in the group. Wildcards (*) are acceptable. 411 */ 412 ObjectGroup: ObjectGroup; 413 /** 414 * A name that allows you to refer to the object group. 415 */ 416 ObjectGroupName: ObjectGroupName; 417 } 418 export type MetricPolicyRules = MetricPolicyRule[]; 419 export type ObjectGroup = string; 420 export type ObjectGroupName = string; 421 export type Origin = string; 422 export type PaginationToken = string; 423 export interface PutContainerPolicyInput { 424 /** 425 * The name of the container. 426 */ 427 ContainerName: ContainerName; 428 /** 429 * The contents of the policy, which includes the following: One Version tag One Statement tag that contains the standard tags for the policy. 430 */ 431 Policy: ContainerPolicy; 432 } 433 export interface PutContainerPolicyOutput { 434 } 435 export interface PutCorsPolicyInput { 436 /** 437 * The name of the container that you want to assign the CORS policy to. 438 */ 439 ContainerName: ContainerName; 440 /** 441 * The CORS policy to apply to the container. 442 */ 443 CorsPolicy: CorsPolicy; 444 } 445 export interface PutCorsPolicyOutput { 446 } 447 export interface PutLifecyclePolicyInput { 448 /** 449 * The name of the container that you want to assign the object lifecycle policy to. 450 */ 451 ContainerName: ContainerName; 452 /** 453 * The object lifecycle policy to apply to the container. 454 */ 455 LifecyclePolicy: LifecyclePolicy; 456 } 457 export interface PutLifecyclePolicyOutput { 458 } 459 export interface PutMetricPolicyInput { 460 /** 461 * The name of the container that you want to add the metric policy to. 462 */ 463 ContainerName: ContainerName; 464 /** 465 * 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). 466 */ 467 MetricPolicy: MetricPolicy; 468 } 469 export interface PutMetricPolicyOutput { 470 } 471 export interface StartAccessLoggingInput { 472 /** 473 * The name of the container that you want to start access logging on. 474 */ 475 ContainerName: ContainerName; 476 } 477 export interface StartAccessLoggingOutput { 478 } 479 export interface StopAccessLoggingInput { 480 /** 481 * The name of the container that you want to stop access logging on. 482 */ 483 ContainerName: ContainerName; 484 } 485 export interface StopAccessLoggingOutput { 486 } 487 export interface Tag { 488 /** 489 * 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. 490 */ 491 Key: TagKey; 492 /** 493 * 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. 494 */ 495 Value?: TagValue; 496 } 497 export type TagKey = string; 498 export type TagKeyList = TagKey[]; 499 export type TagList = Tag[]; 500 export interface TagResourceInput { 501 /** 502 * The Amazon Resource Name (ARN) for the container. 503 */ 504 Resource: ContainerARN; 505 /** 506 * 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. 507 */ 508 Tags: TagList; 509 } 510 export interface TagResourceOutput { 511 } 512 export type TagValue = string; 513 export type TimeStamp = Date; 514 export interface UntagResourceInput { 515 /** 516 * The Amazon Resource Name (ARN) for the container. 517 */ 518 Resource: ContainerARN; 519 /** 520 * 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). 521 */ 522 TagKeys: TagKeyList; 523 } 524 export interface UntagResourceOutput { 525 } 526 /** 527 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 528 */ 529 export type apiVersion = "2017-09-01"|"latest"|string; 530 export interface ClientApiVersions { 531 /** 532 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 533 */ 534 apiVersion?: apiVersion; 535 } 536 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 537 /** 538 * Contains interfaces for use with the MediaStore client. 539 */ 540 export import Types = MediaStore; 541 } 542 export = MediaStore;