Class GetBucketCorsCommandProtected

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about CORS, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

• PutBucketCors

• DeleteBucketCors

Example

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

import { S3Client, GetBucketCorsCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketCorsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // GetBucketCorsRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketCorsCommand(input);
const response = await client.send(command);
// { // GetBucketCorsOutput
//   CORSRules: [ // CORSRules
//     { // CORSRule
//       ID: "STRING_VALUE",
//       AllowedHeaders: [ // AllowedHeaders
//         "STRING_VALUE",
//       ],
//       AllowedMethods: [ // AllowedMethods // required
//         "STRING_VALUE",
//       ],
//       AllowedOrigins: [ // AllowedOrigins // required
//         "STRING_VALUE",
//       ],
//       ExposeHeaders: [ // ExposeHeaders
//         "STRING_VALUE",
//       ],
//       MaxAgeSeconds: Number("int"),
//     },
//   ],
// };

Param

GetBucketCorsCommandInput

Returns

GetBucketCorsCommandOutput

See

• GetBucketCorsCommandInput for command's input shape.
• GetBucketCorsCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Example

To get cors configuration set on a bucket

// The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.
const input = {
  "Bucket": "examplebucket"
};
const command = new GetBucketCorsCommand(input);
const response = await client.send(command);
/* response ==
{
  "CORSRules": [
    {
      "AllowedHeaders": [
        "Authorization"
      ],
      "AllowedMethods": [
        "GET"
      ],
      "AllowedOrigins": [
        "*"
      ],
      "MaxAgeSeconds": 3000
    }
  ]
}
*/
// example id: to-get-cors-configuration-set-on-a-bucket-1481596855475