Struct Client

pub struct Client { /* private fields */ }

Client for AWS S3 Control

Client for invoking operations on AWS S3 Control. Each operation on AWS S3 Control is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_s3control::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_s3control::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateAccessGrantsIdentityCenter operation has a Client::associate_access_grants_identity_center, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_access_grants_identity_center()
    .account_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_access_grants_identity_center( &self, ) -> AssociateAccessGrantsIdentityCenterFluentBuilder

Constructs a fluent builder for the AssociateAccessGrantsIdentityCenter operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • identity_center_arn(impl Into<String>) / set_identity_center_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

    
    
• On success, responds with AssociateAccessGrantsIdentityCenterOutput
• On failure, responds with SdkError<AssociateAccessGrantsIdentityCenterError>

impl Client

pub fn create_access_grant(&self) -> CreateAccessGrantFluentBuilder

Constructs a fluent builder for the CreateAccessGrant operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • access_grants_location_id(impl Into<String>) / set_access_grants_location_id(Option<String>):
    required: true
    

    The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

    If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.

    
    
  • access_grants_location_configuration(AccessGrantsLocationConfiguration) / set_access_grants_location_configuration(Option<AccessGrantsLocationConfiguration>):
    required: false
    

    The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

    
    
  • grantee(Grantee) / set_grantee(Option<Grantee>):
    required: true
    

    The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

    
    
  • permission(Permission) / set_permission(Option<Permission>):
    required: true
    

    The type of access that you are granting to your S3 data, which can be set to one of the following values:

    • READ – Grant read-only access to the S3 data.

    • WRITE – Grant write-only access to the S3 data.

    • READWRITE – Grant both read and write access to the S3 data.

    
    
  • application_arn(impl Into<String>) / set_application_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.

    
    
  • s3_prefix_type(S3PrefixType) / set_s3_prefix_type(Option<S3PrefixType>):
    required: false
    

    The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

    
    
• On success, responds with CreateAccessGrantOutput with field(s):
  • created_at(Option<DateTime>):

    The date and time when you created the access grant.

  • access_grant_id(Option<String>):

    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

  • access_grant_arn(Option<String>):

    The Amazon Resource Name (ARN) of the access grant.

  • grantee(Option<Grantee>):

    The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

  • access_grants_location_id(Option<String>):

    The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

  • access_grants_location_configuration(Option<AccessGrantsLocationConfiguration>):

    The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

  • permission(Option<Permission>):

    The type of access that you are granting to your S3 data, which can be set to one of the following values:

    • READ – Grant read-only access to the S3 data.

    • WRITE – Grant write-only access to the S3 data.

    • READWRITE – Grant both read and write access to the S3 data.

  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

  • grant_scope(Option<String>):

    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

• On failure, responds with SdkError<CreateAccessGrantError>

impl Client

pub fn create_access_grants_instance( &self, ) -> CreateAccessGrantsInstanceFluentBuilder

Constructs a fluent builder for the CreateAccessGrantsInstance operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • identity_center_arn(impl Into<String>) / set_identity_center_arn(Option<String>):
    required: false
    

    If you would like to associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The Amazon Web Services resource tags that you are adding to the S3 Access Grants instance. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

    
    
• On success, responds with CreateAccessGrantsInstanceOutput with field(s):
  • created_at(Option<DateTime>):

    The date and time when you created the S3 Access Grants instance.

  • access_grants_instance_id(Option<String>):

    The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.

  • access_grants_instance_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

  • identity_center_arn(Option<String>):

    If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

  • identity_center_instance_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

  • identity_center_application_arn(Option<String>):

    If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

• On failure, responds with SdkError<CreateAccessGrantsInstanceError>

impl Client

pub fn create_access_grants_location( &self, ) -> CreateAccessGrantsLocationFluentBuilder

Constructs a fluent builder for the CreateAccessGrantsLocation operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • location_scope(impl Into<String>) / set_location_scope(Option<String>):
    required: true
    

    The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3:// / . A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

    
    
  • iam_role_arn(impl Into<String>) / set_iam_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

    
    
• On success, responds with CreateAccessGrantsLocationOutput with field(s):
  • created_at(Option<DateTime>):

    The date and time when you registered the location.

  • access_grants_location_id(Option<String>):

    The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

  • access_grants_location_arn(Option<String>):

    The Amazon Resource Name (ARN) of the location you are registering.

  • location_scope(Option<String>):

    The S3 URI path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

  • iam_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

• On failure, responds with SdkError<CreateAccessGrantsLocationError>

impl Client

pub fn create_access_point(&self) -> CreateAccessPointFluentBuilder

Constructs a fluent builder for the CreateAccessPoint operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the account that owns the specified access point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name you want to assign to this access point.

    For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by –xa-s3. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    The name of the bucket that you want to associate this access point with.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
  • vpc_configuration(VpcConfiguration) / set_vpc_configuration(Option<VpcConfiguration>):
    required: false
    

    If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

    This is required for creating an access point for Amazon S3 on Outposts buckets.

    
    
  • public_access_block_configuration(PublicAccessBlockConfiguration) / set_public_access_block_configuration(Option<PublicAccessBlockConfiguration>):
    required: false
    

    The PublicAccessBlock configuration that you want to apply to the access point.

    
    
  • bucket_account_id(impl Into<String>) / set_bucket_account_id(Option<String>):
    required: false
    

    The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

    For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.

    
    
  • scope(Scope) / set_scope(Option<Scope>):
    required: false
    

    For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

    Scope is not supported for access points for general purpose buckets.

    
    
• On success, responds with CreateAccessPointOutput with field(s):
  • access_point_arn(Option<String>):

    The ARN of the access point.

    This is only supported by Amazon S3 on Outposts.

  • alias(Option<String>):

    The name or alias of the access point.

• On failure, responds with SdkError<CreateAccessPointError>

impl Client

pub fn create_access_point_for_object_lambda( &self, ) -> CreateAccessPointForObjectLambdaFluentBuilder

Constructs a fluent builder for the CreateAccessPointForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for owner of the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name you want to assign to this Object Lambda Access Point.

    
    
  • configuration(ObjectLambdaConfiguration) / set_configuration(Option<ObjectLambdaConfiguration>):
    required: true
    

    Object Lambda Access Point configuration as a JSON document.

    
    
• On success, responds with CreateAccessPointForObjectLambdaOutput with field(s):
  • object_lambda_access_point_arn(Option<String>):

    Specifies the ARN for the Object Lambda Access Point.

  • alias(Option<ObjectLambdaAccessPointAlias>):

    The alias of the Object Lambda Access Point.

• On failure, responds with SdkError<CreateAccessPointForObjectLambdaError>

impl Client

pub fn create_bucket(&self) -> CreateBucketFluentBuilder

Constructs a fluent builder for the CreateBucket operation.

• The fluent builder is configurable:
  • acl(BucketCannedAcl) / set_acl(Option<BucketCannedAcl>):
    required: false
    

    The canned ACL to apply to the bucket.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    The name of the bucket.

    
    
  • create_bucket_configuration(CreateBucketConfiguration) / set_create_bucket_configuration(Option<CreateBucketConfiguration>):
    required: false
    

    The configuration information for the bucket.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • grant_full_control(impl Into<String>) / set_grant_full_control(Option<String>):
    required: false
    

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • grant_read(impl Into<String>) / set_grant_read(Option<String>):
    required: false
    

    Allows grantee to list the objects in the bucket.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • grant_read_acp(impl Into<String>) / set_grant_read_acp(Option<String>):
    required: false
    

    Allows grantee to read the bucket ACL.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • grant_write(impl Into<String>) / set_grant_write(Option<String>):
    required: false
    

    Allows grantee to create, overwrite, and delete any object in the bucket.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • grant_write_acp(impl Into<String>) / set_grant_write_acp(Option<String>):
    required: false
    

    Allows grantee to write the ACL for the applicable bucket.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • object_lock_enabled_for_bucket(bool) / set_object_lock_enabled_for_bucket(Option<bool>):
    required: false
    

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • outpost_id(impl Into<String>) / set_outpost_id(Option<String>):
    required: false
    

    The ID of the Outposts where the bucket is being created.

    This ID is required by Amazon S3 on Outposts buckets.

    
    
