Struct aws_sdk_applicationdiscovery::Client

pub struct Client { /* private fields */ }

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.

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_applicationdiscovery::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::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_applicationdiscovery::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_applicationdiscovery::Client::from_conf(config);

Implementations

impl Client

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

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn associate_configuration_items_to_application(
    &self
) -> AssociateConfigurationItemsToApplication

Constructs a fluent builder for the AssociateConfigurationItemsToApplication operation.

• The fluent builder is configurable:
  • application_configuration_id(impl Into<String>) / set_application_configuration_id(Option<String>):

    The configuration ID of an application with which items are to be associated.

  • configuration_ids(Vec<String>) / set_configuration_ids(Option<Vec<String>>):

    The ID of each configuration item to be associated with an application.

• On success, responds with AssociateConfigurationItemsToApplicationOutput
• On failure, responds with SdkError<AssociateConfigurationItemsToApplicationError>

pub fn batch_delete_import_data(&self) -> BatchDeleteImportData

Constructs a fluent builder for the BatchDeleteImportData operation.

• The fluent builder is configurable:
  • import_task_ids(Vec<String>) / set_import_task_ids(Option<Vec<String>>):

    The IDs for the import tasks that you want to delete.

• On success, responds with BatchDeleteImportDataOutput with field(s):
  • errors(Option<Vec<BatchDeleteImportDataError>>):

    Error messages returned for each import task that you deleted as a response for this command.

• On failure, responds with SdkError<BatchDeleteImportDataError>

pub fn create_application(&self) -> CreateApplication

Constructs a fluent builder for the CreateApplication operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    Name of the application to be created.

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

    Description of the application to be created.

• On success, responds with CreateApplicationOutput with field(s):
  • configuration_id(Option<String>):

    Configuration ID of an application to be created.

• On failure, responds with SdkError<CreateApplicationError>

pub fn create_tags(&self) -> CreateTags

Constructs a fluent builder for the CreateTags operation.

• The fluent builder is configurable:
  • configuration_ids(Vec<String>) / set_configuration_ids(Option<Vec<String>>):

    A list of configuration items that you want to tag.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example:

    {“key”: “serverType”, “value”: “webServer”}

• On success, responds with CreateTagsOutput
• On failure, responds with SdkError<CreateTagsError>

pub fn delete_applications(&self) -> DeleteApplications

Constructs a fluent builder for the DeleteApplications operation.

• The fluent builder is configurable:
  • configuration_ids(Vec<String>) / set_configuration_ids(Option<Vec<String>>):

    Configuration ID of an application to be deleted.

• On success, responds with DeleteApplicationsOutput
• On failure, responds with SdkError<DeleteApplicationsError>

pub fn delete_tags(&self) -> DeleteTags

Constructs a fluent builder for the DeleteTags operation.

• The fluent builder is configurable:
  • configuration_ids(Vec<String>) / set_configuration_ids(Option<Vec<String>>):

    A list of configuration items with tags that you want to delete.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a key-value format. For example:

    {“key”: “serverType”, “value”: “webServer”}

• On success, responds with DeleteTagsOutput
• On failure, responds with SdkError<DeleteTagsError>

pub fn describe_agents(&self) -> DescribeAgents

Constructs a fluent builder for the DescribeAgents operation.

• The fluent builder is configurable:
  • agent_ids(Vec<String>) / set_agent_ids(Option<Vec<String>>):

    The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your Amazon Web Services user account.

  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    You can filter the request using various logical operators and a key-value format. For example:

    {“key”: “collectionStatus”, “value”: “STARTED”}

  • max_results(i32) / set_max_results(i32):

    The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

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

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

• On success, responds with DescribeAgentsOutput with field(s):
  • agents_info(Option<Vec<AgentInfo>>):

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

  • 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>

pub fn describe_configurations(&self) -> DescribeConfigurations

Constructs a fluent builder for the DescribeConfigurations operation.

• The fluent builder is configurable:
  • configuration_ids(Vec<String>) / set_configuration_ids(Option<Vec<String>>):

    One or more configuration IDs.

• On success, responds with DescribeConfigurationsOutput with field(s):
  • configurations(Option<Vec<HashMap<String, String>>>):

    A key in the response map. The value is an array of data.

