Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::get_bucket_policy::builders::GetBucketPolicyFluentBuilder
pub struct GetBucketPolicyFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetBucketPolicy
.
Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy
, PutBucketPolicy
, and DeleteBucketPolicy
API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
To use this API operation against 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 bucket policies, see Using Bucket Policies and User Policies.
The following action is related to GetBucketPolicy
:
Implementations§
§impl GetBucketPolicyFluentBuilder
impl GetBucketPolicyFluentBuilder
pub fn as_input(&self) -> &GetBucketPolicyInputBuilder
pub fn as_input(&self) -> &GetBucketPolicyInputBuilder
Access the GetBucketPolicy as a reference.
pub async fn send(
self
) -> impl Future<Output = Result<GetBucketPolicyOutput, SdkError<GetBucketPolicyError, Response<SdkBody>>>>
pub async fn send( self ) -> impl Future<Output = Result<GetBucketPolicyOutput, SdkError<GetBucketPolicyError, Response<SdkBody>>>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
pub async fn customize(
self
) -> impl Future<Output = Result<CustomizableOperation<GetBucketPolicyOutput, GetBucketPolicyError, GetBucketPolicyFluentBuilder>, SdkError<GetBucketPolicyError, Response>>>
pub async fn customize( self ) -> impl Future<Output = Result<CustomizableOperation<GetBucketPolicyOutput, GetBucketPolicyError, GetBucketPolicyFluentBuilder>, SdkError<GetBucketPolicyError, Response>>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn bucket(self, input: impl Into<String>) -> GetBucketPolicyFluentBuilder
pub fn bucket(self, input: impl Into<String>) -> GetBucketPolicyFluentBuilder
The bucket name for which to get the bucket policy.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
To use this API operation against 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.
pub fn set_bucket(self, input: Option<String>) -> GetBucketPolicyFluentBuilder
pub fn set_bucket(self, input: Option<String>) -> GetBucketPolicyFluentBuilder
The bucket name for which to get the bucket policy.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
To use this API operation against 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.
pub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The bucket name for which to get the bucket policy.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
To use this API operation against 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.
pub fn expected_bucket_owner(
self,
input: impl Into<String>
) -> GetBucketPolicyFluentBuilder
pub fn expected_bucket_owner( self, input: impl Into<String> ) -> GetBucketPolicyFluentBuilder
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn set_expected_bucket_owner(
self,
input: Option<String>
) -> GetBucketPolicyFluentBuilder
pub fn set_expected_bucket_owner( self, input: Option<String> ) -> GetBucketPolicyFluentBuilder
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<String>
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
Trait Implementations§
§impl Clone for GetBucketPolicyFluentBuilder
impl Clone for GetBucketPolicyFluentBuilder
§fn clone(&self) -> GetBucketPolicyFluentBuilder
fn clone(&self) -> GetBucketPolicyFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more