• On success, responds with CreateBucketOutput with field(s):
  • location(Option<String>):

    The location of the bucket.

  • bucket_arn(Option<String>):

    The Amazon Resource Name (ARN) of the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

• On failure, responds with SdkError<CreateBucketError>

impl Client

pub fn create_job(&self) -> CreateJobFluentBuilder

Constructs a fluent builder for the CreateJob operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that creates the job.

    
    
  • confirmation_required(bool) / set_confirmation_required(Option<bool>):
    required: false
    

    Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

    
    
  • operation(JobOperation) / set_operation(Option<JobOperation>):
    required: true
    

    The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

    
    
  • report(JobReport) / set_report(Option<JobReport>):
    required: true
    

    Configuration parameters for the optional job-completion report.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    An idempotency token to ensure that you don’t accidentally submit the same request twice. You can use any string up to the maximum length.

    
    
  • manifest(JobManifest) / set_manifest(Option<JobManifest>):
    required: false
    

    Configuration parameters for the manifest.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for this job. You can use any string within the permitted length. Descriptions don’t need to be unique and can be used for multiple jobs.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: true
    

    The numerical priority for this job. Higher numbers indicate higher priority.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job’s action on every object in the manifest.

    
    
  • tags(S3Tag) / set_tags(Option<Vec::<S3Tag>>):
    required: false
    

    A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

    
    
  • manifest_generator(JobManifestGenerator) / set_manifest_generator(Option<JobManifestGenerator>):
    required: false
    

    The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

    
    
• On success, responds with CreateJobOutput with field(s):
  • job_id(Option<String>):

    The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.

• On failure, responds with SdkError<CreateJobError>

impl Client

pub fn create_multi_region_access_point( &self, ) -> CreateMultiRegionAccessPointFluentBuilder

Constructs a fluent builder for the CreateMultiRegionAccessPoint operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point. The owner of the Multi-Region Access Point also must own the underlying buckets.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    An idempotency token used to identify the request and guarantee that requests are unique.

    
    
  • details(CreateMultiRegionAccessPointInput) / set_details(Option<CreateMultiRegionAccessPointInput>):
    required: true
    

    A container element containing details about the Multi-Region Access Point.

    
    
• On success, responds with CreateMultiRegionAccessPointOutput with field(s):
  • request_token_arn(Option<String>):

    The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.

• On failure, responds with SdkError<CreateMultiRegionAccessPointError>

impl Client

pub fn create_storage_lens_group(&self) -> CreateStorageLensGroupFluentBuilder

Constructs a fluent builder for the CreateStorageLensGroup operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that the Storage Lens group is created from and associated with.

    
    
  • storage_lens_group(StorageLensGroup) / set_storage_lens_group(Option<StorageLensGroup>):
    required: true
    

    The Storage Lens group configuration.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The Amazon Web Services resource tags that you’re adding to your Storage Lens group. This parameter is optional.

    
    
• On success, responds with CreateStorageLensGroupOutput
• On failure, responds with SdkError<CreateStorageLensGroupError>

impl Client

pub fn delete_access_grant(&self) -> DeleteAccessGrantFluentBuilder

Constructs a fluent builder for the DeleteAccessGrant operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • access_grant_id(impl Into<String>) / set_access_grant_id(Option<String>):
    required: true
    

    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

    
    
• On success, responds with DeleteAccessGrantOutput
• On failure, responds with SdkError<DeleteAccessGrantError>

impl Client

pub fn delete_access_grants_instance( &self, ) -> DeleteAccessGrantsInstanceFluentBuilder

Constructs a fluent builder for the DeleteAccessGrantsInstance operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
• On success, responds with DeleteAccessGrantsInstanceOutput
• On failure, responds with SdkError<DeleteAccessGrantsInstanceError>

impl Client

pub fn delete_access_grants_instance_resource_policy( &self, ) -> DeleteAccessGrantsInstanceResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteAccessGrantsInstanceResourcePolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
• On success, responds with DeleteAccessGrantsInstanceResourcePolicyOutput
• On failure, responds with SdkError<DeleteAccessGrantsInstanceResourcePolicyError>

impl Client

pub fn delete_access_grants_location( &self, ) -> DeleteAccessGrantsLocationFluentBuilder

Constructs a fluent builder for the DeleteAccessGrantsLocation operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • access_grants_location_id(impl Into<String>) / set_access_grants_location_id(Option<String>):
    required: true
    

    The ID of the registered location that you are deregistering from your S3 Access Grants instance. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

    
    
• On success, responds with DeleteAccessGrantsLocationOutput
• On failure, responds with SdkError<DeleteAccessGrantsLocationError>

impl Client

pub fn delete_access_point(&self) -> DeleteAccessPointFluentBuilder

Constructs a fluent builder for the DeleteAccessPoint operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the account that owns the specified access point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point you want to delete.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts: : :outpost/ /accesspoint/ . For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    
    
• On success, responds with DeleteAccessPointOutput
• On failure, responds with SdkError<DeleteAccessPointError>

impl Client

pub fn delete_access_point_for_object_lambda( &self, ) -> DeleteAccessPointForObjectLambdaFluentBuilder

Constructs a fluent builder for the DeleteAccessPointForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point you want to delete.

    
    
• On success, responds with DeleteAccessPointForObjectLambdaOutput
• On failure, responds with SdkError<DeleteAccessPointForObjectLambdaError>

impl Client

pub fn delete_access_point_policy(&self) -> DeleteAccessPointPolicyFluentBuilder

Constructs a fluent builder for the DeleteAccessPointPolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified access point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point whose policy you want to delete.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts: : :outpost/ /accesspoint/ . For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    
    
• On success, responds with DeleteAccessPointPolicyOutput
• On failure, responds with SdkError<DeleteAccessPointPolicyError>

impl Client

pub fn delete_access_point_policy_for_object_lambda( &self, ) -> DeleteAccessPointPolicyForObjectLambdaFluentBuilder

Constructs a fluent builder for the DeleteAccessPointPolicyForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Object Lambda Access Point you want to delete the policy for.

    
    
• On success, responds with DeleteAccessPointPolicyForObjectLambdaOutput
• On failure, responds with SdkError<DeleteAccessPointPolicyForObjectLambdaError>

impl Client

pub fn delete_access_point_scope(&self) -> DeleteAccessPointScopeFluentBuilder

Constructs a fluent builder for the DeleteAccessPointScope operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the access point with the scope that you want to delete.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point with the scope that you want to delete.

    
    
• On success, responds with DeleteAccessPointScopeOutput
• On failure, responds with SdkError<DeleteAccessPointScopeError>

impl Client

pub fn delete_bucket(&self) -> DeleteBucketFluentBuilder

Constructs a fluent builder for the DeleteBucket operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID that owns the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the bucket being deleted.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with DeleteBucketOutput
• On failure, responds with SdkError<DeleteBucketError>

impl Client

pub fn delete_bucket_lifecycle_configuration( &self, ) -> DeleteBucketLifecycleConfigurationFluentBuilder

Constructs a fluent builder for the DeleteBucketLifecycleConfiguration operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the lifecycle configuration to delete.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with DeleteBucketLifecycleConfigurationOutput
• On failure, responds with SdkError<DeleteBucketLifecycleConfigurationError>

impl Client

pub fn delete_bucket_policy(&self) -> DeleteBucketPolicyFluentBuilder