• On failure, responds with SdkError<DescribeConfigurationsError>

pub fn describe_continuous_exports(&self) -> DescribeContinuousExports

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

• The fluent builder is configurable:
  • export_ids(Vec<String>) / set_export_ids(Option<Vec<String>>):

    The unique IDs assigned to the exports.

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

    A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

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

    The token from the previous call to DescribeExportTasks.

• On success, responds with DescribeContinuousExportsOutput with field(s):
  • descriptions(Option<Vec<ContinuousExportDescription>>):

    A list of continuous export descriptions.

  • next_token(Option<String>):

    The token from the previous call to DescribeExportTasks.

• On failure, responds with SdkError<DescribeContinuousExportsError>

pub fn describe_export_configurations(&self) -> DescribeExportConfigurations

Constructs a fluent builder for the DescribeExportConfigurations operation.

• The fluent builder is configurable:
  • export_ids(Vec<String>) / set_export_ids(Option<Vec<String>>):

    A list of continuous export IDs to search for.

  • max_results(i32) / set_max_results(i32):

    A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

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

    The token from the previous call to describe-export-tasks.

• On success, responds with DescribeExportConfigurationsOutput with field(s):
  • exports_info(Option<Vec<ExportInfo>>):

  • next_token(Option<String>):

    The token from the previous call to describe-export-tasks.

• On failure, responds with SdkError<DescribeExportConfigurationsError>

pub fn describe_export_tasks(&self) -> DescribeExportTasks

Constructs a fluent builder for the DescribeExportTasks operation.

• The fluent builder is configurable:
  • export_ids(Vec<String>) / set_export_ids(Option<Vec<String>>):

    One or more unique identifiers used to query the status of an export request.

  • filters(Vec<ExportFilter>) / set_filters(Option<Vec<ExportFilter>>):

    One or more filters.

    • AgentId - ID of the agent whose collected data will be exported

  • max_results(i32) / set_max_results(i32):

    The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.

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

    The nextToken value returned from a previous paginated DescribeExportTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

• On success, responds with DescribeExportTasksOutput with field(s):
  • exports_info(Option<Vec<ExportInfo>>):

    Contains one or more sets of export request details. When the status of a request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.

  • next_token(Option<String>):

    The nextToken value to include in a future DescribeExportTasks request. When the results of a DescribeExportTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeExportTasksError>

pub fn describe_import_tasks(&self) -> DescribeImportTasks

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

• The fluent builder is configurable:
  • filters(Vec<ImportTaskFilter>) / set_filters(Option<Vec<ImportTaskFilter>>):

    An array of name-value pairs that you provide to filter the results for the DescribeImportTask request to a specific subset of results. Currently, wildcard values aren’t supported for filters.

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

    The maximum number of results that you want this request to return, up to 100.

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

    The token to request a specific page of results.

• On success, responds with DescribeImportTasksOutput with field(s):
  • next_token(Option<String>):

    The token to request the next page of results.

  • tasks(Option<Vec<ImportTask>>):

    A returned array of import tasks that match any applied filters, up to the specified number of maximum results.

• On failure, responds with SdkError<DescribeImportTasksError>

pub fn describe_tags(&self) -> DescribeTags

Constructs a fluent builder for the DescribeTags operation.

• The fluent builder is configurable:
  • filters(Vec<TagFilter>) / set_filters(Option<Vec<TagFilter>>):

    You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

  • max_results(i32) / set_max_results(i32):

    The total number of items to return in a single page of output. The maximum value is 100.

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

    A token to start the list. Use this token to get the next set of results.

• On success, responds with DescribeTagsOutput with field(s):
  • tags(Option<Vec<ConfigurationTag>>):

    Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

  • next_token(Option<String>):

    The call returns a token. Use this token to get the next set of results.

• On failure, responds with SdkError<DescribeTagsError>

pub fn disassociate_configuration_items_from_application(
    &self
) -> DisassociateConfigurationItemsFromApplication

Constructs a fluent builder for the DisassociateConfigurationItemsFromApplication operation.

