Struct aws_sdk_s3outposts::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for Amazon S3 on Outposts

Client for invoking operations on Amazon S3 on Outposts. Each operation on Amazon S3 on Outposts 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_s3outposts::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_s3outposts::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_s3outposts::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn create_endpoint(&self) -> CreateEndpoint

Constructs a fluent builder for the CreateEndpoint operation.

The fluent builder is configurable:
- outpost_id(impl Into<String>) / set_outpost_id(Option<String>):
 The ID of the Outposts.
- subnet_id(impl Into<String>) / set_subnet_id(Option<String>):
 The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.
- security_group_id(impl Into<String>) / set_security_group_id(Option<String>):
 The ID of the security group to use with the endpoint.
- access_type(EndpointAccessType) / set_access_type(Option<EndpointAccessType>):
 The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).
 
 Private is the default access type value.
- customer_owned_ipv4_pool(impl Into<String>) / set_customer_owned_ipv4_pool(Option<String>):
 The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.
On success, responds with CreateEndpointOutput with field(s):
- endpoint_arn(Option<String>):
 The Amazon Resource Name (ARN) of the endpoint.
On failure, responds with SdkError<CreateEndpointError>

source

pub fn delete_endpoint(&self) -> DeleteEndpoint

Constructs a fluent builder for the DeleteEndpoint operation.

The fluent builder is configurable:
- endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
 The ID of the endpoint.
- outpost_id(impl Into<String>) / set_outpost_id(Option<String>):
 The ID of the Outposts.
On success, responds with DeleteEndpointOutput
On failure, responds with SdkError<DeleteEndpointError>

source

pub fn list_endpoints(&self) -> ListEndpoints

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

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If a previous response from this operation included a NextToken value, provide that value here to retrieve the next page of results.
- max_results(i32) / set_max_results(i32):
 The maximum number of endpoints that will be returned in the response.
On success, responds with ListEndpointsOutput with field(s):
- endpoints(Option<Vec<Endpoint>>):
 The list of endpoints associated with the specified Outpost.
- next_token(Option<String>):
 If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.
On failure, responds with SdkError<ListEndpointsError>

source

pub fn list_shared_endpoints(&self) -> ListSharedEndpoints

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

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.
- max_results(i32) / set_max_results(i32):
 The maximum number of endpoints that will be returned in the response.
- outpost_id(impl Into<String>) / set_outpost_id(Option<String>):
 The ID of the Amazon Web Services Outpost.
On success, responds with ListSharedEndpointsOutput with field(s):
- endpoints(Option<Vec<Endpoint>>):
 The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).
- next_token(Option<String>):
 If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.
On failure, responds with SdkError<ListSharedEndpointsError>