Constructs a fluent builder for the DeleteBucketPolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with DeleteBucketPolicyOutput
• On failure, responds with SdkError<DeleteBucketPolicyError>

impl Client

pub fn delete_bucket_replication(&self) -> DeleteBucketReplicationFluentBuilder

Constructs a fluent builder for the DeleteBucketReplication operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket to delete the replication configuration for.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the S3 on Outposts bucket to delete the replication configuration for.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with DeleteBucketReplicationOutput
• On failure, responds with SdkError<DeleteBucketReplicationError>

impl Client

pub fn delete_bucket_tagging(&self) -> DeleteBucketTaggingFluentBuilder

Constructs a fluent builder for the DeleteBucketTagging operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket tag set to be removed.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    The bucket ARN that has the tag set to be removed.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with DeleteBucketTaggingOutput
• On failure, responds with SdkError<DeleteBucketTaggingError>

impl Client

pub fn delete_job_tagging(&self) -> DeleteJobTaggingFluentBuilder

Constructs a fluent builder for the DeleteJobTagging operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID for the S3 Batch Operations job whose tags you want to delete.

    
    
• On success, responds with DeleteJobTaggingOutput
• On failure, responds with SdkError<DeleteJobTaggingError>

impl Client

pub fn delete_multi_region_access_point( &self, ) -> DeleteMultiRegionAccessPointFluentBuilder

Constructs a fluent builder for the DeleteMultiRegionAccessPoint operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    An idempotency token used to identify the request and guarantee that requests are unique.

    
    
  • details(DeleteMultiRegionAccessPointInput) / set_details(Option<DeleteMultiRegionAccessPointInput>):
    required: true
    

    A container element containing details about the Multi-Region Access Point.

    
    
• On success, responds with DeleteMultiRegionAccessPointOutput with field(s):
  • request_token_arn(Option<String>):

    The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.

• On failure, responds with SdkError<DeleteMultiRegionAccessPointError>

impl Client

pub fn delete_public_access_block(&self) -> DeletePublicAccessBlockFluentBuilder

Constructs a fluent builder for the DeletePublicAccessBlock operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to remove.

    
    
• On success, responds with DeletePublicAccessBlockOutput
• On failure, responds with SdkError<DeletePublicAccessBlockError>

impl Client

pub fn delete_storage_lens_configuration( &self, ) -> DeleteStorageLensConfigurationFluentBuilder

Constructs a fluent builder for the DeleteStorageLensConfiguration operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    The ID of the S3 Storage Lens configuration.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the requester.

    
    
• On success, responds with DeleteStorageLensConfigurationOutput
• On failure, responds with SdkError<DeleteStorageLensConfigurationError>

impl Client

pub fn delete_storage_lens_configuration_tagging( &self, ) -> DeleteStorageLensConfigurationTaggingFluentBuilder

Constructs a fluent builder for the DeleteStorageLensConfigurationTagging operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    The ID of the S3 Storage Lens configuration.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the requester.

    
    
• On success, responds with DeleteStorageLensConfigurationTaggingOutput
• On failure, responds with SdkError<DeleteStorageLensConfigurationTaggingError>

impl Client

pub fn delete_storage_lens_group(&self) -> DeleteStorageLensGroupFluentBuilder

Constructs a fluent builder for the DeleteStorageLensGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Storage Lens group that you’re trying to delete.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID used to create the Storage Lens group that you’re trying to delete.

    
    
• On success, responds with DeleteStorageLensGroupOutput
• On failure, responds with SdkError<DeleteStorageLensGroupError>

impl Client

pub fn describe_job(&self) -> DescribeJobFluentBuilder

Constructs a fluent builder for the DescribeJob operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID for the job whose information you want to retrieve.

    
    
• On success, responds with DescribeJobOutput with field(s):
  • job(Option<JobDescriptor>):

    Contains the configuration parameters and status for the job specified in the Describe Job request.

• On failure, responds with SdkError<DescribeJobError>

impl Client

pub fn describe_multi_region_access_point_operation( &self, ) -> DescribeMultiRegionAccessPointOperationFluentBuilder

Constructs a fluent builder for the DescribeMultiRegionAccessPointOperation operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • request_token_arn(impl Into<String>) / set_request_token_arn(Option<String>):
    required: true
    

    The request token associated with the request you want to know about. This request token is returned as part of the response when you make an asynchronous request. You provide this token to query about the status of the asynchronous action.

    
    
• On success, responds with DescribeMultiRegionAccessPointOperationOutput with field(s):
  • async_operation(Option<AsyncOperation>):

    A container element containing the details of the asynchronous operation.

• On failure, responds with SdkError<DescribeMultiRegionAccessPointOperationError>

impl Client

pub fn dissociate_access_grants_identity_center( &self, ) -> DissociateAccessGrantsIdentityCenterFluentBuilder

Constructs a fluent builder for the DissociateAccessGrantsIdentityCenter operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
• On success, responds with DissociateAccessGrantsIdentityCenterOutput
• On failure, responds with SdkError<DissociateAccessGrantsIdentityCenterError>

impl Client

pub fn get_access_grant(&self) -> GetAccessGrantFluentBuilder

Constructs a fluent builder for the GetAccessGrant operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • access_grant_id(impl Into<String>) / set_access_grant_id(Option<String>):
    required: true
    

    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

    
    
• On success, responds with GetAccessGrantOutput with field(s):
  • created_at(Option<DateTime>):

    The date and time when you created the access grant.

  • access_grant_id(Option<String>):

    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

  • access_grant_arn(Option<String>):

    The Amazon Resource Name (ARN) of the access grant.

  • grantee(Option<Grantee>):

    The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added a corporate directory to Amazon Web Services IAM Identity Center and associated this Identity Center instance with the S3 Access Grants instance, the grantee can also be a corporate directory user or group.

  • permission(Option<Permission>):

    The type of permission that was granted in the access grant. Can be one of the following values:

    • READ – Grant read-only access to the S3 data.

    • WRITE – Grant write-only access to the S3 data.

    • READWRITE – Grant both read and write access to the S3 data.

  • access_grants_location_id(Option<String>):

    The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

  • access_grants_location_configuration(Option<AccessGrantsLocationConfiguration>):

    The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

  • grant_scope(Option<String>):

    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

• On failure, responds with SdkError<GetAccessGrantError>

impl Client

pub fn get_access_grants_instance(&self) -> GetAccessGrantsInstanceFluentBuilder

Constructs a fluent builder for the GetAccessGrantsInstance operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
• On success, responds with GetAccessGrantsInstanceOutput with field(s):
  • access_grants_instance_arn(Option<String>):

    The Amazon Resource Name (ARN) of the S3 Access Grants instance.

  • access_grants_instance_id(Option<String>):

    The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.

  • identity_center_arn(Option<String>):

    If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

  • identity_center_instance_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

  • identity_center_application_arn(Option<String>):

    If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

  • created_at(Option<DateTime>):

    The date and time when you created the S3 Access Grants instance.

• On failure, responds with SdkError<GetAccessGrantsInstanceError>

impl Client

pub fn get_access_grants_instance_for_prefix( &self, ) -> GetAccessGrantsInstanceForPrefixFluentBuilder

Constructs a fluent builder for the GetAccessGrantsInstanceForPrefix operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that is making this request.

    
    
  • s3_prefix(impl Into<String>) / set_s3_prefix(Option<String>):
    required: true
    

    The S3 prefix of the access grants that you would like to retrieve.

    
    
• On success, responds with GetAccessGrantsInstanceForPrefixOutput with field(s):
  • access_grants_instance_arn(Option<String>):

    The Amazon Resource Name (ARN) of the S3 Access Grants instance.

  • access_grants_instance_id(Option<String>):

    The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.

