GetBucketCorsCommand

This operation is not supported for directory buckets.

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.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with 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:

Example Syntax

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"),
//     },
//   ],
// };

Example Usage

 Loading code editor

GetBucketCorsCommand Input

See GetBucketCorsCommandInput for more details

Parameter
Type
Description
Bucket
Required
string | undefined

The bucket name for which to get the cors configuration.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with 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 .

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

ExpectedBucketOwner
string | undefined

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

GetBucketCorsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CORSRules
CORSRule[] | undefined

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

Throws

Name
Fault
Details
S3ServiceException
Base exception class for all service exceptions from S3 service.