S3Vectors / Client / get_vector_bucket_policy

get_vector_bucket_policy

S3Vectors.Client.get_vector_bucket_policy(**kwargs)

Note

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Gets details about a vector bucket policy. 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:GetVectorBucketPolicy permission to use this operation.

See also: AWS API Documentation

Request Syntax

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

  • vectorBucketName (string) – The name of the vector bucket.

  • vectorBucketArn (string) – The ARN of the vector bucket.

Return type:

dict

Returns:

Response Syntax

{
    'policy': 'string'
}

Response Structure

  • (dict) –

    • policy (string) –

      The JSON that defines the policy.

Exceptions