S3Control / Client / create_bucket

create_bucket#

S3Control.Client.create_bucket(**kwargs)#

Note

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

S3 on Outposts buckets support:

  • Tags

  • LifecycleConfigurations for deleting expired objects

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section.

The following actions are related to CreateBucket for Amazon S3 on Outposts:

See also: AWS API Documentation

Request Syntax

response = client.create_bucket(
    ACL='private'|'public-read'|'public-read-write'|'authenticated-read',
    Bucket='string',
    CreateBucketConfiguration={
        'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1'|'eu-central-1'
    },
    GrantFullControl='string',
    GrantRead='string',
    GrantReadACP='string',
    GrantWrite='string',
    GrantWriteACP='string',
    ObjectLockEnabledForBucket=True|False,
    OutpostId='string'
)
Parameters:

  • ACL (string) –

    The canned ACL to apply to the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • Bucket (string) –

    [REQUIRED]

    The name of the bucket.

  • CreateBucketConfiguration (dict) –

    The configuration information for the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

    • LocationConstraint (string) –

      Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.

      Note

      This is not supported by Amazon S3 on Outposts buckets.

  • GrantFullControl (string) –

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • GrantRead (string) –

    Allows grantee to list the objects in the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • GrantReadACP (string) –

    Allows grantee to read the bucket ACL.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • GrantWrite (string) –

    Allows grantee to create, overwrite, and delete any object in the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • GrantWriteACP (string) –

    Allows grantee to write the ACL for the applicable bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • ObjectLockEnabledForBucket (boolean) –

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • OutpostId (string) –

    The ID of the Outposts where the bucket is being created.

    Note

    This ID is required by Amazon S3 on Outposts buckets.

Return type:

dict

Returns:

Response Syntax

{
    'Location': 'string',
    'BucketArn': 'string'
}

Response Structure

  • (dict) –

    • Location (string) –

      The location of the bucket.

    • BucketArn (string) –

      The Amazon Resource Name (ARN) of the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Exceptions