• On failure, responds with SdkError<GetAccessGrantsInstanceForPrefixError>

impl Client

pub fn get_access_grants_instance_resource_policy( &self, ) -> GetAccessGrantsInstanceResourcePolicyFluentBuilder

Constructs a fluent builder for the GetAccessGrantsInstanceResourcePolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
• On success, responds with GetAccessGrantsInstanceResourcePolicyOutput with field(s):
  • policy(Option<String>):

    The resource policy of the S3 Access Grants instance.

  • organization(Option<String>):

    The Organization of the resource policy of the S3 Access Grants instance.

  • created_at(Option<DateTime>):

    The date and time when you created the S3 Access Grants instance resource policy.

• On failure, responds with SdkError<GetAccessGrantsInstanceResourcePolicyError>

impl Client

pub fn get_access_grants_location(&self) -> GetAccessGrantsLocationFluentBuilder

Constructs a fluent builder for the GetAccessGrantsLocation operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • access_grants_location_id(impl Into<String>) / set_access_grants_location_id(Option<String>):
    required: true
    

    The ID of the registered location that you are retrieving. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

    
    
• On success, responds with GetAccessGrantsLocationOutput with field(s):
  • created_at(Option<DateTime>):

    The date and time when you registered the location.

  • access_grants_location_id(Option<String>):

    The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

  • access_grants_location_arn(Option<String>):

    The Amazon Resource Name (ARN) of the registered location.

  • location_scope(Option<String>):

    The S3 URI path to the registered location. The location scope can be the default S3 location s3://, the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

  • iam_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

• On failure, responds with SdkError<GetAccessGrantsLocationError>

impl Client

pub fn get_access_point(&self) -> GetAccessPointFluentBuilder

Constructs a fluent builder for the GetAccessPoint operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the account that owns the specified access point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point whose configuration information you want to retrieve.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts: : :outpost/ /accesspoint/ . For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    
    
• On success, responds with GetAccessPointOutput with field(s):
  • name(Option<String>):

    The name of the specified access point.

  • bucket(Option<String>):

    The name of the bucket associated with the specified access point.

  • network_origin(Option<NetworkOrigin>):

    Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn’t allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

    This will always be true for an Amazon S3 on Outposts access point

  • vpc_configuration(Option<VpcConfiguration>):

    Contains the virtual private cloud (VPC) configuration for the specified access point.

    This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services services.

  • public_access_block_configuration(Option<PublicAccessBlockConfiguration>):

    The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of “Public” in the Amazon S3 User Guide.

    This data type is not supported for Amazon S3 on Outposts.

  • creation_date(Option<DateTime>):

    The date and time when the specified access point was created.

  • alias(Option<String>):

    The name or alias of the access point.

  • access_point_arn(Option<String>):

    The ARN of the access point.

  • endpoints(Option<HashMap::<String, String>>):

    The VPC endpoint for the access point.

  • bucket_account_id(Option<String>):

    The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

• On failure, responds with SdkError<GetAccessPointError>

impl Client

pub fn get_access_point_configuration_for_object_lambda( &self, ) -> GetAccessPointConfigurationForObjectLambdaFluentBuilder

Constructs a fluent builder for the GetAccessPointConfigurationForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Object Lambda Access Point you want to return the configuration for.

    
    
• On success, responds with GetAccessPointConfigurationForObjectLambdaOutput with field(s):
  • configuration(Option<ObjectLambdaConfiguration>):

    Object Lambda Access Point configuration document.

• On failure, responds with SdkError<GetAccessPointConfigurationForObjectLambdaError>

impl Client

pub fn get_access_point_for_object_lambda( &self, ) -> GetAccessPointForObjectLambdaFluentBuilder

Constructs a fluent builder for the GetAccessPointForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Object Lambda Access Point.

    
    
• On success, responds with GetAccessPointForObjectLambdaOutput with field(s):
  • name(Option<String>):

    The name of the Object Lambda Access Point.

  • public_access_block_configuration(Option<PublicAccessBlockConfiguration>):

    Configuration to block all public access. This setting is turned on and can not be edited.

  • creation_date(Option<DateTime>):

    The date and time when the specified Object Lambda Access Point was created.

  • alias(Option<ObjectLambdaAccessPointAlias>):

    The alias of the Object Lambda Access Point.

• On failure, responds with SdkError<GetAccessPointForObjectLambdaError>

impl Client

pub fn get_access_point_policy(&self) -> GetAccessPointPolicyFluentBuilder

Constructs a fluent builder for the GetAccessPointPolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified access point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point whose policy you want to retrieve.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts: : :outpost/ /accesspoint/ . For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    
    
• On success, responds with GetAccessPointPolicyOutput with field(s):
  • policy(Option<String>):

    The access point policy associated with the specified access point.

• On failure, responds with SdkError<GetAccessPointPolicyError>

impl Client

pub fn get_access_point_policy_for_object_lambda( &self, ) -> GetAccessPointPolicyForObjectLambdaFluentBuilder

Constructs a fluent builder for the GetAccessPointPolicyForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Object Lambda Access Point.

    
    
• On success, responds with GetAccessPointPolicyForObjectLambdaOutput with field(s):
  • policy(Option<String>):

    Object Lambda Access Point resource policy document.

• On failure, responds with SdkError<GetAccessPointPolicyForObjectLambdaError>

impl Client

pub fn get_access_point_policy_status( &self, ) -> GetAccessPointPolicyStatusFluentBuilder

Constructs a fluent builder for the GetAccessPointPolicyStatus operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified access point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point whose policy status you want to retrieve.

    
    
• On success, responds with GetAccessPointPolicyStatusOutput with field(s):
  • policy_status(Option<PolicyStatus>):

    Indicates the current policy status of the specified access point.

• On failure, responds with SdkError<GetAccessPointPolicyStatusError>

impl Client

pub fn get_access_point_policy_status_for_object_lambda( &self, ) -> GetAccessPointPolicyStatusForObjectLambdaFluentBuilder

Constructs a fluent builder for the GetAccessPointPolicyStatusForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Object Lambda Access Point.

    
    
• On success, responds with GetAccessPointPolicyStatusForObjectLambdaOutput with field(s):
  • policy_status(Option<PolicyStatus>):

    Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of “Public” in the Amazon S3 User Guide.

• On failure, responds with SdkError<GetAccessPointPolicyStatusForObjectLambdaError>

impl Client

pub fn get_access_point_scope(&self) -> GetAccessPointScopeFluentBuilder

Constructs a fluent builder for the GetAccessPointScope operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the access point with the scope that you want to retrieve.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point with the scope you want to retrieve.

    
    
• On success, responds with GetAccessPointScopeOutput with field(s):
  • scope(Option<Scope>):

    The contents of the access point scope.

• On failure, responds with SdkError<GetAccessPointScopeError>

impl Client

pub fn get_bucket(&self) -> GetBucketFluentBuilder

Constructs a fluent builder for the GetBucket operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with GetBucketOutput with field(s):
  • bucket(Option<String>):

    The Outposts bucket requested.

  • public_access_block_enabled(bool):

  • creation_date(Option<DateTime>):

    The creation date of the Outposts bucket.

• On failure, responds with SdkError<GetBucketError>

impl Client

pub fn get_bucket_lifecycle_configuration( &self, ) -> GetBucketLifecycleConfigurationFluentBuilder

Constructs a fluent builder for the GetBucketLifecycleConfiguration operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with GetBucketLifecycleConfigurationOutput with field(s):
  • rules(Option<Vec::<LifecycleRule>>):

    Container for the lifecycle rule of the Outposts bucket.

• On failure, responds with SdkError<GetBucketLifecycleConfigurationError>

impl Client

pub fn get_bucket_policy(&self) -> GetBucketPolicyFluentBuilder

