Struct aws_sdk_networkmanager::Client

source ·
pub struct Client { /* private fields */ }
Expand description

Client for AWS Network Manager

Client for invoking operations on AWS Network Manager. Each operation on AWS Network Manager 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_networkmanager::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 Config 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_networkmanager::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 AcceptAttachment operation has a Client::accept_attachment, 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_attachment()
    .attachment_id("example")
    .send()
    .await;

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

Implementations§

source§

impl Client

source

pub fn accept_attachment(&self) -> AcceptAttachmentFluentBuilder

Constructs a fluent builder for the AcceptAttachment operation.

source§

impl Client

source

pub fn associate_connect_peer(&self) -> AssociateConnectPeerFluentBuilder

Constructs a fluent builder for the AssociateConnectPeer operation.

source§

impl Client

source

pub fn associate_customer_gateway( &self ) -> AssociateCustomerGatewayFluentBuilder

Constructs a fluent builder for the AssociateCustomerGateway operation.

source§

impl Client

Constructs a fluent builder for the AssociateLink operation.

source§

impl Client

source

pub fn associate_transit_gateway_connect_peer( &self ) -> AssociateTransitGatewayConnectPeerFluentBuilder

Constructs a fluent builder for the AssociateTransitGatewayConnectPeer operation.

source§

impl Client

source

pub fn create_connect_attachment(&self) -> CreateConnectAttachmentFluentBuilder

Constructs a fluent builder for the CreateConnectAttachment operation.

source§

impl Client

source

pub fn create_connect_peer(&self) -> CreateConnectPeerFluentBuilder

Constructs a fluent builder for the CreateConnectPeer operation.

source§

impl Client

source

pub fn create_connection(&self) -> CreateConnectionFluentBuilder

Constructs a fluent builder for the CreateConnection operation.

source§

impl Client

source

pub fn create_core_network(&self) -> CreateCoreNetworkFluentBuilder

Constructs a fluent builder for the CreateCoreNetwork operation.

source§

impl Client

source

pub fn create_device(&self) -> CreateDeviceFluentBuilder

Constructs a fluent builder for the CreateDevice operation.

source§

impl Client

source

pub fn create_global_network(&self) -> CreateGlobalNetworkFluentBuilder

Constructs a fluent builder for the CreateGlobalNetwork operation.

source§

impl Client

Constructs a fluent builder for the CreateLink operation.

source§

impl Client

source

pub fn create_site(&self) -> CreateSiteFluentBuilder

Constructs a fluent builder for the CreateSite operation.

source§

impl Client

source

pub fn create_site_to_site_vpn_attachment( &self ) -> CreateSiteToSiteVpnAttachmentFluentBuilder

Constructs a fluent builder for the CreateSiteToSiteVpnAttachment operation.

source§

impl Client

source

pub fn create_transit_gateway_peering( &self ) -> CreateTransitGatewayPeeringFluentBuilder

Constructs a fluent builder for the CreateTransitGatewayPeering operation.

source§

impl Client

source

pub fn create_transit_gateway_route_table_attachment( &self ) -> CreateTransitGatewayRouteTableAttachmentFluentBuilder

Constructs a fluent builder for the CreateTransitGatewayRouteTableAttachment operation.

source§

impl Client

source

pub fn create_vpc_attachment(&self) -> CreateVpcAttachmentFluentBuilder

Constructs a fluent builder for the CreateVpcAttachment operation.

source§

impl Client

source

pub fn delete_attachment(&self) -> DeleteAttachmentFluentBuilder

Constructs a fluent builder for the DeleteAttachment operation.

source§

impl Client

source

pub fn delete_connect_peer(&self) -> DeleteConnectPeerFluentBuilder

Constructs a fluent builder for the DeleteConnectPeer operation.

source§

impl Client

source

pub fn delete_connection(&self) -> DeleteConnectionFluentBuilder

Constructs a fluent builder for the DeleteConnection operation.

source§

impl Client

source

pub fn delete_core_network(&self) -> DeleteCoreNetworkFluentBuilder

Constructs a fluent builder for the DeleteCoreNetwork operation.

source§

impl Client

source

pub fn delete_core_network_policy_version( &self ) -> DeleteCoreNetworkPolicyVersionFluentBuilder

Constructs a fluent builder for the DeleteCoreNetworkPolicyVersion operation.

source§

impl Client

source

pub fn delete_device(&self) -> DeleteDeviceFluentBuilder

Constructs a fluent builder for the DeleteDevice operation.

source§

impl Client

