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

Client for AWS Application Discovery Service

Client for invoking operations on AWS Application Discovery Service. Each operation on AWS Application Discovery Service 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_applicationdiscovery::Client::new(&config);

Occasionally, SDKs may have additional service-specific 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_applicationdiscovery::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 AssociateConfigurationItemsToApplication operation has a Client::associate_configuration_items_to_application, 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.associate_configuration_items_to_application()
    .application_configuration_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 associate_configuration_items_to_application( &self ) -> AssociateConfigurationItemsToApplicationFluentBuilder

Constructs a fluent builder for the AssociateConfigurationItemsToApplication operation.

source§

impl Client

source

pub fn batch_delete_import_data(&self) -> BatchDeleteImportDataFluentBuilder

Constructs a fluent builder for the BatchDeleteImportData operation.

source§

impl Client

source

pub fn create_application(&self) -> CreateApplicationFluentBuilder

Constructs a fluent builder for the CreateApplication operation.

source§

impl Client

source

pub fn create_tags(&self) -> CreateTagsFluentBuilder

Constructs a fluent builder for the CreateTags operation.

source§

impl Client

source

pub fn delete_applications(&self) -> DeleteApplicationsFluentBuilder

Constructs a fluent builder for the DeleteApplications operation.

source§

impl Client

source

pub fn delete_tags(&self) -> DeleteTagsFluentBuilder

Constructs a fluent builder for the DeleteTags operation.

source§

impl Client

source

pub fn describe_agents(&self) -> DescribeAgentsFluentBuilder

Constructs a fluent builder for the DescribeAgents operation.

  • The fluent builder is configurable:
  • On success, responds with DescribeAgentsOutput with field(s):
    • agents_info(Option<Vec<AgentInfo>>):

      Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.

    • next_token(Option<String>):

      Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

  • On failure, responds with SdkError<DescribeAgentsError>
source§

impl Client

source

pub fn describe_configurations(&self) -> DescribeConfigurationsFluentBuilder

Constructs a fluent builder for the DescribeConfigurations operation.

source§

impl Client

source

pub fn describe_continuous_exports( &self ) -> DescribeContinuousExportsFluentBuilder

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

source§

impl Client

source

pub fn describe_export_configurations( &self ) -> DescribeExportConfigurationsFluentBuilder

👎Deprecated

Constructs a fluent builder for the DescribeExportConfigurations operation.

source§

impl Client

source

pub fn describe_export_tasks(&self) -> DescribeExportTasksFluentBuilder

Constructs a fluent builder for the DescribeExportTasks operation.

source§

impl Client

source

pub fn describe_import_tasks(&self) -> DescribeImportTasksFluentBuilder

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

source§

impl Client

source

pub fn describe_tags(&self) -> DescribeTagsFluentBuilder

Constructs a fluent builder for the DescribeTags operation.

source§

impl Client

source

pub fn disassociate_configuration_items_from_application( &self ) -> DisassociateConfigurationItemsFromApplicationFluentBuilder

Constructs a fluent builder for the DisassociateConfigurationItemsFromApplication operation.

source§

impl Client

source

pub fn export_configurations(&self) -> ExportConfigurationsFluentBuilder

👎Deprecated

Constructs a fluent builder for the ExportConfigurations operation.

source§

impl Client

source

pub fn get_discovery_summary(&self) -> GetDiscoverySummaryFluentBuilder

Constructs a fluent builder for the GetDiscoverySummary operation.

source§

impl Client

source

pub fn list_configurations(&self) -> ListConfigurationsFluentBuilder

Constructs a fluent builder for the ListConfigurations operation.

source§

impl Client

source

pub fn list_server_neighbors(&self) -> ListServerNeighborsFluentBuilder

Constructs a fluent builder for the ListServerNeighbors operation.

source§

impl Client

source

pub fn start_continuous_export(&self) -> StartContinuousExportFluentBuilder

Constructs a fluent builder for the StartContinuousExport operation.

source§

impl Client

source

pub fn start_data_collection_by_agent_ids( &self ) -> StartDataCollectionByAgentIdsFluentBuilder

Constructs a fluent builder for the StartDataCollectionByAgentIds operation.

source§

impl Client

source

pub fn start_export_task(&self) -> StartExportTaskFluentBuilder

Constructs a fluent builder for the StartExportTask operation.

source§

impl Client

source

pub fn start_import_task(&self) -> StartImportTaskFluentBuilder

Constructs a fluent builder for the StartImportTask operation.

source§

impl Client

source

pub fn stop_continuous_export(&self) -> StopContinuousExportFluentBuilder

Constructs a fluent builder for the StopContinuousExport operation.

source§

impl Client

source

pub fn stop_data_collection_by_agent_ids( &self ) -> StopDataCollectionByAgentIdsFluentBuilder

Constructs a fluent builder for the StopDataCollectionByAgentIds operation.

source§

impl Client

source

pub fn update_application(&self) -> UpdateApplicationFluentBuilder

Constructs a fluent builder for the UpdateApplication 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 if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
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.

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 !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 Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere 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 Twhere 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 Twhere 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