Constructs a fluent builder for the GetBucketPolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with GetBucketPolicyOutput with field(s):
  • policy(Option<String>):

    The policy of the Outposts bucket.

• On failure, responds with SdkError<GetBucketPolicyError>

impl Client

pub fn get_bucket_replication(&self) -> GetBucketReplicationFluentBuilder

Constructs a fluent builder for the GetBucketReplication operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the bucket to get the replication information for.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with GetBucketReplicationOutput with field(s):
  • replication_configuration(Option<ReplicationConfiguration>):

    A container for one or more replication rules. A replication configuration must have at least one rule and you can add up to 100 rules. The maximum size of a replication configuration is 128 KB.

• On failure, responds with SdkError<GetBucketReplicationError>

impl Client

pub fn get_bucket_tagging(&self) -> GetBucketTaggingFluentBuilder

Constructs a fluent builder for the GetBucketTagging operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
• On success, responds with GetBucketTaggingOutput with field(s):
  • tag_set(Vec::<S3Tag>):

    The tags set of the Outposts bucket.

• On failure, responds with SdkError<GetBucketTaggingError>

impl Client

pub fn get_bucket_versioning(&self) -> GetBucketVersioningFluentBuilder

Constructs a fluent builder for the GetBucketVersioning operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 on Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    The S3 on Outposts bucket to return the versioning state for.

    
    
• On success, responds with GetBucketVersioningOutput with field(s):
  • status(Option<BucketVersioningStatus>):

    The versioning state of the S3 on Outposts bucket.

  • mfa_delete(Option<MfaDeleteStatus>):

    Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is returned only if the bucket has been configured with MFA delete. If MFA delete has never been configured for the bucket, this element is not returned.

• On failure, responds with SdkError<GetBucketVersioningError>

impl Client

pub fn get_data_access(&self) -> GetDataAccessFluentBuilder

Constructs a fluent builder for the GetDataAccess operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • target(impl Into<String>) / set_target(Option<String>):
    required: true
    

    The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.

    
    
  • permission(Permission) / set_permission(Option<Permission>):
    required: true
    

    The type of permission granted to your S3 data, which can be set to one of the following values:

    • READ – Grant read-only access to the S3 data.

    • WRITE – Grant write-only access to the S3 data.

    • READWRITE – Grant both read and write access to the S3 data.

    
    
  • duration_seconds(i32) / set_duration_seconds(Option<i32>):
    required: false
    

    The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.

    
    
  • privilege(Privilege) / set_privilege(Option<Privilege>):
    required: false
    

    The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.

    • Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.

    • Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.

    
    
  • target_type(S3PrefixType) / set_target_type(Option<S3PrefixType>):
    required: false
    

    The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.

    
    
• On success, responds with GetDataAccessOutput with field(s):
  • credentials(Option<Credentials>):

    The temporary credential token that S3 Access Grants vends.

  • matched_grant_target(Option<String>):

    The S3 URI path of the data to which you are being granted temporary access credentials.

  • grantee(Option<Grantee>):

    The user, group, or role that was granted access to the S3 location scope. For directory identities, this API also returns the grants of the IAM role used for the identity-aware request. For more information on identity-aware sessions, see Granting permissions to use identity-aware console sessions.

• On failure, responds with SdkError<GetDataAccessError>

impl Client

pub fn get_job_tagging(&self) -> GetJobTaggingFluentBuilder

Constructs a fluent builder for the GetJobTagging operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID for the S3 Batch Operations job whose tags you want to retrieve.

    
    
• On success, responds with GetJobTaggingOutput with field(s):
  • tags(Option<Vec::<S3Tag>>):

    The set of tags associated with the S3 Batch Operations job.

• On failure, responds with SdkError<GetJobTaggingError>

impl Client

pub fn get_multi_region_access_point( &self, ) -> GetMultiRegionAccessPointFluentBuilder

Constructs a fluent builder for the GetMultiRegionAccessPoint operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Multi-Region Access Point whose configuration information you want to receive. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the Amazon S3 User Guide.

    
    
• On success, responds with GetMultiRegionAccessPointOutput with field(s):
  • access_point(Option<MultiRegionAccessPointReport>):

    A container element containing the details of the requested Multi-Region Access Point.

• On failure, responds with SdkError<GetMultiRegionAccessPointError>

impl Client

pub fn get_multi_region_access_point_policy( &self, ) -> GetMultiRegionAccessPointPolicyFluentBuilder

Constructs a fluent builder for the GetMultiRegionAccessPointPolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the Amazon S3 User Guide.

    
    
• On success, responds with GetMultiRegionAccessPointPolicyOutput with field(s):
  • policy(Option<MultiRegionAccessPointPolicyDocument>):

    The policy associated with the specified Multi-Region Access Point.

• On failure, responds with SdkError<GetMultiRegionAccessPointPolicyError>

impl Client

pub fn get_multi_region_access_point_policy_status( &self, ) -> GetMultiRegionAccessPointPolicyStatusFluentBuilder

Constructs a fluent builder for the GetMultiRegionAccessPointPolicyStatus operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the Amazon S3 User Guide.

    
    
• On success, responds with GetMultiRegionAccessPointPolicyStatusOutput with field(s):
  • established(Option<PolicyStatus>):

    Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of “Public” in the Amazon S3 User Guide.

• On failure, responds with SdkError<GetMultiRegionAccessPointPolicyStatusError>

impl Client

pub fn get_multi_region_access_point_routes( &self, ) -> GetMultiRegionAccessPointRoutesFluentBuilder

Constructs a fluent builder for the GetMultiRegionAccessPointRoutes operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • mrap(impl Into<String>) / set_mrap(Option<String>):
    required: true
    

    The Multi-Region Access Point ARN.

    
    
• On success, responds with GetMultiRegionAccessPointRoutesOutput with field(s):
  • mrap(Option<String>):

    The Multi-Region Access Point ARN.

  • routes(Option<Vec::<MultiRegionAccessPointRoute>>):

    The different routes that make up the route configuration. Active routes return a value of 100, and passive routes return a value of 0.

• On failure, responds with SdkError<GetMultiRegionAccessPointRoutesError>

impl Client

pub fn get_public_access_block(&self) -> GetPublicAccessBlockFluentBuilder

Constructs a fluent builder for the GetPublicAccessBlock operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to retrieve.

    
    
• On success, responds with GetPublicAccessBlockOutput with field(s):
  • public_access_block_configuration(Option<PublicAccessBlockConfiguration>):

    The PublicAccessBlock configuration currently in effect for this Amazon Web Services account.

• On failure, responds with SdkError<GetPublicAccessBlockError>

impl Client

pub fn get_storage_lens_configuration( &self, ) -> GetStorageLensConfigurationFluentBuilder

Constructs a fluent builder for the GetStorageLensConfiguration operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    The ID of the Amazon S3 Storage Lens configuration.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the requester.

    
    
• On success, responds with GetStorageLensConfigurationOutput with field(s):
  • storage_lens_configuration(Option<StorageLensConfiguration>):

    The S3 Storage Lens configuration requested.

• On failure, responds with SdkError<GetStorageLensConfigurationError>

impl Client

pub fn get_storage_lens_configuration_tagging( &self, ) -> GetStorageLensConfigurationTaggingFluentBuilder

Constructs a fluent builder for the GetStorageLensConfigurationTagging operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    The ID of the Amazon S3 Storage Lens configuration.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the requester.

    
    
• On success, responds with GetStorageLensConfigurationTaggingOutput with field(s):
  • tags(Option<Vec::<StorageLensTag>>):

    The tags of S3 Storage Lens configuration requested.

• On failure, responds with SdkError<GetStorageLensConfigurationTaggingError>

impl Client

pub fn get_storage_lens_group(&self) -> GetStorageLensGroupFluentBuilder

