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 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_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
impl Client
Sourcepub fn associate_configuration_items_to_application(
&self,
) -> AssociateConfigurationItemsToApplicationFluentBuilder
pub fn associate_configuration_items_to_application( &self, ) -> AssociateConfigurationItemsToApplicationFluentBuilder
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>)
:
required: trueThe configuration ID of an application with which items are to be associated.
configuration_ids(impl Into<String>)
/set_configuration_ids(Option<Vec::<String>>)
:
required: trueThe ID of each configuration item to be associated with an application.
- On success, responds with
AssociateConfigurationItemsToApplicationOutput
- On failure, responds with
SdkError<AssociateConfigurationItemsToApplicationError>
Source§impl Client
impl Client
Sourcepub fn batch_delete_agents(&self) -> BatchDeleteAgentsFluentBuilder
pub fn batch_delete_agents(&self) -> BatchDeleteAgentsFluentBuilder
Constructs a fluent builder for the BatchDeleteAgents
operation.
- The fluent builder is configurable:
delete_agents(DeleteAgent)
/set_delete_agents(Option<Vec::<DeleteAgent>>)
:
required: trueThe list of agents to delete.
- On success, responds with
BatchDeleteAgentsOutput
with field(s):errors(Option<Vec::<BatchDeleteAgentError>>)
:A list of agent IDs that failed to delete during the deletion task, each paired with an error message.
- On failure, responds with
SdkError<BatchDeleteAgentsError>
Source§impl Client
impl Client
Sourcepub fn batch_delete_import_data(&self) -> BatchDeleteImportDataFluentBuilder
pub fn batch_delete_import_data(&self) -> BatchDeleteImportDataFluentBuilder
Constructs a fluent builder for the BatchDeleteImportData
operation.
- The fluent builder is configurable:
import_task_ids(impl Into<String>)
/set_import_task_ids(Option<Vec::<String>>)
:
required: trueThe IDs for the import tasks that you want to delete.
delete_history(bool)
/set_delete_history(Option<bool>)
:
required: falseSet to
true
to remove the deleted import task fromDescribeImportTasks
.
- 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>
Source§impl Client
impl Client
Sourcepub fn create_application(&self) -> CreateApplicationFluentBuilder
pub fn create_application(&self) -> CreateApplicationFluentBuilder
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the application to be created.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the application to be created.
wave(impl Into<String>)
/set_wave(Option<String>)
:
required: falseThe name of the migration wave of the application to be created.
- On success, responds with
CreateApplicationOutput
with field(s):configuration_id(Option<String>)
:The configuration ID of an application to be created.
- On failure, responds with
SdkError<CreateApplicationError>
Source§impl Client
impl Client
Constructs a fluent builder for the CreateTags
operation.
- The fluent builder is configurable:
configuration_ids(impl Into<String>)
/set_configuration_ids(Option<Vec::<String>>)
:
required: trueA list of configuration items that you want to tag.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueTags 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>
Source§impl Client
impl Client
Sourcepub fn delete_applications(&self) -> DeleteApplicationsFluentBuilder
pub fn delete_applications(&self) -> DeleteApplicationsFluentBuilder
Constructs a fluent builder for the DeleteApplications
operation.
- The fluent builder is configurable:
configuration_ids(impl Into<String>)
/set_configuration_ids(Option<Vec::<String>>)
:
required: trueConfiguration ID of an application to be deleted.
- On success, responds with
DeleteApplicationsOutput
- On failure, responds with
SdkError<DeleteApplicationsError>
Source§impl Client
impl Client
Constructs a fluent builder for the DeleteTags
operation.
- The fluent builder is configurable:
configuration_ids(impl Into<String>)
/set_configuration_ids(Option<Vec::<String>>)
:
required: trueA list of configuration items with tags that you want to delete.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseTags 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>
Source§impl Client
impl Client
Sourcepub fn describe_agents(&self) -> DescribeAgentsFluentBuilder
pub fn describe_agents(&self) -> DescribeAgentsFluentBuilder
Constructs a fluent builder for the DescribeAgents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
agent_ids(impl Into<String>)
/set_agent_ids(Option<Vec::<String>>)
:
required: falseThe agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseYou 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(Option<i32>)
:
required: falseThe total number of agents/collectors to return in a single page of output. The maximum value is 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseToken to retrieve the next set of results. For example, if you previously specified 100 IDs for
DescribeAgentsRequest$agentIds
but setDescribeAgentsRequest$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 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 setDescribeAgentsRequest$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
impl Client
Sourcepub fn describe_batch_delete_configuration_task(
&self,
) -> DescribeBatchDeleteConfigurationTaskFluentBuilder
pub fn describe_batch_delete_configuration_task( &self, ) -> DescribeBatchDeleteConfigurationTaskFluentBuilder
Constructs a fluent builder for the DescribeBatchDeleteConfigurationTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
:
required: trueThe ID of the task to delete.
- On success, responds with
DescribeBatchDeleteConfigurationTaskOutput
with field(s):task(Option<BatchDeleteConfigurationTask>)
:The
BatchDeleteConfigurationTask
that represents the deletion task being executed.
- On failure, responds with
SdkError<DescribeBatchDeleteConfigurationTaskError>
Source§impl Client
impl Client
Sourcepub fn describe_configurations(&self) -> DescribeConfigurationsFluentBuilder
pub fn describe_configurations(&self) -> DescribeConfigurationsFluentBuilder
Constructs a fluent builder for the DescribeConfigurations
operation.
- The fluent builder is configurable:
configuration_ids(impl Into<String>)
/set_configuration_ids(Option<Vec::<String>>)
:
required: trueOne 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>
Source§impl Client
impl Client
Sourcepub fn describe_continuous_exports(
&self,
) -> DescribeContinuousExportsFluentBuilder
pub fn describe_continuous_exports( &self, ) -> DescribeContinuousExportsFluentBuilder
Constructs a fluent builder for the DescribeContinuousExports
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
export_ids(impl Into<String>)
/set_export_ids(Option<Vec::<String>>)
:
required: falseThe unique IDs assigned to the exports.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_export_configurations(
&self,
) -> DescribeExportConfigurationsFluentBuilder
👎Deprecated
pub fn describe_export_configurations( &self, ) -> DescribeExportConfigurationsFluentBuilder
Constructs a fluent builder for the DescribeExportConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
export_ids(impl Into<String>)
/set_export_ids(Option<Vec::<String>>)
:
required: falseA list of continuous export IDs to search for.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_export_tasks(&self) -> DescribeExportTasksFluentBuilder
pub fn describe_export_tasks(&self) -> DescribeExportTasksFluentBuilder
Constructs a fluent builder for the DescribeExportTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
export_ids(impl Into<String>)
/set_export_ids(Option<Vec::<String>>)
:
required: falseOne or more unique identifiers used to query the status of an export request.
filters(ExportFilter)
/set_filters(Option<Vec::<ExportFilter>>)
:
required: falseOne or more filters.
-
AgentId
- ID of the agent whose collected data will be exported
-
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of volume results returned by
DescribeExportTasks
in paginated output. When this parameter is used,DescribeExportTasks
only returnsmaxResults
results in a single page along with anextToken
response element.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
value returned from a previous paginatedDescribeExportTasks
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
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 futureDescribeExportTasks
request. When the results of aDescribeExportTasks
request exceedmaxResults
, 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>
Source§impl Client
impl Client
Sourcepub fn describe_import_tasks(&self) -> DescribeImportTasksFluentBuilder
pub fn describe_import_tasks(&self) -> DescribeImportTasksFluentBuilder
Constructs a fluent builder for the DescribeImportTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(ImportTaskFilter)
/set_filters(Option<Vec::<ImportTaskFilter>>)
:
required: falseAn 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>)
:
required: falseThe maximum number of results that you want this request to return, up to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Constructs a fluent builder for the DescribeTags
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(TagFilter)
/set_filters(Option<Vec::<TagFilter>>)
:
required: falseYou can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include
tagKey
,tagValue
, andconfigurationId
.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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>)
:
required: falseA 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>
Source§impl Client
impl Client
Sourcepub fn disassociate_configuration_items_from_application(
&self,
) -> DisassociateConfigurationItemsFromApplicationFluentBuilder
pub fn disassociate_configuration_items_from_application( &self, ) -> DisassociateConfigurationItemsFromApplicationFluentBuilder
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>)
:
required: trueConfiguration ID of an application from which each item is disassociated.
configuration_ids(impl Into<String>)
/set_configuration_ids(Option<Vec::<String>>)
:
required: trueConfiguration ID of each item to be disassociated from an application.
- On success, responds with
DisassociateConfigurationItemsFromApplicationOutput
- On failure, responds with
SdkError<DisassociateConfigurationItemsFromApplicationError>
Source§impl Client
impl Client
Sourcepub fn export_configurations(&self) -> ExportConfigurationsFluentBuilder
👎Deprecated
pub fn export_configurations(&self) -> ExportConfigurationsFluentBuilder
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>
Source§impl Client
impl Client
Sourcepub fn get_discovery_summary(&self) -> GetDiscoverySummaryFluentBuilder
pub fn get_discovery_summary(&self) -> GetDiscoverySummaryFluentBuilder
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>)
:Details about Agentless Collector collectors, including status.
- On failure, responds with
SdkError<GetDiscoverySummaryError>
Source§impl Client
impl Client
Sourcepub fn list_configurations(&self) -> ListConfigurationsFluentBuilder
pub fn list_configurations(&self) -> ListConfigurationsFluentBuilder
Constructs a fluent builder for the ListConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_type(ConfigurationItemType)
/set_configuration_type(Option<ConfigurationItemType>)
:
required: trueA valid configuration identified by Application Discovery Service.
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseYou 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(Option<i32>)
:
required: falseThe total number of items to return. The maximum value is 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseToken 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(OrderByElement)
/set_order_by(Option<Vec::<OrderByElement>>)
:
required: falseCertain 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>
Source§impl Client
impl Client
Sourcepub fn list_server_neighbors(&self) -> ListServerNeighborsFluentBuilder
pub fn list_server_neighbors(&self) -> ListServerNeighborsFluentBuilder
Constructs a fluent builder for the ListServerNeighbors
operation.
- The fluent builder is configurable:
configuration_id(impl Into<String>)
/set_configuration_id(Option<String>)
:
required: trueConfiguration ID of the server for which neighbors are being listed.
port_information_needed(bool)
/set_port_information_needed(Option<bool>)
:
required: falseFlag to indicate if port and protocol information is needed as part of the response.
neighbor_configuration_ids(impl Into<String>)
/set_neighbor_configuration_ids(Option<Vec::<String>>)
:
required: falseList of configuration IDs to test for one-hop-away.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of results to return in a single page of output.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseToken to retrieve the next set of results. For example, if you previously specified 100 IDs for
ListServerNeighborsRequest$neighborConfigurationIds
but setListServerNeighborsRequest$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(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 setListServerNeighborsRequest$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>
Source§impl Client
impl Client
Sourcepub fn start_batch_delete_configuration_task(
&self,
) -> StartBatchDeleteConfigurationTaskFluentBuilder
pub fn start_batch_delete_configuration_task( &self, ) -> StartBatchDeleteConfigurationTaskFluentBuilder
Constructs a fluent builder for the StartBatchDeleteConfigurationTask
operation.
- The fluent builder is configurable:
configuration_type(DeletionConfigurationItemType)
/set_configuration_type(Option<DeletionConfigurationItemType>)
:
required: trueThe type of configuration item to delete. Supported types are: SERVER.
configuration_ids(impl Into<String>)
/set_configuration_ids(Option<Vec::<String>>)
:
required: trueThe list of configuration IDs that will be deleted by the task.
- On success, responds with
StartBatchDeleteConfigurationTaskOutput
with field(s):task_id(Option<String>)
:The unique identifier associated with the newly started deletion task.
- On failure, responds with
SdkError<StartBatchDeleteConfigurationTaskError>
Source§impl Client
impl Client
Sourcepub fn start_continuous_export(&self) -> StartContinuousExportFluentBuilder
pub fn start_continuous_export(&self) -> StartContinuousExportFluentBuilder
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>
Source§impl Client
impl Client
Sourcepub fn start_data_collection_by_agent_ids(
&self,
) -> StartDataCollectionByAgentIdsFluentBuilder
pub fn start_data_collection_by_agent_ids( &self, ) -> StartDataCollectionByAgentIdsFluentBuilder
Constructs a fluent builder for the StartDataCollectionByAgentIds
operation.
- The fluent builder is configurable:
agent_ids(impl Into<String>)
/set_agent_ids(Option<Vec::<String>>)
:
required: trueThe IDs of the agents from which to start collecting data. If you send a request to an agent 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 and you do not have permission to contact some of those agents, 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 that were instructed to start collecting data. Information includes the agent ID, a description of the operation performed, and whether the agent configuration was updated.
- On failure, responds with
SdkError<StartDataCollectionByAgentIdsError>
Source§impl Client
impl Client
Sourcepub fn start_export_task(&self) -> StartExportTaskFluentBuilder
pub fn start_export_task(&self) -> StartExportTaskFluentBuilder
Constructs a fluent builder for the StartExportTask
operation.
- The fluent builder is configurable:
export_data_format(ExportDataFormat)
/set_export_data_format(Option<Vec::<ExportDataFormat>>)
:
required: falseThe file format for the returned export data. Default value is
CSV
. Note: TheGRAPHML
option has been deprecated.filters(ExportFilter)
/set_filters(Option<Vec::<ExportFilter>>)
:
required: falseIf a filter is present, it selects the single
agentId
of the Application Discovery Agent for which data is exported. TheagentId
can be found in the results of theDescribeAgents
API or CLI. If no filter is present,startTime
andendTime
are ignored and exported data includes both Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents.start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe 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>)
:
required: falseThe 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.
preferences(ExportPreferences)
/set_preferences(Option<ExportPreferences>)
:
required: falseIndicates the type of data that needs to be exported. Only one ExportPreferences can be enabled at any time.
- 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>
Source§impl Client
impl Client
Sourcepub fn start_import_task(&self) -> StartImportTaskFluentBuilder
pub fn start_import_task(&self) -> StartImportTaskFluentBuilder
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>)
:
required: falseOptional. 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>)
:
required: trueA 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>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn stop_continuous_export(&self) -> StopContinuousExportFluentBuilder
pub fn stop_continuous_export(&self) -> StopContinuousExportFluentBuilder
Constructs a fluent builder for the StopContinuousExport
operation.
- The fluent builder is configurable:
export_id(impl Into<String>)
/set_export_id(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn stop_data_collection_by_agent_ids(
&self,
) -> StopDataCollectionByAgentIdsFluentBuilder
pub fn stop_data_collection_by_agent_ids( &self, ) -> StopDataCollectionByAgentIdsFluentBuilder
Constructs a fluent builder for the StopDataCollectionByAgentIds
operation.
- The fluent builder is configurable:
agent_ids(impl Into<String>)
/set_agent_ids(Option<Vec::<String>>)
:
required: trueThe IDs of the agents from which to stop collecting data.
- On success, responds with
StopDataCollectionByAgentIdsOutput
with field(s):agents_configuration_status(Option<Vec::<AgentConfigurationStatus>>)
:Information about the agents that were instructed to stop collecting data. Information includes the agent ID, a description of the operation performed, and whether the agent configuration was updated.
- On failure, responds with
SdkError<StopDataCollectionByAgentIdsError>
Source§impl Client
impl Client
Sourcepub fn update_application(&self) -> UpdateApplicationFluentBuilder
pub fn update_application(&self) -> UpdateApplicationFluentBuilder
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
configuration_id(impl Into<String>)
/set_configuration_id(Option<String>)
:
required: trueConfiguration ID of the application to be updated.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseNew name of the application to be updated.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseNew description of the application to be updated.
wave(impl Into<String>)
/set_wave(Option<String>)
:
required: falseThe new migration wave of the application that you want to update.
- On success, responds with
UpdateApplicationOutput
- On failure, responds with
SdkError<UpdateApplicationError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);