putCorsPolicy method

Future<void> putCorsPolicy({
  1. required String containerName,
  2. required List<CorsRule> corsPolicy,
})

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.

May throw ContainerNotFoundException. May throw ContainerInUseException. May throw InternalServerError.

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

Parameter corsPolicy : The CORS policy to apply to the container.

Implementation

Future<void> putCorsPolicy({
  required String containerName,
  required List<CorsRule> corsPolicy,
}) async {
  ArgumentError.checkNotNull(containerName, 'containerName');
  _s.validateStringLength(
    'containerName',
    containerName,
    1,
    255,
    isRequired: true,
  );
  ArgumentError.checkNotNull(corsPolicy, 'corsPolicy');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'MediaStore_20170901.PutCorsPolicy'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ContainerName': containerName,
      'CorsPolicy': corsPolicy,
    },
  );
}