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

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the CreateAccessPoint operation.

Constructs a fluent builder for the CreateAccessPointForObjectLambda operation.

Constructs a fluent builder for the CreateBucket operation.

Constructs a fluent builder for the CreateJob operation.

Constructs a fluent builder for the CreateMultiRegionAccessPoint operation.

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: : :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>

Constructs a fluent builder for the DeleteAccessPointForObjectLambda operation.

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: : :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>

Constructs a fluent builder for the DeleteAccessPointPolicyForObjectLambda operation.

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: : :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>

Constructs a fluent builder for the DeleteBucketLifecycleConfiguration operation.

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: : :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>

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: : :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>

Constructs a fluent builder for the DeleteJobTagging operation.

Constructs a fluent builder for the DeleteMultiRegionAccessPoint operation.

Constructs a fluent builder for the DeletePublicAccessBlock operation.

Constructs a fluent builder for the DeleteStorageLensConfiguration operation.

Constructs a fluent builder for the DeleteStorageLensConfigurationTagging operation.

Constructs a fluent builder for the DescribeJob operation.

Constructs a fluent builder for the DescribeMultiRegionAccessPointOperation operation.

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: : :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):
  • On failure, responds with SdkError<GetAccessPointError>

Constructs a fluent builder for the GetAccessPointConfigurationForObjectLambda operation.

Constructs a fluent builder for the GetAccessPointForObjectLambda operation.

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: : :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):
  • On failure, responds with SdkError<GetAccessPointPolicyError>

Constructs a fluent builder for the GetAccessPointPolicyForObjectLambda operation.

Constructs a fluent builder for the GetAccessPointPolicyStatus operation.

Constructs a fluent builder for the GetAccessPointPolicyStatusForObjectLambda operation.

Constructs a fluent builder for the GetBucket operation.

Constructs a fluent builder for the GetBucketLifecycleConfiguration operation.

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: : :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):
  • On failure, responds with SdkError<GetBucketPolicyError>

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: : :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):
  • On failure, responds with SdkError<GetBucketTaggingError>

Constructs a fluent builder for the GetJobTagging operation.

Constructs a fluent builder for the GetMultiRegionAccessPoint operation.

Constructs a fluent builder for the GetMultiRegionAccessPointPolicy operation.

Constructs a fluent builder for the GetMultiRegionAccessPointPolicyStatus operation.

Constructs a fluent builder for the GetPublicAccessBlock operation.

Constructs a fluent builder for the GetStorageLensConfiguration operation.

Constructs a fluent builder for the GetStorageLensConfigurationTagging operation.

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: : :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>):

      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(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>

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

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

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

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

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

Constructs a fluent builder for the PutAccessPointConfigurationForObjectLambda operation.

Constructs a fluent builder for the PutAccessPointPolicy operation.

Constructs a fluent builder for the PutAccessPointPolicyForObjectLambda operation.

Constructs a fluent builder for the PutBucketLifecycleConfiguration operation.

Constructs a fluent builder for the PutBucketPolicy operation.

Constructs a fluent builder for the PutBucketTagging operation.

Constructs a fluent builder for the PutJobTagging operation.

Constructs a fluent builder for the PutMultiRegionAccessPointPolicy operation.

Constructs a fluent builder for the PutPublicAccessBlock operation.

Constructs a fluent builder for the PutStorageLensConfiguration operation.

Constructs a fluent builder for the PutStorageLensConfigurationTagging operation.

Constructs a fluent builder for the UpdateJobPriority operation.

Constructs a fluent builder for the UpdateJobStatus operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more