Struct Client 

pub struct Client { /* private fields */ }

Client for RTBFabric

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

Constructing a Client

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

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

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

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

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

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

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

Using the Client

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

let result = client.accept_link()
    .gateway_id("example")
    .send()
    .await;

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

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn accept_link(&self) -> AcceptLinkFluentBuilder

Constructs a fluent builder for the AcceptLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
  • attributes(LinkAttributes) / set_attributes(Option<LinkAttributes>):
    required: false
    

    Attributes of the link.

    
    
  • log_settings(LinkLogSettings) / set_log_settings(Option<LinkLogSettings>):
    required: true
    

    Settings for the application logs.

    
    
• On success, responds with AcceptLinkOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • peer_gateway_id(String):

    The unique identifier of the peer gateway.

  • status(LinkStatus):

    The status of the link.

  • created_at(DateTime):

    The timestamp of when the link was created.

  • updated_at(DateTime):

    The timestamp of when the link was updated.

  • direction(Option<LinkDirection>):

    The direction of the link.

  • flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of flow modules.

  • pending_flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of pending flow modules.

  • attributes(Option<LinkAttributes>):

    Attributes of the link.

  • link_id(String):

    The unique identifier of the link.

• On failure, responds with SdkError<AcceptLinkError>

impl Client

pub fn create_inbound_external_link( &self, ) -> CreateInboundExternalLinkFluentBuilder

Constructs a fluent builder for the CreateInboundExternalLink operation.

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

    The unique client token.

    
    
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The unique identifier of the gateway.

    
    
  • attributes(LinkAttributes) / set_attributes(Option<LinkAttributes>):
    required: false
    

    Attributes of the link.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of the key-value pairs of the tag or tags to assign to the resource.

    
    
• On success, responds with CreateInboundExternalLinkOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the request.

  • domain_name(String):

    The domain name.

• On failure, responds with SdkError<CreateInboundExternalLinkError>

impl Client

pub fn create_link(&self) -> CreateLinkFluentBuilder

Constructs a fluent builder for the CreateLink operation.

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

    The unique identifier of the gateway.

    
    
  • peer_gateway_id(impl Into<String>) / set_peer_gateway_id(Option<String>):
    required: true
    

    The unique identifier of the peer gateway.

    
    
  • attributes(LinkAttributes) / set_attributes(Option<LinkAttributes>):
    required: false
    

    Attributes of the link.

    
    
  • http_responder_allowed(bool) / set_http_responder_allowed(Option<bool>):
    required: false
    

    Boolean to specify if an HTTP responder is allowed.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of the key-value pairs of the tag or tags to assign to the resource.

    
    
  • log_settings(LinkLogSettings) / set_log_settings(Option<LinkLogSettings>):
    required: true
    

    Settings for the application logs.

    
    
• On success, responds with CreateLinkOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • peer_gateway_id(String):

    The unique identifier of the peer gateway.

  • status(LinkStatus):

    The status of the request.

  • created_at(DateTime):

    The timestamp of when the link was created.

  • updated_at(DateTime):

    The timestamp of when the link was updated.

  • direction(Option<LinkDirection>):

    The direction of the link.

  • flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of flow modules.

  • pending_flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of pending flow modules.

  • attributes(Option<LinkAttributes>):

    Attributes of the link.

  • link_id(String):

    The unique identifier of the link.

  • customer_provided_id(Option<String>):

    The customer-provided unique identifier of the link.

• On failure, responds with SdkError<CreateLinkError>

impl Client

pub fn create_outbound_external_link( &self, ) -> CreateOutboundExternalLinkFluentBuilder

Constructs a fluent builder for the CreateOutboundExternalLink operation.

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

    The unique client token.

    
    
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The unique identifier of the gateway.

    
    
  • public_endpoint(impl Into<String>) / set_public_endpoint(Option<String>):
    required: true
    

    The public endpoint of the link.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of the key-value pairs of the tag or tags to assign to the resource.

    
    
• On success, responds with CreateOutboundExternalLinkOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the request.

• On failure, responds with SdkError<CreateOutboundExternalLinkError>

impl Client

pub fn create_requester_gateway(&self) -> CreateRequesterGatewayFluentBuilder

Constructs a fluent builder for the CreateRequesterGateway operation.

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

    The unique identifier of the Virtual Private Cloud (VPC).

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    The unique identifiers of the subnets.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: true
    

    The unique identifiers of the security groups.

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

    The unique client token.

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

    An optional description for the requester gateway.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of the key-value pairs of the tag or tags to assign to the resource.

    
    
• On success, responds with CreateRequesterGatewayOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • domain_name(String):

    The domain name of the requester gateway.

  • status(RequesterGatewayStatus):

    The status of the request.

• On failure, responds with SdkError<CreateRequesterGatewayError>

impl Client

