Struct aws_sdk_s3control::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_s3control::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_s3control::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_s3control::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn create_access_point(&self) -> CreateAccessPoint
pub fn create_access_point(&self) -> CreateAccessPoint
Constructs a fluent builder for the CreateAccessPoint
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID for the owner of the bucket for which you want to create an access point.
name(impl Into<String>)
/set_name(Option<String>)
:The name you want to assign to this access point.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>)
: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>)
:The
PublicAccessBlock
configuration that you want to apply to the access point.
- 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>
sourcepub fn create_access_point_for_object_lambda(
&self
) -> CreateAccessPointForObjectLambda
pub fn create_access_point_for_object_lambda(
&self
) -> CreateAccessPointForObjectLambda
Constructs a fluent builder for the CreateAccessPointForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID for owner of the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
:The name you want to assign to this Object Lambda Access Point.
configuration(ObjectLambdaConfiguration)
/set_configuration(Option<ObjectLambdaConfiguration>)
: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.
- On failure, responds with
SdkError<CreateAccessPointForObjectLambdaError>
sourcepub fn create_bucket(&self) -> CreateBucket
pub fn create_bucket(&self) -> CreateBucket
Constructs a fluent builder for the CreateBucket
operation.
- The fluent builder is configurable:
acl(BucketCannedAcl)
/set_acl(Option<BucketCannedAcl>)
: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>)
:The name of the bucket.
create_bucket_configuration(CreateBucketConfiguration)
/set_create_bucket_configuration(Option<CreateBucketConfiguration>)
: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>)
: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>)
: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>)
: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>)
: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>)
: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(bool)
: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>)
:The ID of the Outposts where the bucket is being created.
This 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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
- On failure, responds with
SdkError<CreateBucketError>
sourcepub fn create_job(&self) -> CreateJob
pub fn create_job(&self) -> CreateJob
Constructs a fluent builder for the CreateJob
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID that creates the job.
confirmation_required(bool)
/set_confirmation_required(Option<bool>)
: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>)
: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>)
:Configuration parameters for the optional job-completion report.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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>)
:Configuration parameters for the manifest.
description(impl Into<String>)
/set_description(Option<String>)
: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>)
:The numerical priority for this job. Higher numbers indicate higher priority.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
: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(Vec<S3Tag>)
/set_tags(Option<Vec<S3Tag>>)
: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>)
: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>
sourcepub fn create_multi_region_access_point(&self) -> CreateMultiRegionAccessPoint
pub fn create_multi_region_access_point(&self) -> CreateMultiRegionAccessPoint
Constructs a fluent builder for the CreateMultiRegionAccessPoint
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>)
:An idempotency token used to identify the request and guarantee that requests are unique.
details(CreateMultiRegionAccessPointInput)
/set_details(Option<CreateMultiRegionAccessPointInput>)
: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>
sourcepub fn delete_access_point(&self) -> DeleteAccessPoint
pub fn delete_access_point(&self) -> DeleteAccessPoint
Constructs a fluent builder for the DeleteAccessPoint
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified access point.
name(impl Into<String>)
/set_name(Option<String>)
: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:
. For example, to access the access point: :outpost/ /accesspoint/ reports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn delete_access_point_for_object_lambda(
&self
) -> DeleteAccessPointForObjectLambda
pub fn delete_access_point_for_object_lambda(
&self
) -> DeleteAccessPointForObjectLambda
Constructs a fluent builder for the DeleteAccessPointForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the access point you want to delete.
- On success, responds with
DeleteAccessPointForObjectLambdaOutput
- On failure, responds with
SdkError<DeleteAccessPointForObjectLambdaError>
sourcepub fn delete_access_point_policy(&self) -> DeleteAccessPointPolicy
pub fn delete_access_point_policy(&self) -> DeleteAccessPointPolicy
Constructs a fluent builder for the DeleteAccessPointPolicy
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified access point.
name(impl Into<String>)
/set_name(Option<String>)
: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:
. For example, to access the access point: :outpost/ /accesspoint/ reports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn delete_access_point_policy_for_object_lambda(
&self
) -> DeleteAccessPointPolicyForObjectLambda
pub fn delete_access_point_policy_for_object_lambda(
&self
) -> DeleteAccessPointPolicyForObjectLambda
Constructs a fluent builder for the DeleteAccessPointPolicyForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn delete_bucket(&self) -> DeleteBucket
pub fn delete_bucket(&self) -> DeleteBucket
Constructs a fluent builder for the DeleteBucket
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID that owns the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn delete_bucket_lifecycle_configuration(
&self
) -> DeleteBucketLifecycleConfiguration
pub fn delete_bucket_lifecycle_configuration(
&self
) -> DeleteBucketLifecycleConfiguration
Constructs a fluent builder for the DeleteBucketLifecycleConfiguration
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID of the lifecycle configuration to delete.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn delete_bucket_policy(&self) -> DeleteBucketPolicy
pub fn delete_bucket_policy(&self) -> DeleteBucketPolicy
Constructs a fluent builder for the DeleteBucketPolicy
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID of the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn delete_bucket_tagging(&self) -> DeleteBucketTagging
pub fn delete_bucket_tagging(&self) -> DeleteBucketTagging
Constructs a fluent builder for the DeleteBucketTagging
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID of the Outposts bucket tag set to be removed.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn delete_job_tagging(&self) -> DeleteJobTagging
pub fn delete_job_tagging(&self) -> DeleteJobTagging
Constructs a fluent builder for the DeleteJobTagging
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID associated with the S3 Batch Operations job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
: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>
sourcepub fn delete_multi_region_access_point(&self) -> DeleteMultiRegionAccessPoint
pub fn delete_multi_region_access_point(&self) -> DeleteMultiRegionAccessPoint
Constructs a fluent builder for the DeleteMultiRegionAccessPoint
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>)
:An idempotency token used to identify the request and guarantee that requests are unique.
details(DeleteMultiRegionAccessPointInput)
/set_details(Option<DeleteMultiRegionAccessPointInput>)
: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>
sourcepub fn delete_public_access_block(&self) -> DeletePublicAccessBlock
pub fn delete_public_access_block(&self) -> DeletePublicAccessBlock
Constructs a fluent builder for the DeletePublicAccessBlock
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>
sourcepub fn delete_storage_lens_configuration(
&self
) -> DeleteStorageLensConfiguration
pub fn delete_storage_lens_configuration(
&self
) -> DeleteStorageLensConfiguration
Constructs a fluent builder for the DeleteStorageLensConfiguration
operation.
- The fluent builder is configurable:
config_id(impl Into<String>)
/set_config_id(Option<String>)
:The ID of the S3 Storage Lens configuration.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID of the requester.
- On success, responds with
DeleteStorageLensConfigurationOutput
- On failure, responds with
SdkError<DeleteStorageLensConfigurationError>
sourcepub fn delete_storage_lens_configuration_tagging(
&self
) -> DeleteStorageLensConfigurationTagging
pub fn delete_storage_lens_configuration_tagging(
&self
) -> DeleteStorageLensConfigurationTagging
Constructs a fluent builder for the DeleteStorageLensConfigurationTagging
operation.
- The fluent builder is configurable:
config_id(impl Into<String>)
/set_config_id(Option<String>)
:The ID of the S3 Storage Lens configuration.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID of the requester.
- On success, responds with
DeleteStorageLensConfigurationTaggingOutput
- On failure, responds with
SdkError<DeleteStorageLensConfigurationTaggingError>
sourcepub fn describe_job(&self) -> DescribeJob
pub fn describe_job(&self) -> DescribeJob
Constructs a fluent builder for the DescribeJob
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID associated with the S3 Batch Operations job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
: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>
sourcepub fn describe_multi_region_access_point_operation(
&self
) -> DescribeMultiRegionAccessPointOperation
pub fn describe_multi_region_access_point_operation(
&self
) -> DescribeMultiRegionAccessPointOperation
Constructs a fluent builder for the DescribeMultiRegionAccessPointOperation
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>)
: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>
sourcepub fn get_access_point(&self) -> GetAccessPoint
pub fn get_access_point(&self) -> GetAccessPoint
Constructs a fluent builder for the GetAccessPoint
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified access point.
name(impl Into<String>)
/set_name(Option<String>)
: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:
. For example, to access the access point: :outpost/ /accesspoint/ reports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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, thenNetworkOrigin
isVPC
, and the access point doesn’t allow access from the public internet. Otherwise,NetworkOrigin
isInternet
, 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.
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 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.
- On failure, responds with
SdkError<GetAccessPointError>
sourcepub fn get_access_point_configuration_for_object_lambda(
&self
) -> GetAccessPointConfigurationForObjectLambda
pub fn get_access_point_configuration_for_object_lambda(
&self
) -> GetAccessPointConfigurationForObjectLambda
Constructs a fluent builder for the GetAccessPointConfigurationForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn get_access_point_for_object_lambda(
&self
) -> GetAccessPointForObjectLambda
pub fn get_access_point_for_object_lambda(
&self
) -> GetAccessPointForObjectLambda
Constructs a fluent builder for the GetAccessPointForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
: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.
- On failure, responds with
SdkError<GetAccessPointForObjectLambdaError>
sourcepub fn get_access_point_policy(&self) -> GetAccessPointPolicy
pub fn get_access_point_policy(&self) -> GetAccessPointPolicy
Constructs a fluent builder for the GetAccessPointPolicy
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified access point.
name(impl Into<String>)
/set_name(Option<String>)
: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:
. For example, to access the access point: :outpost/ /accesspoint/ reports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn get_access_point_policy_for_object_lambda(
&self
) -> GetAccessPointPolicyForObjectLambda
pub fn get_access_point_policy_for_object_lambda(
&self
) -> GetAccessPointPolicyForObjectLambda
Constructs a fluent builder for the GetAccessPointPolicyForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn get_access_point_policy_status(&self) -> GetAccessPointPolicyStatus
pub fn get_access_point_policy_status(&self) -> GetAccessPointPolicyStatus
Constructs a fluent builder for the GetAccessPointPolicyStatus
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified access point.
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn get_access_point_policy_status_for_object_lambda(
&self
) -> GetAccessPointPolicyStatusForObjectLambda
pub fn get_access_point_policy_status_for_object_lambda(
&self
) -> GetAccessPointPolicyStatusForObjectLambda
Constructs a fluent builder for the GetAccessPointPolicyStatusForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn get_bucket(&self) -> GetBucket
pub fn get_bucket(&self) -> GetBucket
Constructs a fluent builder for the GetBucket
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID of the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn get_bucket_lifecycle_configuration(
&self
) -> GetBucketLifecycleConfiguration
pub fn get_bucket_lifecycle_configuration(
&self
) -> GetBucketLifecycleConfiguration
Constructs a fluent builder for the GetBucketLifecycleConfiguration
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID of the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn get_bucket_policy(&self) -> GetBucketPolicy
pub fn get_bucket_policy(&self) -> GetBucketPolicy
Constructs a fluent builder for the GetBucketPolicy
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID of the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>
sourcepub fn get_bucket_tagging(&self) -> GetBucketTagging
pub fn get_bucket_tagging(&self) -> GetBucketTagging
Constructs a fluent builder for the GetBucketTagging
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID of the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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(Option<Vec<S3Tag>>)
:The tags set of the Outposts bucket.
- On failure, responds with
SdkError<GetBucketTaggingError>
sourcepub fn get_job_tagging(&self) -> GetJobTagging
pub fn get_job_tagging(&self) -> GetJobTagging
Constructs a fluent builder for the GetJobTagging
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID associated with the S3 Batch Operations job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
: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>
sourcepub fn get_multi_region_access_point(&self) -> GetMultiRegionAccessPoint
pub fn get_multi_region_access_point(&self) -> GetMultiRegionAccessPoint
Constructs a fluent builder for the GetMultiRegionAccessPoint
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
name(impl Into<String>)
/set_name(Option<String>)
: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 Managing 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>
sourcepub fn get_multi_region_access_point_policy(
&self
) -> GetMultiRegionAccessPointPolicy
pub fn get_multi_region_access_point_policy(
&self
) -> GetMultiRegionAccessPointPolicy
Constructs a fluent builder for the GetMultiRegionAccessPointPolicy
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
name(impl Into<String>)
/set_name(Option<String>)
: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 Managing 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>
sourcepub fn get_multi_region_access_point_policy_status(
&self
) -> GetMultiRegionAccessPointPolicyStatus
pub fn get_multi_region_access_point_policy_status(
&self
) -> GetMultiRegionAccessPointPolicyStatus
Constructs a fluent builder for the GetMultiRegionAccessPointPolicyStatus
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
name(impl Into<String>)
/set_name(Option<String>)
: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 Managing 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>
sourcepub fn get_public_access_block(&self) -> GetPublicAccessBlock
pub fn get_public_access_block(&self) -> GetPublicAccessBlock
Constructs a fluent builder for the GetPublicAccessBlock
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>
sourcepub fn get_storage_lens_configuration(&self) -> GetStorageLensConfiguration
pub fn get_storage_lens_configuration(&self) -> GetStorageLensConfiguration
Constructs a fluent builder for the GetStorageLensConfiguration
operation.
- The fluent builder is configurable:
config_id(impl Into<String>)
/set_config_id(Option<String>)
:The ID of the Amazon S3 Storage Lens configuration.
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>
sourcepub fn get_storage_lens_configuration_tagging(
&self
) -> GetStorageLensConfigurationTagging
pub fn get_storage_lens_configuration_tagging(
&self
) -> GetStorageLensConfigurationTagging
Constructs a fluent builder for the GetStorageLensConfigurationTagging
operation.
- The fluent builder is configurable:
config_id(impl Into<String>)
/set_config_id(Option<String>)
:The ID of the Amazon S3 Storage Lens configuration.
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>
sourcepub fn list_access_points(&self) -> ListAccessPoints
pub fn list_access_points(&self) -> ListAccessPoints
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>)
:The Amazon Web Services account ID for owner of the bucket whose access points you want to list.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>)
:A continuation token. If a previous call to
ListAccessPoints
returned a continuation token in theNextToken
field, then providing that value here causes Amazon S3 to retrieve the next page of results.max_results(i32)
/set_max_results(i32)
: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>
sourcepub fn list_access_points_for_object_lambda(
&self
) -> ListAccessPointsForObjectLambda
pub fn list_access_points_for_object_lambda(
&self
) -> ListAccessPointsForObjectLambda
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>)
:The account ID for the account that owns the specified Object Lambda Access Point.
next_token(impl Into<String>)
/set_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.
max_results(i32)
/set_max_results(i32)
: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>
sourcepub fn list_jobs(&self) -> ListJobs
pub fn list_jobs(&self) -> ListJobs
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>)
:The Amazon Web Services account ID associated with the S3 Batch Operations job.
job_statuses(Vec<JobStatus>)
/set_job_statuses(Option<Vec<JobStatus>>)
:The
List Jobs
request returns jobs that match the statuses listed in this element.next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
NextToken
element of theListJobsResult
from the previousList Jobs
request.max_results(i32)
/set_max_results(Option<i32>)
: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 theNextToken
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 subsequentList 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>
sourcepub fn list_multi_region_access_points(&self) -> ListMultiRegionAccessPoints
pub fn list_multi_region_access_points(&self) -> ListMultiRegionAccessPoints
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>)
: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>)
:Not currently used. Do not use this parameter.
max_results(i32)
/set_max_results(i32)
: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>
sourcepub fn list_regional_buckets(&self) -> ListRegionalBuckets
pub fn list_regional_buckets(&self) -> ListRegionalBuckets
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>)
:The Amazon Web Services account ID of the Outposts bucket.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:max_results(i32)
/set_max_results(i32)
:outpost_id(impl Into<String>)
/set_outpost_id(Option<String>)
:The ID of the Outposts.
This 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 whenisTruncated
is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with thisNextToken
.NextToken
is obfuscated and is not a real key.
- On failure, responds with
SdkError<ListRegionalBucketsError>
sourcepub fn list_storage_lens_configurations(&self) -> ListStorageLensConfigurations
pub fn list_storage_lens_configurations(&self) -> ListStorageLensConfigurations
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>)
:The account ID of the requester.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn put_access_point_configuration_for_object_lambda(
&self
) -> PutAccessPointConfigurationForObjectLambda
pub fn put_access_point_configuration_for_object_lambda(
&self
) -> PutAccessPointConfigurationForObjectLambda
Constructs a fluent builder for the PutAccessPointConfigurationForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the Object Lambda Access Point.
configuration(ObjectLambdaConfiguration)
/set_configuration(Option<ObjectLambdaConfiguration>)
:Object Lambda Access Point configuration document.
- On success, responds with
PutAccessPointConfigurationForObjectLambdaOutput
- On failure, responds with
SdkError<PutAccessPointConfigurationForObjectLambdaError>
sourcepub fn put_access_point_policy(&self) -> PutAccessPointPolicy
pub fn put_access_point_policy(&self) -> PutAccessPointPolicy
Constructs a fluent builder for the PutAccessPointPolicy
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>)
: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:
. For example, to access the access point: :outpost/ /accesspoint/ reports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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>)
:The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.
- On success, responds with
PutAccessPointPolicyOutput
- On failure, responds with
SdkError<PutAccessPointPolicyError>
sourcepub fn put_access_point_policy_for_object_lambda(
&self
) -> PutAccessPointPolicyForObjectLambda
pub fn put_access_point_policy_for_object_lambda(
&self
) -> PutAccessPointPolicyForObjectLambda
Constructs a fluent builder for the PutAccessPointPolicyForObjectLambda
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID for the account that owns the specified Object Lambda Access Point.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the Object Lambda Access Point.
policy(impl Into<String>)
/set_policy(Option<String>)
:Object Lambda Access Point resource policy document.
- On success, responds with
PutAccessPointPolicyForObjectLambdaOutput
- On failure, responds with
SdkError<PutAccessPointPolicyForObjectLambdaError>
sourcepub fn put_bucket_lifecycle_configuration(
&self
) -> PutBucketLifecycleConfiguration
pub fn put_bucket_lifecycle_configuration(
&self
) -> PutBucketLifecycleConfiguration
Constructs a fluent builder for the PutBucketLifecycleConfiguration
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID of the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(Option<String>)
:The name of the bucket for which to set the configuration.
lifecycle_configuration(LifecycleConfiguration)
/set_lifecycle_configuration(Option<LifecycleConfiguration>)
:Container for lifecycle rules. You can add as many as 1,000 rules.
- On success, responds with
PutBucketLifecycleConfigurationOutput
- On failure, responds with
SdkError<PutBucketLifecycleConfigurationError>
sourcepub fn put_bucket_policy(&self) -> PutBucketPolicy
pub fn put_bucket_policy(&self) -> PutBucketPolicy
Constructs a fluent builder for the PutBucketPolicy
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID of the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(Option<String>)
: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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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(bool)
: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>)
:The bucket policy as a JSON document.
- On success, responds with
PutBucketPolicyOutput
- On failure, responds with
SdkError<PutBucketPolicyError>
sourcepub fn put_bucket_tagging(&self) -> PutBucketTagging
pub fn put_bucket_tagging(&self) -> PutBucketTagging
Constructs a fluent builder for the PutBucketTagging
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID of the Outposts bucket.
bucket(impl Into<String>)
/set_bucket(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:
. For example, to access the bucket: :outpost/ /bucket/ reports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.tagging(Tagging)
/set_tagging(Option<Tagging>)
:
- On success, responds with
PutBucketTaggingOutput
- On failure, responds with
SdkError<PutBucketTaggingError>
sourcepub fn put_job_tagging(&self) -> PutJobTagging
pub fn put_job_tagging(&self) -> PutJobTagging
Constructs a fluent builder for the PutJobTagging
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID associated with the S3 Batch Operations job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID for the S3 Batch Operations job whose tags you want to replace.
tags(Vec<S3Tag>)
/set_tags(Option<Vec<S3Tag>>)
:The set of tags to associate with the S3 Batch Operations job.
- On success, responds with
PutJobTaggingOutput
- On failure, responds with
SdkError<PutJobTaggingError>
sourcepub fn put_multi_region_access_point_policy(
&self
) -> PutMultiRegionAccessPointPolicy
pub fn put_multi_region_access_point_policy(
&self
) -> PutMultiRegionAccessPointPolicy
Constructs a fluent builder for the PutMultiRegionAccessPointPolicy
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
: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>)
:An idempotency token used to identify the request and guarantee that requests are unique.
details(PutMultiRegionAccessPointPolicyInput)
/set_details(Option<PutMultiRegionAccessPointPolicyInput>)
: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>
sourcepub fn put_public_access_block(&self) -> PutPublicAccessBlock
pub fn put_public_access_block(&self) -> PutPublicAccessBlock
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>)
: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>)
: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>
sourcepub fn put_storage_lens_configuration(&self) -> PutStorageLensConfiguration
pub fn put_storage_lens_configuration(&self) -> PutStorageLensConfiguration
Constructs a fluent builder for the PutStorageLensConfiguration
operation.
- The fluent builder is configurable:
config_id(impl Into<String>)
/set_config_id(Option<String>)
:The ID of the S3 Storage Lens configuration.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID of the requester.
storage_lens_configuration(StorageLensConfiguration)
/set_storage_lens_configuration(Option<StorageLensConfiguration>)
:The S3 Storage Lens configuration.
tags(Vec<StorageLensTag>)
/set_tags(Option<Vec<StorageLensTag>>)
: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>
sourcepub fn put_storage_lens_configuration_tagging(
&self
) -> PutStorageLensConfigurationTagging
pub fn put_storage_lens_configuration_tagging(
&self
) -> PutStorageLensConfigurationTagging
Constructs a fluent builder for the PutStorageLensConfigurationTagging
operation.
- The fluent builder is configurable:
config_id(impl Into<String>)
/set_config_id(Option<String>)
:The ID of the S3 Storage Lens configuration.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The account ID of the requester.
tags(Vec<StorageLensTag>)
/set_tags(Option<Vec<StorageLensTag>>)
: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>
sourcepub fn update_job_priority(&self) -> UpdateJobPriority
pub fn update_job_priority(&self) -> UpdateJobPriority
Constructs a fluent builder for the UpdateJobPriority
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID associated with the S3 Batch Operations job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID for the job whose priority you want to update.
priority(i32)
/set_priority(i32)
:The priority you want to assign to this job.
- On success, responds with
UpdateJobPriorityOutput
with field(s):job_id(Option<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>
sourcepub fn update_job_status(&self) -> UpdateJobStatus
pub fn update_job_status(&self) -> UpdateJobStatus
Constructs a fluent builder for the UpdateJobStatus
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Web Services account ID associated with the S3 Batch Operations job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID of the job whose status you want to update.
requested_job_status(RequestedJobStatus)
/set_requested_job_status(Option<RequestedJobStatus>)
:The status that you want to move the specified job to.
status_update_reason(impl Into<String>)
/set_status_update_reason(Option<String>)
: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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more