Constructs a fluent builder for the GetStorageLensGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Storage Lens group that you’re trying to retrieve the configuration details for.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with the Storage Lens group that you’re trying to retrieve the details for.

    
    
• On success, responds with GetStorageLensGroupOutput with field(s):
  • storage_lens_group(Option<StorageLensGroup>):

    The name of the Storage Lens group that you’re trying to retrieve the configuration details for.

• On failure, responds with SdkError<GetStorageLensGroupError>

impl Client

pub fn list_access_grants(&self) -> ListAccessGrantsFluentBuilder

Constructs a fluent builder for the ListAccessGrants operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

    
    
  • grantee_type(GranteeType) / set_grantee_type(Option<GranteeType>):
    required: false
    

    The type of the grantee to which access has been granted. It can be one of the following values:

    • IAM - An IAM user or role.

    • DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

    • DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

    
    
  • grantee_identifier(impl Into<String>) / set_grantee_identifier(Option<String>):
    required: false
    

    The unique identifer of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.

    
    
  • permission(Permission) / set_permission(Option<Permission>):
    required: false
    

    The type of permission granted to your S3 data, which can be set to one of the following values:

    • READ – Grant read-only access to the S3 data.

    • WRITE – Grant write-only access to the S3 data.

    • READWRITE – Grant both read and write access to the S3 data.

    
    
  • grant_scope(impl Into<String>) / set_grant_scope(Option<String>):
    required: false
    

    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

    
    
  • application_arn(impl Into<String>) / set_application_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

    
    
• On success, responds with ListAccessGrantsOutput with field(s):
  • next_token(Option<String>):

    A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.

  • access_grants_list(Option<Vec::<ListAccessGrantEntry>>):

    A container for a list of grants in an S3 Access Grants instance.

• On failure, responds with SdkError<ListAccessGrantsError>

impl Client

pub fn list_access_grants_instances( &self, ) -> ListAccessGrantsInstancesFluentBuilder

Constructs a fluent builder for the ListAccessGrantsInstances operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Instances request in order to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

    
    
• On success, responds with ListAccessGrantsInstancesOutput with field(s):
  • next_token(Option<String>):

    A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Instances request in order to retrieve the next page of results.

  • access_grants_instances_list(Option<Vec::<ListAccessGrantsInstanceEntry>>):

    A container for a list of S3 Access Grants instances.

• On failure, responds with SdkError<ListAccessGrantsInstancesError>

impl Client

pub fn list_access_grants_locations( &self, ) -> ListAccessGrantsLocationsFluentBuilder

Constructs a fluent builder for the ListAccessGrantsLocations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

    
    
  • location_scope(impl Into<String>) / set_location_scope(Option<String>):
    required: false
    

    The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3:// / . A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

    
    
• On success, responds with ListAccessGrantsLocationsOutput with field(s):
  • next_token(Option<String>):

    A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

  • access_grants_locations_list(Option<Vec::<ListAccessGrantsLocationsEntry>>):

    A container for a list of registered locations in an S3 Access Grants instance.

• On failure, responds with SdkError<ListAccessGrantsLocationsError>

impl Client

pub fn list_access_points(&self) -> ListAccessPointsFluentBuilder

Constructs a fluent builder for the ListAccessPoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the account that owns the specified access points.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: false
    

    The name of the bucket whose associated access points you want to list.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

    
    
• On success, responds with ListAccessPointsOutput with field(s):
  • access_point_list(Option<Vec::<AccessPoint>>):

    Contains identification and configuration information for one or more access points associated with the specified bucket.

  • next_token(Option<String>):

    If the specified bucket has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

• On failure, responds with SdkError<ListAccessPointsError>

impl Client

pub fn list_access_points_for_directory_buckets( &self, ) -> ListAccessPointsForDirectoryBucketsFluentBuilder

Constructs a fluent builder for the ListAccessPointsForDirectoryBuckets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the access points.

    
    
  • directory_bucket(impl Into<String>) / set_directory_bucket(Option<String>):
    required: false
    

    The name of the directory bucket associated with the access points you want to list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of access points that you would like returned in the ListAccessPointsForDirectoryBuckets response. If the directory bucket is associated with more than this number of access points, the results include the pagination token NextToken. Make another call using the NextToken to retrieve more results.

    
    
• On success, responds with ListAccessPointsForDirectoryBucketsOutput with field(s):
  • access_point_list(Option<Vec::<AccessPoint>>):

    Contains identification and configuration information for one or more access points associated with the directory bucket.

  • next_token(Option<String>):

    If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

• On failure, responds with SdkError<ListAccessPointsForDirectoryBucketsError>

impl Client

pub fn list_access_points_for_object_lambda( &self, ) -> ListAccessPointsForObjectLambdaFluentBuilder

Constructs a fluent builder for the ListAccessPointsForObjectLambda operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of access points that you want to include in the list. The response may contain fewer access points but will never contain more. If there are more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

    
    
• On success, responds with ListAccessPointsForObjectLambdaOutput with field(s):
  • object_lambda_access_point_list(Option<Vec::<ObjectLambdaAccessPoint>>):

    Returns list of Object Lambda Access Points.

  • next_token(Option<String>):

    If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

• On failure, responds with SdkError<ListAccessPointsForObjectLambdaError>

impl Client

pub fn list_caller_access_grants(&self) -> ListCallerAccessGrantsFluentBuilder

Constructs a fluent builder for the ListCallerAccessGrants operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • grant_scope(impl Into<String>) / set_grant_scope(Option<String>):
    required: false
    

    The S3 path of the data that you would like to access. Must start with s3://. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token to request the next page of results. Pass this value into a subsequent List Caller Access Grants request in order to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of access grants that you would like returned in the List Caller Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

    
    
  • allowed_by_application(bool) / set_allowed_by_application(Option<bool>):
    required: false
    

    If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller’s Identity Center application or for any other applications (ALL).

    
    
• On success, responds with ListCallerAccessGrantsOutput with field(s):
  • next_token(Option<String>):

    A pagination token that you can use to request the next page of results. Pass this value into a subsequent List Caller Access Grants request in order to retrieve the next page of results.

  • caller_access_grants_list(Option<Vec::<ListCallerAccessGrantsEntry>>):

    A list of the caller’s access grants that were created using S3 Access Grants and that grant the caller access to the S3 data of the Amazon Web Services account ID that was specified in the request.

• On failure, responds with SdkError<ListCallerAccessGrantsError>

impl Client

pub fn list_jobs(&self) -> ListJobsFluentBuilder

Constructs a fluent builder for the ListJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

    
    
  • job_statuses(JobStatus) / set_job_statuses(Option<Vec::<JobStatus>>):
    required: false
    

    The List Jobs request returns jobs that match the statuses listed in this element.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

    
    
• On success, responds with ListJobsOutput with field(s):
  • next_token(Option<String>):

    If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.

  • jobs(Option<Vec::<JobListDescriptor>>):

    The list of current jobs and jobs that have ended within the last 30 days.

• On failure, responds with SdkError<ListJobsError>

impl Client

pub fn list_multi_region_access_points( &self, ) -> ListMultiRegionAccessPointsFluentBuilder

Constructs a fluent builder for the ListMultiRegionAccessPoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Not currently used. Do not use this parameter.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Not currently used. Do not use this parameter.

    
    
• On success, responds with ListMultiRegionAccessPointsOutput with field(s):
  • access_points(Option<Vec::<MultiRegionAccessPointReport>>):

    The list of Multi-Region Access Points associated with the user.

  • next_token(Option<String>):

    If the specified bucket has more Multi-Region Access Points than can be returned in one call to this action, this field contains a continuation token. You can use this token tin subsequent calls to this action to retrieve additional Multi-Region Access Points.

• On failure, responds with SdkError<ListMultiRegionAccessPointsError>