• The fluent builder is configurable:
  • application_configuration_id(impl Into<String>) / set_application_configuration_id(Option<String>):

    Configuration ID of an application from which each item is disassociated.

  • configuration_ids(Vec<String>) / set_configuration_ids(Option<Vec<String>>):

    Configuration ID of each item to be disassociated from an application.

• On success, responds with DisassociateConfigurationItemsFromApplicationOutput
• On failure, responds with SdkError<DisassociateConfigurationItemsFromApplicationError>

pub fn export_configurations(&self) -> ExportConfigurations

Constructs a fluent builder for the ExportConfigurations operation.

• The fluent builder takes no input, just send it.
• On success, responds with ExportConfigurationsOutput with field(s):
  • export_id(Option<String>):

    A unique identifier that you can use to query the export status.

• On failure, responds with SdkError<ExportConfigurationsError>

pub fn get_discovery_summary(&self) -> GetDiscoverySummary

Constructs a fluent builder for the GetDiscoverySummary operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetDiscoverySummaryOutput with field(s):
  • servers(i64):

    The number of servers discovered.

  • applications(i64):

    The number of applications discovered.

  • servers_mapped_to_applications(i64):

    The number of servers mapped to applications.

  • servers_mappedto_tags(i64):

    The number of servers mapped to tags.

  • agent_summary(Option<CustomerAgentInfo>):

    Details about discovered agents, including agent status and health.

  • connector_summary(Option<CustomerConnectorInfo>):

    Details about discovered connectors, including connector status and health.

  • me_collector_summary(Option<CustomerMeCollectorInfo>):

    Details about Migration Evaluator collectors, including collector status and health.

  • agentless_collector_summary(Option<CustomerAgentlessCollectorInfo>): (undocumented)
• On failure, responds with SdkError<GetDiscoverySummaryError>

pub fn list_configurations(&self) -> ListConfigurations

Constructs a fluent builder for the ListConfigurations operation.

• The fluent builder is configurable:
  • configuration_type(ConfigurationItemType) / set_configuration_type(Option<ConfigurationItemType>):

    A valid configuration identified by Application Discovery Service.

  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    You can filter the request using various logical operators and a key-value format. For example:

    {“key”: “serverType”, “value”: “webServer”}

    For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

  • max_results(i32) / set_max_results(i32):

    The total number of items to return. The maximum value is 100.

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

    Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

  • order_by(Vec<OrderByElement>) / set_order_by(Option<Vec<OrderByElement>>):

    Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

• On success, responds with ListConfigurationsOutput with field(s):
  • configurations(Option<Vec<HashMap<String, String>>>):

    Returns configuration details, including the configuration ID, attribute names, and attribute values.

  • next_token(Option<String>):

    Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$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<ListConfigurationsError>

pub fn list_server_neighbors(&self) -> ListServerNeighbors

Constructs a fluent builder for the ListServerNeighbors operation.

• The fluent builder is configurable:
  • configuration_id(impl Into<String>) / set_configuration_id(Option<String>):

    Configuration ID of the server for which neighbors are being listed.

  • port_information_needed(bool) / set_port_information_needed(bool):

    Flag to indicate if port and protocol information is needed as part of the response.

  • neighbor_configuration_ids(Vec<String>) / set_neighbor_configuration_ids(Option<Vec<String>>):

    List of configuration IDs to test for one-hop-away.

  • max_results(i32) / set_max_results(i32):

    Maximum number of results to return in a single page of output.

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

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

• On success, responds with ListServerNeighborsOutput with field(s):
  • neighbors(Option<Vec<NeighborConnectionDetail>>):

    List of distinct servers that are one hop away from the given server.

  • next_token(Option<String>):

    Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$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.

  • known_dependency_count(i64):

    Count of distinct servers that are one hop away from the given server.

• On failure, responds with SdkError<ListServerNeighborsError>

pub fn start_continuous_export(&self) -> StartContinuousExport

Constructs a fluent builder for the StartContinuousExport operation.

