Struct aws_sdk_s3::operation::put_bucket_inventory_configuration::builders::PutBucketInventoryConfigurationFluentBuilder
source · pub struct PutBucketInventoryConfigurationFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to PutBucketInventoryConfiguration
.
This operation is not supported by directory buckets.
This implementation of the PUT
action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.
You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
- Permissions
-
To use this operation, you must have permission to perform the
s3:PutInventoryConfiguration
action. The bucket owner has this permission by default and can grant this permission to others.The
s3:PutInventoryConfiguration
permission allows a user to create an S3 Inventory report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report.To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.
PutBucketInventoryConfiguration
has the following special errors:
- HTTP 400 Bad Request Error
-
Code: InvalidArgument
Cause: Invalid Argument
- HTTP 400 Bad Request Error
-
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
- HTTP 403 Forbidden Error
-
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutInventoryConfiguration
bucket permission to set the configuration on the bucket.
The following operations are related to PutBucketInventoryConfiguration
:
Implementations§
source§impl PutBucketInventoryConfigurationFluentBuilder
impl PutBucketInventoryConfigurationFluentBuilder
sourcepub fn as_input(&self) -> &PutBucketInventoryConfigurationInputBuilder
pub fn as_input(&self) -> &PutBucketInventoryConfigurationInputBuilder
Access the PutBucketInventoryConfiguration as a reference.
sourcepub async fn send(
self,
) -> Result<PutBucketInventoryConfigurationOutput, SdkError<PutBucketInventoryConfigurationError, HttpResponse>>
pub async fn send( self, ) -> Result<PutBucketInventoryConfigurationOutput, SdkError<PutBucketInventoryConfigurationError, HttpResponse>>
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.
sourcepub fn customize(
self,
) -> CustomizableOperation<PutBucketInventoryConfigurationOutput, PutBucketInventoryConfigurationError, Self>
pub fn customize( self, ) -> CustomizableOperation<PutBucketInventoryConfigurationOutput, PutBucketInventoryConfigurationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
The name of the bucket where the inventory configuration will be stored.
sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
The name of the bucket where the inventory configuration will be stored.
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The name of the bucket where the inventory configuration will be stored.
sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The ID used to identify the inventory configuration.
sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
The ID used to identify the inventory configuration.
sourcepub fn inventory_configuration(self, input: InventoryConfiguration) -> Self
pub fn inventory_configuration(self, input: InventoryConfiguration) -> Self
Specifies the inventory configuration.
sourcepub fn set_inventory_configuration(
self,
input: Option<InventoryConfiguration>,
) -> Self
pub fn set_inventory_configuration( self, input: Option<InventoryConfiguration>, ) -> Self
Specifies the inventory configuration.
sourcepub fn get_inventory_configuration(&self) -> &Option<InventoryConfiguration>
pub fn get_inventory_configuration(&self) -> &Option<InventoryConfiguration>
Specifies the inventory configuration.
sourcepub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
Trait Implementations§
source§impl Clone for PutBucketInventoryConfigurationFluentBuilder
impl Clone for PutBucketInventoryConfigurationFluentBuilder
source§fn clone(&self) -> PutBucketInventoryConfigurationFluentBuilder
fn clone(&self) -> PutBucketInventoryConfigurationFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for PutBucketInventoryConfigurationFluentBuilder
impl !RefUnwindSafe for PutBucketInventoryConfigurationFluentBuilder
impl Send for PutBucketInventoryConfigurationFluentBuilder
impl Sync for PutBucketInventoryConfigurationFluentBuilder
impl Unpin for PutBucketInventoryConfigurationFluentBuilder
impl !UnwindSafe for PutBucketInventoryConfigurationFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)