impl Client

pub fn list_regional_buckets(&self) -> ListRegionalBucketsFluentBuilder

Constructs a fluent builder for the ListRegionalBuckets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    
    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    
    
    
  • outpost_id(impl Into<String>) / set_outpost_id(Option<String>):
    required: false
    

    The ID of the Outposts resource.

    This ID is required by Amazon S3 on Outposts buckets.

    
    
• On success, responds with ListRegionalBucketsOutput with field(s):
  • regional_bucket_list(Option<Vec::<RegionalBucket>>):

  • next_token(Option<String>):

    NextToken is sent when isTruncated is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this NextToken. NextToken is obfuscated and is not a real key.

• On failure, responds with SdkError<ListRegionalBucketsError>

impl Client

pub fn list_storage_lens_configurations( &self, ) -> ListStorageLensConfigurationsFluentBuilder

Constructs a fluent builder for the ListStorageLensConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the requester.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token to request the next page of results.

    
    
• On success, responds with ListStorageLensConfigurationsOutput with field(s):
  • next_token(Option<String>):

    If the request produced more than the maximum number of S3 Storage Lens configuration results, you can pass this value into a subsequent request to retrieve the next page of results.

  • storage_lens_configuration_list(Option<Vec::<ListStorageLensConfigurationEntry>>):

    A list of S3 Storage Lens configurations.

• On failure, responds with SdkError<ListStorageLensConfigurationsError>

impl Client

pub fn list_storage_lens_groups(&self) -> ListStorageLensGroupsFluentBuilder

Constructs a fluent builder for the ListStorageLensGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the Storage Lens groups.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null if there are no more results.

    
    
• On success, responds with ListStorageLensGroupsOutput with field(s):
  • next_token(Option<String>):

    If NextToken is returned, there are more Storage Lens groups results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

  • storage_lens_group_list(Option<Vec::<ListStorageLensGroupEntry>>):

    The list of Storage Lens groups that exist in the specified home Region.

• On failure, responds with SdkError<ListStorageLensGroupsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the resource owner.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the S3 resource that you want to list the tags for. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The Amazon Web Services resource tags that are associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_access_grants_instance_resource_policy( &self, ) -> PutAccessGrantsInstanceResourcePolicyFluentBuilder

Constructs a fluent builder for the PutAccessGrantsInstanceResourcePolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The resource policy of the S3 Access Grants instance that you are updating.

    
    
  • organization(impl Into<String>) / set_organization(Option<String>):
    required: false
    

    The Organization of the resource policy of the S3 Access Grants instance.

    
    
• On success, responds with PutAccessGrantsInstanceResourcePolicyOutput with field(s):
  • policy(Option<String>):

    The updated resource policy of the S3 Access Grants instance.

  • organization(Option<String>):

    The Organization of the resource policy of the S3 Access Grants instance.

  • created_at(Option<DateTime>):

    The date and time when you created the S3 Access Grants instance resource policy.

• On failure, responds with SdkError<PutAccessGrantsInstanceResourcePolicyError>

impl Client

pub fn put_access_point_configuration_for_object_lambda( &self, ) -> PutAccessPointConfigurationForObjectLambdaFluentBuilder

Constructs a fluent builder for the PutAccessPointConfigurationForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Object Lambda Access Point.

    
    
  • configuration(ObjectLambdaConfiguration) / set_configuration(Option<ObjectLambdaConfiguration>):
    required: true
    

    Object Lambda Access Point configuration document.

    
    
• On success, responds with PutAccessPointConfigurationForObjectLambdaOutput
• On failure, responds with SdkError<PutAccessPointConfigurationForObjectLambdaError>

impl Client

pub fn put_access_point_policy(&self) -> PutAccessPointPolicyFluentBuilder

Constructs a fluent builder for the PutAccessPointPolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for owner of the bucket associated with the specified access point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point that you want to associate with the specified policy.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts: : :outpost/ /accesspoint/ . For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The policy that you want to apply to the specified access point. For more information about access point policies, see Managing access to shared datasets in general purpose buckets with access points or Managing access to shared datasets in directory bucekts with access points in the Amazon S3 User Guide.

    
    
• On success, responds with PutAccessPointPolicyOutput
• On failure, responds with SdkError<PutAccessPointPolicyError>

impl Client

pub fn put_access_point_policy_for_object_lambda( &self, ) -> PutAccessPointPolicyForObjectLambdaFluentBuilder

Constructs a fluent builder for the PutAccessPointPolicyForObjectLambda operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the account that owns the specified Object Lambda Access Point.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Object Lambda Access Point.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    Object Lambda Access Point resource policy document.

    
    
• On success, responds with PutAccessPointPolicyForObjectLambdaOutput
• On failure, responds with SdkError<PutAccessPointPolicyForObjectLambdaError>

impl Client

pub fn put_access_point_scope(&self) -> PutAccessPointScopeFluentBuilder

Constructs a fluent builder for the PutAccessPointScope operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the access point with scope that you want to create or replace.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access point with the scope that you want to create or replace.

    
    
  • scope(Scope) / set_scope(Option<Scope>):
    required: true
    

    Object prefixes, API operations, or a combination of both.

    
    
• On success, responds with PutAccessPointScopeOutput
• On failure, responds with SdkError<PutAccessPointScopeError>

impl Client

pub fn put_bucket_lifecycle_configuration( &self, ) -> PutBucketLifecycleConfigurationFluentBuilder

Constructs a fluent builder for the PutBucketLifecycleConfiguration operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    The name of the bucket for which to set the configuration.

    
    
  • lifecycle_configuration(LifecycleConfiguration) / set_lifecycle_configuration(Option<LifecycleConfiguration>):
    required: false
    

    Container for lifecycle rules. You can add as many as 1,000 rules.

    
    
• On success, responds with PutBucketLifecycleConfigurationOutput
• On failure, responds with SdkError<PutBucketLifecycleConfigurationError>

impl Client

pub fn put_bucket_policy(&self) -> PutBucketPolicyFluentBuilder

Constructs a fluent builder for the PutBucketPolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
  • confirm_remove_self_bucket_access(bool) / set_confirm_remove_self_bucket_access(Option<bool>):
    required: false
    

    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

    This is not supported by Amazon S3 on Outposts buckets.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The bucket policy as a JSON document.

    
    
• On success, responds with PutBucketPolicyOutput
• On failure, responds with SdkError<PutBucketPolicyError>

impl Client

pub fn put_bucket_replication(&self) -> PutBucketReplicationFluentBuilder

Constructs a fluent builder for the PutBucketReplication operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    Specifies the S3 on Outposts bucket to set the configuration for.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
  • replication_configuration(ReplicationConfiguration) / set_replication_configuration(Option<ReplicationConfiguration>):
    required: true
    
    
    
• On success, responds with PutBucketReplicationOutput
• On failure, responds with SdkError<PutBucketReplicationError>

impl Client

pub fn put_bucket_tagging(&self) -> PutBucketTaggingFluentBuilder

Constructs a fluent builder for the PutBucketTagging operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts: : :outpost/ /bucket/ . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    
    
  • tagging(Tagging) / set_tagging(Option<Tagging>):
    required: true
    
    
    
• On success, responds with PutBucketTaggingOutput
• On failure, responds with SdkError<PutBucketTaggingError>

impl Client

pub fn put_bucket_versioning(&self) -> PutBucketVersioningFluentBuilder

Constructs a fluent builder for the PutBucketVersioning operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 on Outposts bucket.

    
    
  • bucket(impl Into<String>) / set_bucket(Option<String>):
    required: true
    

    The S3 on Outposts bucket to set the versioning state for.

    
    
  • mfa(impl Into<String>) / set_mfa(Option<String>):
    required: false
    

    The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device.

    
    
  • versioning_configuration(VersioningConfiguration) / set_versioning_configuration(Option<VersioningConfiguration>):
    required: true
    

    The root-level tag for the VersioningConfiguration parameters.

    
    