pub fn create_responder_gateway(&self) -> CreateResponderGatewayFluentBuilder

Constructs a fluent builder for the CreateResponderGateway operation.

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

    The unique identifier of the Virtual Private Cloud (VPC).

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    The unique identifiers of the subnets.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: true
    

    The unique identifiers of the security groups.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: false
    

    The domain name for the responder gateway.

    
    
  • port(i32) / set_port(Option<i32>):
    required: true
    

    The networking port to use.

    
    
  • protocol(Protocol) / set_protocol(Option<Protocol>):
    required: true
    

    The networking protocol to use.

    
    
  • trust_store_configuration(TrustStoreConfiguration) / set_trust_store_configuration(Option<TrustStoreConfiguration>):
    required: false
    

    The configuration of the trust store.

    
    
  • managed_endpoint_configuration(ManagedEndpointConfiguration) / set_managed_endpoint_configuration(Option<ManagedEndpointConfiguration>):
    required: false
    

    The configuration for the managed endpoint.

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

    The unique client token.

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

    An optional description for the responder gateway.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of the key-value pairs of the tag or tags to assign to the resource.

    
    
• On success, responds with CreateResponderGatewayOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • status(ResponderGatewayStatus):

    The status of the request.

• On failure, responds with SdkError<CreateResponderGatewayError>

impl Client

pub fn delete_inbound_external_link( &self, ) -> DeleteInboundExternalLinkFluentBuilder

Constructs a fluent builder for the DeleteInboundExternalLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
• On success, responds with DeleteInboundExternalLinkOutput with field(s):
  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the request.

• On failure, responds with SdkError<DeleteInboundExternalLinkError>

impl Client

pub fn delete_link(&self) -> DeleteLinkFluentBuilder

Constructs a fluent builder for the DeleteLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
• On success, responds with DeleteLinkOutput with field(s):
  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the link.

• On failure, responds with SdkError<DeleteLinkError>

impl Client

pub fn delete_outbound_external_link( &self, ) -> DeleteOutboundExternalLinkFluentBuilder

Constructs a fluent builder for the DeleteOutboundExternalLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
• On success, responds with DeleteOutboundExternalLinkOutput with field(s):
  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the request.

• On failure, responds with SdkError<DeleteOutboundExternalLinkError>

impl Client

pub fn delete_requester_gateway(&self) -> DeleteRequesterGatewayFluentBuilder

Constructs a fluent builder for the DeleteRequesterGateway operation.

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

    The unique identifier of the gateway.

    
    
• On success, responds with DeleteRequesterGatewayOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • status(RequesterGatewayStatus):

    The status of the request.

• On failure, responds with SdkError<DeleteRequesterGatewayError>

impl Client

pub fn delete_responder_gateway(&self) -> DeleteResponderGatewayFluentBuilder

Constructs a fluent builder for the DeleteResponderGateway operation.

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

    The unique identifier of the gateway.

    
    
• On success, responds with DeleteResponderGatewayOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • status(ResponderGatewayStatus):

    The status of the request.

• On failure, responds with SdkError<DeleteResponderGatewayError>

impl Client

pub fn get_inbound_external_link(&self) -> GetInboundExternalLinkFluentBuilder

Constructs a fluent builder for the GetInboundExternalLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
• On success, responds with GetInboundExternalLinkOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the request.

  • domain_name(String):

    The domain name.

  • flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of flow modules.

  • pending_flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of pending flow modules.

  • attributes(Option<LinkAttributes>):

    Attributes of the link.

  • created_at(Option<DateTime>):

    The timestamp of when the inbound external link was created.

  • updated_at(Option<DateTime>):

    The timestamp of when the inbound external link was updated.

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

    A map of the key-value pairs for the tag or tags assigned to the specified resource.

• On failure, responds with SdkError<GetInboundExternalLinkError>

impl Client

pub fn get_link(&self) -> GetLinkFluentBuilder

Constructs a fluent builder for the GetLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
• On success, responds with GetLinkOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • peer_gateway_id(String):

    The unique identifier of the peer gateway.

  • status(LinkStatus):

    The status of the link.

  • created_at(DateTime):

    The timestamp of when the link was created.

  • updated_at(DateTime):

    The timestamp of when the link was updated.

  • direction(Option<LinkDirection>):

    The direction of the link.

  • flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of flow modules.

  • pending_flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of pending flow modules.

  • attributes(Option<LinkAttributes>):

    Attributes of the link.

  • link_id(String):

    The unique identifier of the link.

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

    A map of the key-value pairs for the tag or tags assigned to the specified resource.

  • log_settings(Option<LinkLogSettings>):

    Settings for the application logs.

• On failure, responds with SdkError<GetLinkError>

impl Client

pub fn get_outbound_external_link(&self) -> GetOutboundExternalLinkFluentBuilder

