ApplicationDiscoveryServiceClient#
Index > ApplicationDiscoveryService > ApplicationDiscoveryServiceClient
Auto-generated documentation for ApplicationDiscoveryService type annotations stubs module types-aiobotocore-discovery.
ApplicationDiscoveryServiceClient#
Type annotations and code completion for session.client("discovery")
boto3 documentation
# ApplicationDiscoveryServiceClient usage example
from aioboto3.session import Session
from types_aiobotocore_discovery.client import ApplicationDiscoveryServiceClient
session = Session()
async with session.client("discovery") as client:
client: ApplicationDiscoveryServiceClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("discovery").exceptions
structure.
# ApplicationDiscoveryServiceClient.exceptions usage example
async with session.client("discovery") as client:
try:
do_something(client)
except (
client.exceptions.AuthorizationErrorException,
client.exceptions.ClientError,
client.exceptions.ConflictErrorException,
client.exceptions.HomeRegionNotSetException,
client.exceptions.InvalidParameterException,
client.exceptions.InvalidParameterValueException,
client.exceptions.LimitExceededException,
client.exceptions.OperationNotPermittedException,
client.exceptions.ResourceInUseException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServerInternalErrorException,
) as e:
print(e)
# ApplicationDiscoveryServiceClient.exceptions type checking example
from types_aiobotocore_discovery.client import Exceptions
def handle_error(exc: Exceptions.AuthorizationErrorException) -> None:
...
Methods#
associate_configuration_items_to_application#
Associates one or more configuration items with an application.
Type annotations and code completion for session.client("discovery").associate_configuration_items_to_application
method.
boto3 documentation
# associate_configuration_items_to_application method definition
await def associate_configuration_items_to_application(
self,
*,
applicationConfigurationId: str,
configurationIds: Sequence[str],
) -> Dict[str, Any]:
...
# associate_configuration_items_to_application method usage example with argument unpacking
kwargs: AssociateConfigurationItemsToApplicationRequestRequestTypeDef = { # (1)
"applicationConfigurationId": ...,
"configurationIds": ...,
}
parent.associate_configuration_items_to_application(**kwargs)
batch_delete_agents#
Deletes one or more agents or collectors as specified by ID.
Type annotations and code completion for session.client("discovery").batch_delete_agents
method.
boto3 documentation
# batch_delete_agents method definition
await def batch_delete_agents(
self,
*,
deleteAgents: Sequence[DeleteAgentTypeDef], # (1)
) -> BatchDeleteAgentsResponseTypeDef: # (2)
...
# batch_delete_agents method usage example with argument unpacking
kwargs: BatchDeleteAgentsRequestRequestTypeDef = { # (1)
"deleteAgents": ...,
}
parent.batch_delete_agents(**kwargs)
batch_delete_import_data#
Deletes one or more import tasks, each identified by their import ID.
Type annotations and code completion for session.client("discovery").batch_delete_import_data
method.
boto3 documentation
# batch_delete_import_data method definition
await def batch_delete_import_data(
self,
*,
importTaskIds: Sequence[str],
deleteHistory: bool = ...,
) -> BatchDeleteImportDataResponseTypeDef: # (1)
...
# batch_delete_import_data method usage example with argument unpacking
kwargs: BatchDeleteImportDataRequestRequestTypeDef = { # (1)
"importTaskIds": ...,
}
parent.batch_delete_import_data(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.client("discovery").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.client("discovery").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_application#
Creates an application with the given name and description.
Type annotations and code completion for session.client("discovery").create_application
method.
boto3 documentation
# create_application method definition
await def create_application(
self,
*,
name: str,
description: str = ...,
) -> CreateApplicationResponseTypeDef: # (1)
...
# create_application method usage example with argument unpacking
kwargs: CreateApplicationRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_application(**kwargs)
create_tags#
Creates one or more tags for configuration items.
Type annotations and code completion for session.client("discovery").create_tags
method.
boto3 documentation
# create_tags method definition
await def create_tags(
self,
*,
configurationIds: Sequence[str],
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# create_tags method usage example with argument unpacking
kwargs: CreateTagsRequestRequestTypeDef = { # (1)
"configurationIds": ...,
"tags": ...,
}
parent.create_tags(**kwargs)
delete_applications#
Deletes a list of applications and their associations with configuration items.
Type annotations and code completion for session.client("discovery").delete_applications
method.
boto3 documentation
# delete_applications method definition
await def delete_applications(
self,
*,
configurationIds: Sequence[str],
) -> Dict[str, Any]:
...
# delete_applications method usage example with argument unpacking
kwargs: DeleteApplicationsRequestRequestTypeDef = { # (1)
"configurationIds": ...,
}
parent.delete_applications(**kwargs)
delete_tags#
Deletes the association between configuration items and one or more tags.
Type annotations and code completion for session.client("discovery").delete_tags
method.
boto3 documentation
# delete_tags method definition
await def delete_tags(
self,
*,
configurationIds: Sequence[str],
tags: Sequence[TagTypeDef] = ..., # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# delete_tags method usage example with argument unpacking
kwargs: DeleteTagsRequestRequestTypeDef = { # (1)
"configurationIds": ...,
}
parent.delete_tags(**kwargs)
describe_agents#
Lists agents or collectors as specified by ID or other filters.
Type annotations and code completion for session.client("discovery").describe_agents
method.
boto3 documentation
# describe_agents method definition
await def describe_agents(
self,
*,
agentIds: Sequence[str] = ...,
filters: Sequence[FilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeAgentsResponseTypeDef: # (2)
...
# describe_agents method usage example with argument unpacking
kwargs: DescribeAgentsRequestRequestTypeDef = { # (1)
"agentIds": ...,
}
parent.describe_agents(**kwargs)
describe_batch_delete_configuration_task#
Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
Type annotations and code completion for session.client("discovery").describe_batch_delete_configuration_task
method.
boto3 documentation
# describe_batch_delete_configuration_task method definition
await def describe_batch_delete_configuration_task(
self,
*,
taskId: str,
) -> DescribeBatchDeleteConfigurationTaskResponseTypeDef: # (1)
...
# describe_batch_delete_configuration_task method usage example with argument unpacking
kwargs: DescribeBatchDeleteConfigurationTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.describe_batch_delete_configuration_task(**kwargs)
describe_configurations#
Retrieves attributes for a list of configuration item IDs.
Type annotations and code completion for session.client("discovery").describe_configurations
method.
boto3 documentation
# describe_configurations method definition
await def describe_configurations(
self,
*,
configurationIds: Sequence[str],
) -> DescribeConfigurationsResponseTypeDef: # (1)
...
# describe_configurations method usage example with argument unpacking
kwargs: DescribeConfigurationsRequestRequestTypeDef = { # (1)
"configurationIds": ...,
}
parent.describe_configurations(**kwargs)
describe_continuous_exports#
Lists exports as specified by ID.
Type annotations and code completion for session.client("discovery").describe_continuous_exports
method.
boto3 documentation
# describe_continuous_exports method definition
await def describe_continuous_exports(
self,
*,
exportIds: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeContinuousExportsResponseTypeDef: # (1)
...
# describe_continuous_exports method usage example with argument unpacking
kwargs: DescribeContinuousExportsRequestRequestTypeDef = { # (1)
"exportIds": ...,
}
parent.describe_continuous_exports(**kwargs)
describe_export_configurations#
DescribeExportConfigurations
is deprecated.
Type annotations and code completion for session.client("discovery").describe_export_configurations
method.
boto3 documentation
# describe_export_configurations method definition
await def describe_export_configurations(
self,
*,
exportIds: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeExportConfigurationsResponseTypeDef: # (1)
...
# describe_export_configurations method usage example with argument unpacking
kwargs: DescribeExportConfigurationsRequestRequestTypeDef = { # (1)
"exportIds": ...,
}
parent.describe_export_configurations(**kwargs)
describe_export_tasks#
Retrieve status of one or more export tasks.
Type annotations and code completion for session.client("discovery").describe_export_tasks
method.
boto3 documentation
# describe_export_tasks method definition
await def describe_export_tasks(
self,
*,
exportIds: Sequence[str] = ...,
filters: Sequence[ExportFilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeExportTasksResponseTypeDef: # (2)
...
# describe_export_tasks method usage example with argument unpacking
kwargs: DescribeExportTasksRequestRequestTypeDef = { # (1)
"exportIds": ...,
}
parent.describe_export_tasks(**kwargs)
describe_import_tasks#
Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
Type annotations and code completion for session.client("discovery").describe_import_tasks
method.
boto3 documentation
# describe_import_tasks method definition
await def describe_import_tasks(
self,
*,
filters: Sequence[ImportTaskFilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeImportTasksResponseTypeDef: # (2)
...
# describe_import_tasks method usage example with argument unpacking
kwargs: DescribeImportTasksRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.describe_import_tasks(**kwargs)
describe_tags#
Retrieves a list of configuration items that have tags as specified by the
key-value pairs, name and value, passed to the optional parameter
filters
.
Type annotations and code completion for session.client("discovery").describe_tags
method.
boto3 documentation
# describe_tags method definition
await def describe_tags(
self,
*,
filters: Sequence[TagFilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeTagsResponseTypeDef: # (2)
...
# describe_tags method usage example with argument unpacking
kwargs: DescribeTagsRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.describe_tags(**kwargs)
disassociate_configuration_items_from_application#
Disassociates one or more configuration items from an application.
Type annotations and code completion for session.client("discovery").disassociate_configuration_items_from_application
method.
boto3 documentation
# disassociate_configuration_items_from_application method definition
await def disassociate_configuration_items_from_application(
self,
*,
applicationConfigurationId: str,
configurationIds: Sequence[str],
) -> Dict[str, Any]:
...
# disassociate_configuration_items_from_application method usage example with argument unpacking
kwargs: DisassociateConfigurationItemsFromApplicationRequestRequestTypeDef = { # (1)
"applicationConfigurationId": ...,
"configurationIds": ...,
}
parent.disassociate_configuration_items_from_application(**kwargs)
export_configurations#
Deprecated.
Type annotations and code completion for session.client("discovery").export_configurations
method.
boto3 documentation
# export_configurations method definition
await def export_configurations(
self,
) -> ExportConfigurationsResponseTypeDef: # (1)
...
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("discovery").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_discovery_summary#
Retrieves a short summary of discovered assets.
Type annotations and code completion for session.client("discovery").get_discovery_summary
method.
boto3 documentation
# get_discovery_summary method definition
await def get_discovery_summary(
self,
) -> GetDiscoverySummaryResponseTypeDef: # (1)
...
list_configurations#
Retrieves a list of configuration items as specified by the value passed to the
required parameter
configurationType
.
Type annotations and code completion for session.client("discovery").list_configurations
method.
boto3 documentation
# list_configurations method definition
await def list_configurations(
self,
*,
configurationType: ConfigurationItemTypeType, # (1)
filters: Sequence[FilterTypeDef] = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
orderBy: Sequence[OrderByElementTypeDef] = ..., # (3)
) -> ListConfigurationsResponseTypeDef: # (4)
...
- See ConfigurationItemTypeType
- See FilterTypeDef
- See OrderByElementTypeDef
- See ListConfigurationsResponseTypeDef
# list_configurations method usage example with argument unpacking
kwargs: ListConfigurationsRequestRequestTypeDef = { # (1)
"configurationType": ...,
}
parent.list_configurations(**kwargs)
list_server_neighbors#
Retrieves a list of servers that are one network hop away from a specified server.
Type annotations and code completion for session.client("discovery").list_server_neighbors
method.
boto3 documentation
# list_server_neighbors method definition
await def list_server_neighbors(
self,
*,
configurationId: str,
portInformationNeeded: bool = ...,
neighborConfigurationIds: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListServerNeighborsResponseTypeDef: # (1)
...
# list_server_neighbors method usage example with argument unpacking
kwargs: ListServerNeighborsRequestRequestTypeDef = { # (1)
"configurationId": ...,
}
parent.list_server_neighbors(**kwargs)
start_batch_delete_configuration_task#
Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems.
Type annotations and code completion for session.client("discovery").start_batch_delete_configuration_task
method.
boto3 documentation
# start_batch_delete_configuration_task method definition
await def start_batch_delete_configuration_task(
self,
*,
configurationType: DeletionConfigurationItemTypeType, # (1)
configurationIds: Sequence[str],
) -> StartBatchDeleteConfigurationTaskResponseTypeDef: # (2)
...
# start_batch_delete_configuration_task method usage example with argument unpacking
kwargs: StartBatchDeleteConfigurationTaskRequestRequestTypeDef = { # (1)
"configurationType": ...,
"configurationIds": ...,
}
parent.start_batch_delete_configuration_task(**kwargs)
start_continuous_export#
Start the continuous flow of agent's discovered data into Amazon Athena.
Type annotations and code completion for session.client("discovery").start_continuous_export
method.
boto3 documentation
# start_continuous_export method definition
await def start_continuous_export(
self,
) -> StartContinuousExportResponseTypeDef: # (1)
...
start_data_collection_by_agent_ids#
Instructs the specified agents to start collecting data.
Type annotations and code completion for session.client("discovery").start_data_collection_by_agent_ids
method.
boto3 documentation
# start_data_collection_by_agent_ids method definition
await def start_data_collection_by_agent_ids(
self,
*,
agentIds: Sequence[str],
) -> StartDataCollectionByAgentIdsResponseTypeDef: # (1)
...
# start_data_collection_by_agent_ids method usage example with argument unpacking
kwargs: StartDataCollectionByAgentIdsRequestRequestTypeDef = { # (1)
"agentIds": ...,
}
parent.start_data_collection_by_agent_ids(**kwargs)
start_export_task#
Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.
Type annotations and code completion for session.client("discovery").start_export_task
method.
boto3 documentation
# start_export_task method definition
await def start_export_task(
self,
*,
exportDataFormat: Sequence[ExportDataFormatType] = ..., # (1)
filters: Sequence[ExportFilterTypeDef] = ..., # (2)
startTime: Union[datetime, str] = ...,
endTime: Union[datetime, str] = ...,
preferences: ExportPreferencesTypeDef = ..., # (3)
) -> StartExportTaskResponseTypeDef: # (4)
...
- See ExportDataFormatType
- See ExportFilterTypeDef
- See ExportPreferencesTypeDef
- See StartExportTaskResponseTypeDef
# start_export_task method usage example with argument unpacking
kwargs: StartExportTaskRequestRequestTypeDef = { # (1)
"exportDataFormat": ...,
}
parent.start_export_task(**kwargs)
start_import_task#
Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to use the Amazon Web Services Application Discovery Service (Application Discovery Service) tools such as the Amazon Web Services Application D...
Type annotations and code completion for session.client("discovery").start_import_task
method.
boto3 documentation
# start_import_task method definition
await def start_import_task(
self,
*,
name: str,
importUrl: str,
clientRequestToken: str = ...,
) -> StartImportTaskResponseTypeDef: # (1)
...
# start_import_task method usage example with argument unpacking
kwargs: StartImportTaskRequestRequestTypeDef = { # (1)
"name": ...,
"importUrl": ...,
}
parent.start_import_task(**kwargs)
stop_continuous_export#
Stop the continuous flow of agent's discovered data into Amazon Athena.
Type annotations and code completion for session.client("discovery").stop_continuous_export
method.
boto3 documentation
# stop_continuous_export method definition
await def stop_continuous_export(
self,
*,
exportId: str,
) -> StopContinuousExportResponseTypeDef: # (1)
...
# stop_continuous_export method usage example with argument unpacking
kwargs: StopContinuousExportRequestRequestTypeDef = { # (1)
"exportId": ...,
}
parent.stop_continuous_export(**kwargs)
stop_data_collection_by_agent_ids#
Instructs the specified agents to stop collecting data.
Type annotations and code completion for session.client("discovery").stop_data_collection_by_agent_ids
method.
boto3 documentation
# stop_data_collection_by_agent_ids method definition
await def stop_data_collection_by_agent_ids(
self,
*,
agentIds: Sequence[str],
) -> StopDataCollectionByAgentIdsResponseTypeDef: # (1)
...
# stop_data_collection_by_agent_ids method usage example with argument unpacking
kwargs: StopDataCollectionByAgentIdsRequestRequestTypeDef = { # (1)
"agentIds": ...,
}
parent.stop_data_collection_by_agent_ids(**kwargs)
update_application#
Updates metadata about an application.
Type annotations and code completion for session.client("discovery").update_application
method.
boto3 documentation
# update_application method definition
await def update_application(
self,
*,
configurationId: str,
name: str = ...,
description: str = ...,
) -> Dict[str, Any]:
...
# update_application method usage example with argument unpacking
kwargs: UpdateApplicationRequestRequestTypeDef = { # (1)
"configurationId": ...,
}
parent.update_application(**kwargs)
__aenter__#
Type annotations and code completion for session.client("discovery").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> ApplicationDiscoveryServiceClient:
...
__aexit__#
Type annotations and code completion for session.client("discovery").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.client("discovery").get_paginator
method with overloads.
client.get_paginator("describe_agents")
-> DescribeAgentsPaginatorclient.get_paginator("describe_continuous_exports")
-> DescribeContinuousExportsPaginatorclient.get_paginator("describe_export_configurations")
-> DescribeExportConfigurationsPaginatorclient.get_paginator("describe_export_tasks")
-> DescribeExportTasksPaginatorclient.get_paginator("describe_import_tasks")
-> DescribeImportTasksPaginatorclient.get_paginator("describe_tags")
-> DescribeTagsPaginatorclient.get_paginator("list_configurations")
-> ListConfigurationsPaginator