• On success, responds with PutBucketVersioningOutput
• On failure, responds with SdkError<PutBucketVersioningError>

impl Client

pub fn put_job_tagging(&self) -> PutJobTaggingFluentBuilder

Constructs a fluent builder for the PutJobTagging operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID for the S3 Batch Operations job whose tags you want to replace.

    
    
  • tags(S3Tag) / set_tags(Option<Vec::<S3Tag>>):
    required: true
    

    The set of tags to associate with the S3 Batch Operations job.

    
    
• On success, responds with PutJobTaggingOutput
• On failure, responds with SdkError<PutJobTaggingError>

impl Client

pub fn put_multi_region_access_point_policy( &self, ) -> PutMultiRegionAccessPointPolicyFluentBuilder

Constructs a fluent builder for the PutMultiRegionAccessPointPolicy operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    An idempotency token used to identify the request and guarantee that requests are unique.

    
    
  • details(PutMultiRegionAccessPointPolicyInput) / set_details(Option<PutMultiRegionAccessPointPolicyInput>):
    required: true
    

    A container element containing the details of the policy for the Multi-Region Access Point.

    
    
• On success, responds with PutMultiRegionAccessPointPolicyOutput with field(s):
  • request_token_arn(Option<String>):

    The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.

• On failure, responds with SdkError<PutMultiRegionAccessPointPolicyError>

impl Client

pub fn put_public_access_block(&self) -> PutPublicAccessBlockFluentBuilder

Constructs a fluent builder for the PutPublicAccessBlock operation.

• The fluent builder is configurable:
  • public_access_block_configuration(PublicAccessBlockConfiguration) / set_public_access_block_configuration(Option<PublicAccessBlockConfiguration>):
    required: true
    

    The PublicAccessBlock configuration that you want to apply to the specified Amazon Web Services account.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to set.

    
    
• On success, responds with PutPublicAccessBlockOutput
• On failure, responds with SdkError<PutPublicAccessBlockError>

impl Client

pub fn put_storage_lens_configuration( &self, ) -> PutStorageLensConfigurationFluentBuilder

Constructs a fluent builder for the PutStorageLensConfiguration operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    The ID of the S3 Storage Lens configuration.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the requester.

    
    
  • storage_lens_configuration(StorageLensConfiguration) / set_storage_lens_configuration(Option<StorageLensConfiguration>):
    required: true
    

    The S3 Storage Lens configuration.

    
    
  • tags(StorageLensTag) / set_tags(Option<Vec::<StorageLensTag>>):
    required: false
    

    The tag set of the S3 Storage Lens configuration.

    You can set up to a maximum of 50 tags.

    
    
• On success, responds with PutStorageLensConfigurationOutput
• On failure, responds with SdkError<PutStorageLensConfigurationError>

impl Client

pub fn put_storage_lens_configuration_tagging( &self, ) -> PutStorageLensConfigurationTaggingFluentBuilder

Constructs a fluent builder for the PutStorageLensConfigurationTagging operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    The ID of the S3 Storage Lens configuration.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID of the requester.

    
    
  • tags(StorageLensTag) / set_tags(Option<Vec::<StorageLensTag>>):
    required: true
    

    The tag set of the S3 Storage Lens configuration.

    You can set up to a maximum of 50 tags.

    
    
• On success, responds with PutStorageLensConfigurationTaggingOutput
• On failure, responds with SdkError<PutStorageLensConfigurationTaggingError>

impl Client

pub fn submit_multi_region_access_point_routes( &self, ) -> SubmitMultiRegionAccessPointRoutesFluentBuilder

Constructs a fluent builder for the SubmitMultiRegionAccessPointRoutes operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

    
    
  • mrap(impl Into<String>) / set_mrap(Option<String>):
    required: true
    

    The Multi-Region Access Point ARN.

    
    
  • route_updates(MultiRegionAccessPointRoute) / set_route_updates(Option<Vec::<MultiRegionAccessPointRoute>>):
    required: true
    

    The different routes that make up the new route configuration. Active routes return a value of 100, and passive routes return a value of 0.

    
    
• On success, responds with SubmitMultiRegionAccessPointRoutesOutput
• On failure, responds with SdkError<SubmitMultiRegionAccessPointRoutesError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that created the S3 resource that you’re trying to add tags to or the requester’s account ID.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the S3 resource that you’re trying to add tags to. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The Amazon Web Services resource tags that you want to add to the specified S3 resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the resource that you’re trying to remove the tags from.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the S3 resource that you’re trying to remove the tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The array of tag key-value pairs that you’re trying to remove from of the S3 resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_access_grants_location( &self, ) -> UpdateAccessGrantsLocationFluentBuilder

Constructs a fluent builder for the UpdateAccessGrantsLocation operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the S3 Access Grants instance.

    
    
  • access_grants_location_id(impl Into<String>) / set_access_grants_location_id(Option<String>):
    required: true
    

    The ID of the registered location that you are updating. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

    The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

    If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.

    
    
  • iam_role_arn(impl Into<String>) / set_iam_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

    
    
• On success, responds with UpdateAccessGrantsLocationOutput with field(s):
  • created_at(Option<DateTime>):

    The date and time when you registered the location.

  • access_grants_location_id(Option<String>):

    The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

  • access_grants_location_arn(Option<String>):

    The Amazon Resource Name (ARN) of the registered location that you are updating.

  • location_scope(Option<String>):

    The S3 URI path of the location that you are updating. You cannot update the scope of the registered location. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3:// / .

  • iam_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role of the registered location. S3 Access Grants assumes this role to manage access to the registered location.

• On failure, responds with SdkError<UpdateAccessGrantsLocationError>

impl Client

pub fn update_job_priority(&self) -> UpdateJobPriorityFluentBuilder

Constructs a fluent builder for the UpdateJobPriority operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID for the job whose priority you want to update.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: true
    

    The priority you want to assign to this job.

    
    
• On success, responds with UpdateJobPriorityOutput with field(s):
  • job_id(String):

    The ID for the job whose priority Amazon S3 updated.

  • priority(i32):

    The new priority assigned to the specified job.

• On failure, responds with SdkError<UpdateJobPriorityError>

impl Client

pub fn update_job_status(&self) -> UpdateJobStatusFluentBuilder

Constructs a fluent builder for the UpdateJobStatus operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID of the job whose status you want to update.

    
    
  • requested_job_status(RequestedJobStatus) / set_requested_job_status(Option<RequestedJobStatus>):
    required: true
    

    The status that you want to move the specified job to.

    
    
  • status_update_reason(impl Into<String>) / set_status_update_reason(Option<String>):
    required: false
    

    A description of the reason why you want to change the specified job’s status. This field can be any string up to the maximum length.

    
    
• On success, responds with UpdateJobStatusOutput with field(s):
  • job_id(Option<String>):

    The ID for the job whose status was updated.

  • status(Option<JobStatus>):

    The current status for the specified job.

  • status_update_reason(Option<String>):

    The reason that the specified job’s status was updated.

• On failure, responds with SdkError<UpdateJobStatusError>

impl Client

pub fn update_storage_lens_group(&self) -> UpdateStorageLensGroupFluentBuilder

Constructs a fluent builder for the UpdateStorageLensGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Storage Lens group that you want to update.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the Storage Lens group owner.

    
    
  • storage_lens_group(StorageLensGroup) / set_storage_lens_group(Option<StorageLensGroup>):
    required: true
    

    The JSON file that contains the Storage Lens group configuration.

    
    
• On success, responds with UpdateStorageLensGroupOutput
• On failure, responds with SdkError<UpdateStorageLensGroupError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.