Constructs a fluent builder for the GetOutboundExternalLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
• On success, responds with GetOutboundExternalLinkOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the request.

  • public_endpoint(String):

    The public endpoint for the link.

  • created_at(Option<DateTime>):

    The timestamp of when the outbound external link was created.

  • updated_at(Option<DateTime>):

    The timestamp of when the outbound external link was updated.

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

    A map of the key-value pairs for the tag or tags assigned to the specified resource.

• On failure, responds with SdkError<GetOutboundExternalLinkError>

impl Client

pub fn get_requester_gateway(&self) -> GetRequesterGatewayFluentBuilder

Constructs a fluent builder for the GetRequesterGateway operation.

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

    The unique identifier of the gateway.

    
    
• On success, responds with GetRequesterGatewayOutput with field(s):
  • status(RequesterGatewayStatus):

    The status of the request.

  • domain_name(String):

    The domain name of the requester gateway.

  • description(Option<String>):

    The description of the requester gateway.

  • created_at(Option<DateTime>):

    The timestamp of when the requester gateway was created.

  • updated_at(Option<DateTime>):

    The timestamp of when the requester gateway was updated.

  • vpc_id(String):

    The unique identifier of the Virtual Private Cloud (VPC).

  • subnet_ids(Vec::<String>):

    The unique identifiers of the subnets.

  • security_group_ids(Vec::<String>):

    The unique identifiers of the security groups.

  • gateway_id(String):

    The unique identifier of the gateway.

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

    A map of the key-value pairs for the tag or tags assigned to the specified resource.

  • active_links_count(Option<i32>):

    The count of active links for the requester gateway.

  • total_links_count(Option<i32>):

    The total count of links for the requester gateway.

• On failure, responds with SdkError<GetRequesterGatewayError>

impl Client

pub fn get_responder_gateway(&self) -> GetResponderGatewayFluentBuilder

Constructs a fluent builder for the GetResponderGateway operation.

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

    The unique identifier of the gateway.

    
    
• On success, responds with GetResponderGatewayOutput with field(s):
  • vpc_id(String):

    The unique identifier of the Virtual Private Cloud (VPC).

  • subnet_ids(Vec::<String>):

    The unique identifiers of the subnets.

  • security_group_ids(Vec::<String>):

    The unique identifiers of the security groups.

  • status(ResponderGatewayStatus):

    The status of the request.

  • description(Option<String>):

    The description of the responder gateway.

  • created_at(Option<DateTime>):

    The timestamp of when the responder gateway was created.

  • updated_at(Option<DateTime>):

    The timestamp of when the responder gateway was updated.

  • domain_name(Option<String>):

    The domain name of the responder gateway.

  • port(i32):

    The networking port.

  • protocol(Protocol):

    The networking protocol.

  • trust_store_configuration(Option<TrustStoreConfiguration>):

    The configuration of the trust store.

  • managed_endpoint_configuration(Option<ManagedEndpointConfiguration>):

    The configuration of the managed endpoint.

  • gateway_id(String):

    The unique identifier of the gateway.

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

    A map of the key-value pairs for the tag or tags assigned to the specified resource.

  • active_links_count(Option<i32>):

    The count of active links for the responder gateway.

  • total_links_count(Option<i32>):

    The total count of links for the responder gateway.

  • inbound_links_count(Option<i32>):

    The count of inbound links for the responder gateway.

• On failure, responds with SdkError<GetResponderGatewayError>

impl Client

pub fn list_links(&self) -> ListLinksFluentBuilder

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

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

    The unique identifier of the gateway.

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

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    
    
• On success, responds with ListLinksOutput with field(s):
  • links(Option<Vec::<ListLinksResponseStructure>>):

    Information about created links.

  • next_token(Option<String>):

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

• On failure, responds with SdkError<ListLinksError>

impl Client

pub fn list_requester_gateways(&self) -> ListRequesterGatewaysFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

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

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    
    
• On success, responds with ListRequesterGatewaysOutput with field(s):
  • gateway_ids(Option<Vec::<String>>):

    The unique identifier of the gateways.

  • next_token(Option<String>):

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

• On failure, responds with SdkError<ListRequesterGatewaysError>

impl Client

pub fn list_responder_gateways(&self) -> ListResponderGatewaysFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

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

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    
    
• On success, responds with ListResponderGatewaysOutput with field(s):
  • gateway_ids(Option<Vec::<String>>):

    The unique identifier of the gateways.

  • next_token(Option<String>):

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

• On failure, responds with SdkError<ListResponderGatewaysError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

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

    A map of the key-value pairs for the tag or tags assigned to the specified resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn reject_link(&self) -> RejectLinkFluentBuilder

