Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class PutCorsPolicyCommandProtected

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.

Example

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

import { MediaStoreClient, PutCorsPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import
// const { MediaStoreClient, PutCorsPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import
const client = new MediaStoreClient(config);
const input = { // PutCorsPolicyInput
ContainerName: "STRING_VALUE", // required
CorsPolicy: [ // CorsPolicy // required
{ // CorsRule
AllowedOrigins: [ // AllowedOrigins // required
"STRING_VALUE",
],
AllowedMethods: [ // AllowedMethods
"PUT" || "GET" || "DELETE" || "HEAD",
],
AllowedHeaders: [ // AllowedHeaders // required
"STRING_VALUE",
],
MaxAgeSeconds: Number("int"),
ExposeHeaders: [ // ExposeHeaders
"STRING_VALUE",
],
},
],
};
const command = new PutCorsPolicyCommand(input);
const response = await client.send(command);
// {};

Param

PutCorsPolicyCommandInput

Returns

PutCorsPolicyCommandOutput

See

Throws

ContainerInUseException (client fault)

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

Throws

ContainerNotFoundException (client fault)

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

Throws

InternalServerError (server fault)

The service is temporarily unavailable.

Throws

MediaStoreServiceException

Base exception class for all service exceptions from MediaStore service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods