S3Vectors / Client / get_vector_bucket

get_vector_bucket

S3Vectors.Client.get_vector_bucket(**kwargs)

Returns vector bucket attributes. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN).

Permissions

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

See also: AWS API Documentation

Request Syntax

response = client.get_vector_bucket(
    vectorBucketName='string',
    vectorBucketArn='string'
)
Parameters:

  • vectorBucketName (string) – The name of the vector bucket to retrieve information about.

  • vectorBucketArn (string) – The ARN of the vector bucket to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'vectorBucket': {
        'vectorBucketName': 'string',
        'vectorBucketArn': 'string',
        'creationTime': datetime(2015, 1, 1),
        'encryptionConfiguration': {
            'sseType': 'AES256'|'aws:kms',
            'kmsKeyArn': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • vectorBucket (dict) –

      The attributes of the vector bucket.

      • vectorBucketName (string) –

        The name of the vector bucket.

      • vectorBucketArn (string) –

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

      • creationTime (datetime) –

        Date and time when the vector bucket was created.

      • encryptionConfiguration (dict) –

        The encryption configuration for the vector bucket.

        • 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

Exceptions