Get Bucket Cors

s3_get_bucket_cors

R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by 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 get_bucket_cors:

• put_bucket_cors

• delete_bucket_cors

Usage

s3_get_bucket_cors(Bucket, ExpectedBucketOwner)

Arguments

Bucket

[required] 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.

ExpectedBucketOwner

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).

Value

A list with the following syntax:

list(
  CORSRules = list(
    list(
      ID = "string",
      AllowedHeaders = list(
        "string"
      ),
      AllowedMethods = list(
        "string"
      ),
      AllowedOrigins = list(
        "string"
      ),
      ExposeHeaders = list(
        "string"
      ),
      MaxAgeSeconds = 123
    )
  )
)

Request syntax

svc$get_bucket_cors(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)

Examples

## Not run: 
# The following example returns cross-origin resource sharing (CORS)
# configuration set on a bucket.
svc$get_bucket_cors(
  Bucket = "examplebucket"
)

## End(Not run)