• The fluent builder takes no input, just send it.
• On success, responds with StartContinuousExportOutput with field(s):
  • export_id(Option<String>):

    The unique ID assigned to this export.

  • s3_bucket(Option<String>):

    The name of the s3 bucket where the export data parquet files are stored.

  • start_time(Option<DateTime>):

    The timestamp representing when the continuous export was started.

  • data_source(Option<DataSource>):

    The type of data collector used to gather this data (currently only offered for AGENT).

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

    A dictionary which describes how the data is stored.

    • databaseName - the name of the Glue database used to store the schema.

• On failure, responds with SdkError<StartContinuousExportError>

pub fn start_data_collection_by_agent_ids(
    &self
) -> StartDataCollectionByAgentIds

Constructs a fluent builder for the StartDataCollectionByAgentIds operation.

• The fluent builder is configurable:
  • agent_ids(Vec<String>) / set_agent_ids(Option<Vec<String>>):

    The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your Amazon Web Services account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.

• On success, responds with StartDataCollectionByAgentIdsOutput with field(s):
  • agents_configuration_status(Option<Vec<AgentConfigurationStatus>>):

    Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

• On failure, responds with SdkError<StartDataCollectionByAgentIdsError>

pub fn start_export_task(&self) -> StartExportTask

Constructs a fluent builder for the StartExportTask operation.

• The fluent builder is configurable:
  • export_data_format(Vec<ExportDataFormat>) / set_export_data_format(Option<Vec<ExportDataFormat>>):

    The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

  • filters(Vec<ExportFilter>) / set_filters(Option<Vec<ExportFilter>>):

    If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.

  • start_time(DateTime) / set_start_time(Option<DateTime>):

    The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.

  • end_time(DateTime) / set_end_time(Option<DateTime>):

    The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

• On success, responds with StartExportTaskOutput with field(s):
  • export_id(Option<String>):

    A unique identifier used to query the status of an export request.

• On failure, responds with SdkError<StartExportTaskError>

pub fn start_import_task(&self) -> StartImportTask

Constructs a fluent builder for the StartImportTask operation.

• The fluent builder is configurable:
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):

    Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don’t provide a token, a token is automatically generated.

    Sending more than one StartImportTask request with the same client request token will return information about the original import task with that client request token.

  • name(impl Into<String>) / set_name(Option<String>):

    A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

  • import_url(impl Into<String>) / set_import_url(Option<String>):

    The URL for your import file that you’ve uploaded to Amazon S3.

    If you’re using the Amazon Web Services CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV

• On success, responds with StartImportTaskOutput with field(s):
  • task(Option<ImportTask>):

    An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

• On failure, responds with SdkError<StartImportTaskError>

pub fn stop_continuous_export(&self) -> StopContinuousExport

Constructs a fluent builder for the StopContinuousExport operation.

• The fluent builder is configurable:
  • export_id(impl Into<String>) / set_export_id(Option<String>):

    The unique ID assigned to this export.

• On success, responds with StopContinuousExportOutput with field(s):
  • start_time(Option<DateTime>):

    Timestamp that represents when this continuous export started collecting data.

  • stop_time(Option<DateTime>):

    Timestamp that represents when this continuous export was stopped.

• On failure, responds with SdkError<StopContinuousExportError>

pub fn stop_data_collection_by_agent_ids(&self) -> StopDataCollectionByAgentIds

Constructs a fluent builder for the StopDataCollectionByAgentIds operation.

• The fluent builder is configurable:
  • agent_ids(Vec<String>) / set_agent_ids(Option<Vec<String>>):

    The IDs of the agents or connectors from which to stop collecting data.

• On success, responds with StopDataCollectionByAgentIdsOutput with field(s):
  • agents_configuration_status(Option<Vec<AgentConfigurationStatus>>):

    Information about the agents or connector that were instructed to stop collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

• On failure, responds with SdkError<StopDataCollectionByAgentIdsError>

pub fn update_application(&self) -> UpdateApplication

Constructs a fluent builder for the UpdateApplication operation.

• The fluent builder is configurable:
  • configuration_id(impl Into<String>) / set_configuration_id(Option<String>):

    Configuration ID of the application to be updated.

  • name(impl Into<String>) / set_name(Option<String>):

    New name of the application to be updated.

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

    New description of the application to be updated.

• On success, responds with UpdateApplicationOutput
• On failure, responds with SdkError<UpdateApplicationError>

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.

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.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy 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 From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.