source

pub fn delete_global_network(&self) -> DeleteGlobalNetworkFluentBuilder

Constructs a fluent builder for the DeleteGlobalNetwork operation.

source§

impl Client

Constructs a fluent builder for the DeleteLink operation.

source§

impl Client

source

pub fn delete_peering(&self) -> DeletePeeringFluentBuilder

Constructs a fluent builder for the DeletePeering operation.

source§

impl Client

source

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

source§

impl Client

source

pub fn delete_site(&self) -> DeleteSiteFluentBuilder

Constructs a fluent builder for the DeleteSite operation.

source§

impl Client

source

pub fn deregister_transit_gateway( &self ) -> DeregisterTransitGatewayFluentBuilder

Constructs a fluent builder for the DeregisterTransitGateway operation.

source§

impl Client

source

pub fn describe_global_networks(&self) -> DescribeGlobalNetworksFluentBuilder

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

source§

impl Client

source

pub fn disassociate_connect_peer(&self) -> DisassociateConnectPeerFluentBuilder

Constructs a fluent builder for the DisassociateConnectPeer operation.

source§

impl Client

source

pub fn disassociate_customer_gateway( &self ) -> DisassociateCustomerGatewayFluentBuilder

Constructs a fluent builder for the DisassociateCustomerGateway operation.

source§

impl Client

Constructs a fluent builder for the DisassociateLink operation.

source§

impl Client

source

pub fn disassociate_transit_gateway_connect_peer( &self ) -> DisassociateTransitGatewayConnectPeerFluentBuilder

Constructs a fluent builder for the DisassociateTransitGatewayConnectPeer operation.

source§

impl Client

source

pub fn execute_core_network_change_set( &self ) -> ExecuteCoreNetworkChangeSetFluentBuilder

Constructs a fluent builder for the ExecuteCoreNetworkChangeSet operation.

source§

impl Client

source

pub fn get_connect_attachment(&self) -> GetConnectAttachmentFluentBuilder

Constructs a fluent builder for the GetConnectAttachment operation.

source§

impl Client

source

pub fn get_connect_peer(&self) -> GetConnectPeerFluentBuilder

Constructs a fluent builder for the GetConnectPeer operation.

source§

impl Client

source

pub fn get_connect_peer_associations( &self ) -> GetConnectPeerAssociationsFluentBuilder

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

source§

impl Client

source

pub fn get_connections(&self) -> GetConnectionsFluentBuilder

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

source§

impl Client

source

pub fn get_core_network(&self) -> GetCoreNetworkFluentBuilder

Constructs a fluent builder for the GetCoreNetwork operation.

source§

impl Client

source

pub fn get_core_network_change_events( &self ) -> GetCoreNetworkChangeEventsFluentBuilder

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

source§

impl Client

source

pub fn get_core_network_change_set( &self ) -> GetCoreNetworkChangeSetFluentBuilder

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

source§

impl Client

source

pub fn get_core_network_policy(&self) -> GetCoreNetworkPolicyFluentBuilder

Constructs a fluent builder for the GetCoreNetworkPolicy operation.

source§

impl Client

source

pub fn get_customer_gateway_associations( &self ) -> GetCustomerGatewayAssociationsFluentBuilder

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

source§

impl Client

source

pub fn get_devices(&self) -> GetDevicesFluentBuilder

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

source§

impl Client

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

source§

impl Client

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

source§

impl Client

source

pub fn get_network_resource_counts( &self ) -> GetNetworkResourceCountsFluentBuilder

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

source§

impl Client

source

pub fn get_network_resource_relationships( &self ) -> GetNetworkResourceRelationshipsFluentBuilder

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

source§

impl Client

source

pub fn get_network_resources(&self) -> GetNetworkResourcesFluentBuilder

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

source§

impl Client

source

pub fn get_network_routes(&self) -> GetNetworkRoutesFluentBuilder

Constructs a fluent builder for the GetNetworkRoutes operation.

source§

impl Client

source

pub fn get_network_telemetry(&self) -> GetNetworkTelemetryFluentBuilder

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

source§

impl Client

source

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

source§

impl Client

source

pub fn get_route_analysis(&self) -> GetRouteAnalysisFluentBuilder

Constructs a fluent builder for the GetRouteAnalysis operation.

source§

impl Client

source

pub fn get_site_to_site_vpn_attachment( &self ) -> GetSiteToSiteVpnAttachmentFluentBuilder

Constructs a fluent builder for the GetSiteToSiteVpnAttachment operation.