Constructs a fluent builder for the RejectLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
• On success, responds with RejectLinkOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • peer_gateway_id(String):

    The unique identifier of the peer gateway.

  • status(LinkStatus):

    The status of the link.

  • created_at(DateTime):

    The timestamp of when the link was created.

  • updated_at(DateTime):

    The timestamp of when the link was updated.

  • direction(Option<LinkDirection>):

    The direction of the link.

  • flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of flow modules.

  • pending_flow_modules(Option<Vec::<ModuleConfiguration>>):

    The configuration of pending flow modules.

  • attributes(Option<LinkAttributes>):

    Attributes of the link.

  • link_id(String):

    The unique identifier of the link.

• On failure, responds with SdkError<RejectLinkError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the resource that you want to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    A map of the key-value pairs of the tag or tags to assign to the resource.

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the resource that you want to untag.

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

    The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

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

impl Client

pub fn update_link(&self) -> UpdateLinkFluentBuilder

Constructs a fluent builder for the UpdateLink operation.

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

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
  • log_settings(LinkLogSettings) / set_log_settings(Option<LinkLogSettings>):
    required: false
    

    Settings for the application logs.

    
    
• On success, responds with UpdateLinkOutput with field(s):
  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the request.

• On failure, responds with SdkError<UpdateLinkError>

impl Client

pub fn update_link_module_flow(&self) -> UpdateLinkModuleFlowFluentBuilder

Constructs a fluent builder for the UpdateLinkModuleFlow operation.

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

    The unique client token.

    
    
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The unique identifier of the gateway.

    
    
  • link_id(impl Into<String>) / set_link_id(Option<String>):
    required: true
    

    The unique identifier of the link.

    
    
  • modules(ModuleConfiguration) / set_modules(Option<Vec::<ModuleConfiguration>>):
    required: true
    

    The configuration of a module.

    
    
• On success, responds with UpdateLinkModuleFlowOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • link_id(String):

    The unique identifier of the link.

  • status(LinkStatus):

    The status of the request.

• On failure, responds with SdkError<UpdateLinkModuleFlowError>

impl Client

pub fn update_requester_gateway(&self) -> UpdateRequesterGatewayFluentBuilder

Constructs a fluent builder for the UpdateRequesterGateway operation.

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

    The unique client token.

    
    
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The unique identifier of the gateway.

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

    An optional description for the requester gateway.

    
    
• On success, responds with UpdateRequesterGatewayOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • status(RequesterGatewayStatus):

    The status of the request.

• On failure, responds with SdkError<UpdateRequesterGatewayError>

impl Client

pub fn update_responder_gateway(&self) -> UpdateResponderGatewayFluentBuilder

Constructs a fluent builder for the UpdateResponderGateway operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: false
    

    The domain name for the responder gateway.

    
    
  • port(i32) / set_port(Option<i32>):
    required: true
    

    The networking port to use.

    
    
  • protocol(Protocol) / set_protocol(Option<Protocol>):
    required: true
    

    The networking protocol to use.

    
    
  • trust_store_configuration(TrustStoreConfiguration) / set_trust_store_configuration(Option<TrustStoreConfiguration>):
    required: false
    

    The configuration of the trust store.

    
    
  • managed_endpoint_configuration(ManagedEndpointConfiguration) / set_managed_endpoint_configuration(Option<ManagedEndpointConfiguration>):
    required: false
    

    The configuration for the managed endpoint.

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

    The unique client token.

    
    
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The unique identifier of the gateway.

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

    An optional description for the responder gateway.

    
    
• On success, responds with UpdateResponderGatewayOutput with field(s):
  • gateway_id(String):

    The unique identifier of the gateway.

  • status(ResponderGatewayStatus):

    The status of the request.

• On failure, responds with SdkError<UpdateResponderGatewayError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

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

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

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

Creates a new client from an SDK Config.

Panics

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_inbound_external_link_active( &self, ) -> InboundExternalLinkActiveFluentBuilder

Wait for inbound_external_link_active

fn wait_until_link_accepted(&self) -> LinkAcceptedFluentBuilder

Wait for link_accepted

fn wait_until_link_active(&self) -> LinkActiveFluentBuilder

Wait for link_active

fn wait_until_outbound_external_link_active( &self, ) -> OutboundExternalLinkActiveFluentBuilder

Wait for outbound_external_link_active

fn wait_until_requester_gateway_active( &self, ) -> RequesterGatewayActiveFluentBuilder

Wait for requester_gateway_active

fn wait_until_requester_gateway_deleted( &self, ) -> RequesterGatewayDeletedFluentBuilder

Wait for requester_gateway_deleted

fn wait_until_responder_gateway_active( &self, ) -> ResponderGatewayActiveFluentBuilder

Wait for responder_gateway_active

fn wait_until_responder_gateway_deleted( &self, ) -> ResponderGatewayDeletedFluentBuilder

Wait for responder_gateway_deleted