S3Vectors / Client / create_vector_bucket

create_vector_bucket

S3Vectors.Client.create_vector_bucket(**kwargs)

Creates a vector bucket in the Amazon Web Services Region that you want your bucket to be in.

Permissions

You must have the s3vectors:CreateVectorBucket permission to use this operation.

You must have the s3vectors:TagResource permission in addition to s3vectors:CreateVectorBucket permission to create a vector bucket with tags.

See also: AWS API Documentation

Request Syntax

response = client.create_vector_bucket(
    vectorBucketName='string',
    encryptionConfiguration={
        'sseType': 'AES256'|'aws:kms',
        'kmsKeyArn': 'string'
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • vectorBucketName (string) –

    [REQUIRED]

    The name of the vector bucket to create.

  • encryptionConfiguration (dict) –

    The encryption configuration for the vector bucket. By default, if you don’t specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.

    • sseType (string) –

      The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don’t specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.

    • kmsKeyArn (string) –

      Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms.

      To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).

      For example, specify Key ARN in the following format: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • tags (dict) –

    An array of user-defined tags that you would like to apply to the vector bucket that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

    Note

    You must have the s3vectors:TagResource permission in addition to s3vectors:CreateVectorBucket permission to create a vector bucket with tags.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'vectorBucketArn': 'string'
}

Response Structure

  • (dict) –

    • vectorBucketArn (string) –

      The Amazon Resource Name (ARN) of the newly created vector bucket.

Exceptions