IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Class 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:

    You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

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

    import { S3Client, GetBucketCorsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetBucketCorsCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
    // import type { S3ClientConfig } from "ibm-cos-sdk-v2";
    const config = {}; // type is S3ClientConfig
    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"),
    //     },
    //   ],
    // };

    GetBucketCorsCommandInput

    GetBucketCorsCommandOutput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    // 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 is
    {
      CORSRules: [
        {
          AllowedHeaders: [
            "Authorization"
          ],
          AllowedMethods: [
            "GET"
          ],
          AllowedOrigins: [
            "*"
          ],
          MaxAgeSeconds: 3000
        }
      ]
    }
    */

    Hierarchy

    Index

    Constructors

    constructor

    Constructors

    • Parameters

      Returns GetBucketCorsCommand

    • Parameters

      Returns GetBucketCorsCommand

    Settings

    Member Visibility

    On This Page

    Constructors