Struct aws_sdk_appfabric::client::Client

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

Client for AppFabric

Client for invoking operations on AppFabric. Each operation on AppFabric 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_appfabric::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_appfabric::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 BatchGetUserAccessTasks operation has a Client::batch_get_user_access_tasks, 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.batch_get_user_access_tasks()
    .app_bundle_identifier("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 batch_get_user_access_tasks( &self ) -> BatchGetUserAccessTasksFluentBuilder

Constructs a fluent builder for the BatchGetUserAccessTasks operation.

source§

impl Client

source

pub fn connect_app_authorization(&self) -> ConnectAppAuthorizationFluentBuilder

Constructs a fluent builder for the ConnectAppAuthorization operation.

source§

impl Client

source

pub fn create_app_authorization(&self) -> CreateAppAuthorizationFluentBuilder

Constructs a fluent builder for the CreateAppAuthorization operation.

source§

impl Client

source

pub fn create_app_bundle(&self) -> CreateAppBundleFluentBuilder

Constructs a fluent builder for the CreateAppBundle operation.

source§

impl Client

source

pub fn create_ingestion(&self) -> CreateIngestionFluentBuilder

Constructs a fluent builder for the CreateIngestion operation.

source§

impl Client

source

pub fn create_ingestion_destination( &self ) -> CreateIngestionDestinationFluentBuilder

Constructs a fluent builder for the CreateIngestionDestination operation.

source§

impl Client

source

pub fn delete_app_authorization(&self) -> DeleteAppAuthorizationFluentBuilder

Constructs a fluent builder for the DeleteAppAuthorization operation.

source§

impl Client

source

pub fn delete_app_bundle(&self) -> DeleteAppBundleFluentBuilder

Constructs a fluent builder for the DeleteAppBundle operation.

source§

impl Client

source

pub fn delete_ingestion(&self) -> DeleteIngestionFluentBuilder

Constructs a fluent builder for the DeleteIngestion operation.

source§

impl Client

source

pub fn delete_ingestion_destination( &self ) -> DeleteIngestionDestinationFluentBuilder

Constructs a fluent builder for the DeleteIngestionDestination operation.

source§

impl Client

source

pub fn get_app_authorization(&self) -> GetAppAuthorizationFluentBuilder

Constructs a fluent builder for the GetAppAuthorization operation.

source§

impl Client

source

pub fn get_app_bundle(&self) -> GetAppBundleFluentBuilder

Constructs a fluent builder for the GetAppBundle operation.

source§

impl Client

source

pub fn get_ingestion(&self) -> GetIngestionFluentBuilder

Constructs a fluent builder for the GetIngestion operation.

source§

impl Client

source

pub fn get_ingestion_destination(&self) -> GetIngestionDestinationFluentBuilder

Constructs a fluent builder for the GetIngestionDestination operation.

source§

impl Client

source

pub fn list_app_authorizations(&self) -> ListAppAuthorizationsFluentBuilder

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

source§

impl Client

source

pub fn list_app_bundles(&self) -> ListAppBundlesFluentBuilder

Constructs a fluent builder for the ListAppBundles 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 ListAppBundlesOutput with field(s):
    • app_bundle_summary_list(Vec::<AppBundleSummary>):

      Contains a list of app bundle summaries.

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

impl Client

source

pub fn list_ingestion_destinations( &self ) -> ListIngestionDestinationsFluentBuilder

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

source§

impl Client

source

pub fn list_ingestions(&self) -> ListIngestionsFluentBuilder

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

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

      The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.


    • 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 ListIngestionsOutput with field(s):
    • ingestions(Vec::<IngestionSummary>):

      Contains a list of ingestion summaries.

    • 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<ListIngestionsError>
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 start_ingestion(&self) -> StartIngestionFluentBuilder

Constructs a fluent builder for the StartIngestion operation.

source§

impl Client

source

pub fn start_user_access_tasks(&self) -> StartUserAccessTasksFluentBuilder

Constructs a fluent builder for the StartUserAccessTasks operation.

source§

impl Client

source

pub fn stop_ingestion(&self) -> StopIngestionFluentBuilder

Constructs a fluent builder for the StopIngestion 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_app_authorization(&self) -> UpdateAppAuthorizationFluentBuilder

Constructs a fluent builder for the UpdateAppAuthorization operation.

source§

impl Client

source

pub fn update_ingestion_destination( &self ) -> UpdateIngestionDestinationFluentBuilder

Constructs a fluent builder for the UpdateIngestionDestination 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