source§

impl Client

source

pub fn get_sites(&self) -> GetSitesFluentBuilder

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

source§

impl Client

source

pub fn get_transit_gateway_connect_peer_associations( &self ) -> GetTransitGatewayConnectPeerAssociationsFluentBuilder

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

source§

impl Client

source

pub fn get_transit_gateway_peering( &self ) -> GetTransitGatewayPeeringFluentBuilder

Constructs a fluent builder for the GetTransitGatewayPeering operation.

source§

impl Client

source

pub fn get_transit_gateway_registrations( &self ) -> GetTransitGatewayRegistrationsFluentBuilder

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

source§

impl Client

source

pub fn get_transit_gateway_route_table_attachment( &self ) -> GetTransitGatewayRouteTableAttachmentFluentBuilder

Constructs a fluent builder for the GetTransitGatewayRouteTableAttachment operation.

source§

impl Client

source

pub fn get_vpc_attachment(&self) -> GetVpcAttachmentFluentBuilder

Constructs a fluent builder for the GetVpcAttachment operation.

source§

impl Client

source

pub fn list_attachments(&self) -> ListAttachmentsFluentBuilder

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

source§

impl Client

source

pub fn list_connect_peers(&self) -> ListConnectPeersFluentBuilder

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

source§

impl Client

source

pub fn list_core_network_policy_versions( &self ) -> ListCoreNetworkPolicyVersionsFluentBuilder

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

source§

impl Client

source

pub fn list_core_networks(&self) -> ListCoreNetworksFluentBuilder

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

source§

impl Client

source

pub fn list_organization_service_access_status( &self ) -> ListOrganizationServiceAccessStatusFluentBuilder

Constructs a fluent builder for the ListOrganizationServiceAccessStatus operation.

source§

impl Client

source

pub fn list_peerings(&self) -> ListPeeringsFluentBuilder

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

source§

impl Client

source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

source§

impl Client

source

pub fn put_core_network_policy(&self) -> PutCoreNetworkPolicyFluentBuilder

Constructs a fluent builder for the PutCoreNetworkPolicy operation.

source§

impl Client

source

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

source§

impl Client

source

pub fn register_transit_gateway(&self) -> RegisterTransitGatewayFluentBuilder

Constructs a fluent builder for the RegisterTransitGateway operation.

source§

impl Client

source

pub fn reject_attachment(&self) -> RejectAttachmentFluentBuilder

Constructs a fluent builder for the RejectAttachment operation.

source§

impl Client

source

pub fn restore_core_network_policy_version( &self ) -> RestoreCoreNetworkPolicyVersionFluentBuilder

Constructs a fluent builder for the RestoreCoreNetworkPolicyVersion operation.

source§

impl Client

source

pub fn start_organization_service_access_update( &self ) -> StartOrganizationServiceAccessUpdateFluentBuilder

Constructs a fluent builder for the StartOrganizationServiceAccessUpdate operation.

source§

impl Client

source

pub fn start_route_analysis(&self) -> StartRouteAnalysisFluentBuilder

Constructs a fluent builder for the StartRouteAnalysis operation.

source§

impl Client

source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

source§

impl Client

source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

source§

impl Client

source

pub fn update_connection(&self) -> UpdateConnectionFluentBuilder

Constructs a fluent builder for the UpdateConnection operation.

source§

impl Client

source

pub fn update_core_network(&self) -> UpdateCoreNetworkFluentBuilder

Constructs a fluent builder for the UpdateCoreNetwork operation.

source§

impl Client

source

pub fn update_device(&self) -> UpdateDeviceFluentBuilder

Constructs a fluent builder for the UpdateDevice operation.

source§

impl Client

source

pub fn update_global_network(&self) -> UpdateGlobalNetworkFluentBuilder

Constructs a fluent builder for the UpdateGlobalNetwork operation.

source§

impl Client

Constructs a fluent builder for the UpdateLink operation.

source§

impl Client

source

pub fn update_network_resource_metadata( &self ) -> UpdateNetworkResourceMetadataFluentBuilder

Constructs a fluent builder for the UpdateNetworkResourceMetadata operation.

source§

impl Client

source

pub fn update_site(&self) -> UpdateSiteFluentBuilder

Constructs a fluent builder for the UpdateSite operation.

source§

impl Client

source

pub fn update_vpc_attachment(&self) -> UpdateVpcAttachmentFluentBuilder

Constructs a fluent builder for the UpdateVpcAttachment operation.

source§

impl Client

source

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.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

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§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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