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

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.

Usage example

async with session.client("discovery") as client:
    try:
        do_something(client)
    except (
            client.AuthorizationErrorException,
        client.ClientError,
        client.ConflictErrorException,
        client.HomeRegionNotSetException,
        client.InvalidParameterException,
        client.InvalidParameterValueException,
        client.OperationNotPermittedException,
        client.ResourceInUseException,
        client.ResourceNotFoundException,
        client.ServerInternalErrorException,
    ) as e:
        print(e)

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

Method definition

await def associate_configuration_items_to_application(
    self,
    *,
    applicationConfigurationId: str,
    configurationIds: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: AssociateConfigurationItemsToApplicationRequestRequestTypeDef = {  # (1)
    "applicationConfigurationId": ...,
    "configurationIds": ...,
}

parent.associate_configuration_items_to_application(**kwargs)

1. See AssociateConfigurationItemsToApplicationRequestRequestTypeDef

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

Method definition

await def batch_delete_import_data(
    self,
    *,
    importTaskIds: Sequence[str],
) -> BatchDeleteImportDataResponseTypeDef:  # (1)
    ...

1. See BatchDeleteImportDataResponseTypeDef

Usage example with kwargs

kwargs: BatchDeleteImportDataRequestRequestTypeDef = {  # (1)
    "importTaskIds": ...,
}

parent.batch_delete_import_data(**kwargs)

1. See BatchDeleteImportDataRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.client("discovery").can_paginate method. boto3 documentation

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

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

Method definition

await def create_application(
    self,
    *,
    name: str,
    description: str = ...,
) -> CreateApplicationResponseTypeDef:  # (1)
    ...

1. See CreateApplicationResponseTypeDef

Usage example with kwargs

kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_application(**kwargs)

1. See CreateApplicationRequestRequestTypeDef

create_tags

Creates one or more tags for configuration items.

Type annotations and code completion for session.client("discovery").create_tags method. boto3 documentation

Method definition

await def create_tags(
    self,
    *,
    configurationIds: Sequence[str],
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: CreateTagsRequestRequestTypeDef = {  # (1)
    "configurationIds": ...,
    "tags": ...,
}

parent.create_tags(**kwargs)

1. See CreateTagsRequestRequestTypeDef

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

Method definition

await def delete_applications(
    self,
    *,
    configurationIds: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteApplicationsRequestRequestTypeDef = {  # (1)
    "configurationIds": ...,
}

parent.delete_applications(**kwargs)

1. See DeleteApplicationsRequestRequestTypeDef

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

Method definition

await def delete_tags(
    self,
    *,
    configurationIds: Sequence[str],
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: DeleteTagsRequestRequestTypeDef = {  # (1)
    "configurationIds": ...,
}

parent.delete_tags(**kwargs)

1. See DeleteTagsRequestRequestTypeDef

describe_agents

Lists agents or connectors as specified by ID or other filters.

Type annotations and code completion for session.client("discovery").describe_agents method. boto3 documentation

Method definition

await def describe_agents(
    self,
    *,
    agentIds: Sequence[str] = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeAgentsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See DescribeAgentsResponseTypeDef

Usage example with kwargs

kwargs: DescribeAgentsRequestRequestTypeDef = {  # (1)
    "agentIds": ...,
}

parent.describe_agents(**kwargs)

1. See DescribeAgentsRequestRequestTypeDef

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

Method definition

await def describe_configurations(
    self,
    *,
    configurationIds: Sequence[str],
) -> DescribeConfigurationsResponseTypeDef:  # (1)
    ...

1. See DescribeConfigurationsResponseTypeDef

Usage example with kwargs

kwargs: DescribeConfigurationsRequestRequestTypeDef = {  # (1)
    "configurationIds": ...,
}

parent.describe_configurations(**kwargs)

1. See DescribeConfigurationsRequestRequestTypeDef

describe_continuous_exports

Lists exports as specified by ID.

Type annotations and code completion for session.client("discovery").describe_continuous_exports method. boto3 documentation

Method definition

await def describe_continuous_exports(
    self,
    *,
    exportIds: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeContinuousExportsResponseTypeDef:  # (1)
    ...

1. See DescribeContinuousExportsResponseTypeDef

Usage example with kwargs

kwargs: DescribeContinuousExportsRequestRequestTypeDef = {  # (1)
    "exportIds": ...,
}

parent.describe_continuous_exports(**kwargs)

1. See DescribeContinuousExportsRequestRequestTypeDef

describe_export_configurations

DescribeExportConfigurations is deprecated.

Type annotations and code completion for session.client("discovery").describe_export_configurations method. boto3 documentation

Method definition

await def describe_export_configurations(
    self,
    *,
    exportIds: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeExportConfigurationsResponseTypeDef:  # (1)
    ...

1. See DescribeExportConfigurationsResponseTypeDef

Usage example with kwargs

kwargs: DescribeExportConfigurationsRequestRequestTypeDef = {  # (1)
    "exportIds": ...,
}

parent.describe_export_configurations(**kwargs)

1. See DescribeExportConfigurationsRequestRequestTypeDef

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

Method definition

await def describe_export_tasks(
    self,
    *,
    exportIds: Sequence[str] = ...,
    filters: Sequence[ExportFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeExportTasksResponseTypeDef:  # (2)
    ...

1. See ExportFilterTypeDef
2. See DescribeExportTasksResponseTypeDef

Usage example with kwargs

kwargs: DescribeExportTasksRequestRequestTypeDef = {  # (1)
    "exportIds": ...,
}

parent.describe_export_tasks(**kwargs)

1. See DescribeExportTasksRequestRequestTypeDef

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

Method definition

await def describe_import_tasks(
    self,
    *,
    filters: Sequence[ImportTaskFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeImportTasksResponseTypeDef:  # (2)
    ...

1. See ImportTaskFilterTypeDef
2. See DescribeImportTasksResponseTypeDef

Usage example with kwargs

kwargs: DescribeImportTasksRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.describe_import_tasks(**kwargs)

1. See DescribeImportTasksRequestRequestTypeDef

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

Method definition

await def describe_tags(
    self,
    *,
    filters: Sequence[TagFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeTagsResponseTypeDef:  # (2)
    ...

1. See TagFilterTypeDef
2. See DescribeTagsResponseTypeDef

Usage example with kwargs

kwargs: DescribeTagsRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.describe_tags(**kwargs)

1. See DescribeTagsRequestRequestTypeDef

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

Method definition

await def disassociate_configuration_items_from_application(
    self,
    *,
    applicationConfigurationId: str,
    configurationIds: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DisassociateConfigurationItemsFromApplicationRequestRequestTypeDef = {  # (1)
    "applicationConfigurationId": ...,
    "configurationIds": ...,
}

parent.disassociate_configuration_items_from_application(**kwargs)

1. See DisassociateConfigurationItemsFromApplicationRequestRequestTypeDef

export_configurations

Deprecated.

Type annotations and code completion for session.client("discovery").export_configurations method. boto3 documentation

Method definition

await def export_configurations(
    self,
) -> ExportConfigurationsResponseTypeDef:  # (1)
    ...

1. See ExportConfigurationsResponseTypeDef

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

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

Method definition

await def get_discovery_summary(
    self,
) -> GetDiscoverySummaryResponseTypeDef:  # (1)
    ...

1. See GetDiscoverySummaryResponseTypeDef

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

Method definition

await def list_configurations(
    self,
    *,
    configurationType: ConfigurationItemTypeType,  # (1)
    filters: Sequence[FilterTypeDef] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
    orderBy: Sequence[OrderByElementTypeDef] = ...,  # (3)
) -> ListConfigurationsResponseTypeDef:  # (4)
    ...

1. See ConfigurationItemTypeType
2. See FilterTypeDef
3. See OrderByElementTypeDef
4. See ListConfigurationsResponseTypeDef

Usage example with kwargs

kwargs: ListConfigurationsRequestRequestTypeDef = {  # (1)
    "configurationType": ...,
}

parent.list_configurations(**kwargs)

1. See ListConfigurationsRequestRequestTypeDef

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

Method definition

await def list_server_neighbors(
    self,
    *,
    configurationId: str,
    portInformationNeeded: bool = ...,
    neighborConfigurationIds: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListServerNeighborsResponseTypeDef:  # (1)
    ...

1. See ListServerNeighborsResponseTypeDef

Usage example with kwargs

kwargs: ListServerNeighborsRequestRequestTypeDef = {  # (1)
    "configurationId": ...,
}

parent.list_server_neighbors(**kwargs)

1. See ListServerNeighborsRequestRequestTypeDef

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

Method definition

await def start_continuous_export(
    self,
) -> StartContinuousExportResponseTypeDef:  # (1)
    ...

1. See StartContinuousExportResponseTypeDef

start_data_collection_by_agent_ids

Instructs the specified agents or connectors to start collecting data.

Type annotations and code completion for session.client("discovery").start_data_collection_by_agent_ids method. boto3 documentation

Method definition

await def start_data_collection_by_agent_ids(
    self,
    *,
    agentIds: Sequence[str],
) -> StartDataCollectionByAgentIdsResponseTypeDef:  # (1)
    ...

1. See StartDataCollectionByAgentIdsResponseTypeDef

Usage example with kwargs

kwargs: StartDataCollectionByAgentIdsRequestRequestTypeDef = {  # (1)
    "agentIds": ...,
}

parent.start_data_collection_by_agent_ids(**kwargs)

1. See StartDataCollectionByAgentIdsRequestRequestTypeDef

start_export_task

Begins the export of discovered data to an S3 bucket.

Type annotations and code completion for session.client("discovery").start_export_task method. boto3 documentation

Method definition

await def start_export_task(
    self,
    *,
    exportDataFormat: Sequence[ExportDataFormatType] = ...,  # (1)
    filters: Sequence[ExportFilterTypeDef] = ...,  # (2)
    startTime: Union[datetime, str] = ...,
    endTime: Union[datetime, str] = ...,
) -> StartExportTaskResponseTypeDef:  # (3)
    ...

1. See ExportDataFormatType
2. See ExportFilterTypeDef
3. See StartExportTaskResponseTypeDef

Usage example with kwargs

kwargs: StartExportTaskRequestRequestTypeDef = {  # (1)
    "exportDataFormat": ...,
}

parent.start_export_task(**kwargs)

1. See StartExportTaskRequestRequestTypeDef

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 Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent.

Type annotations and code completion for session.client("discovery").start_import_task method. boto3 documentation

Method definition

await def start_import_task(
    self,
    *,
    name: str,
    importUrl: str,
    clientRequestToken: str = ...,
) -> StartImportTaskResponseTypeDef:  # (1)
    ...

1. See StartImportTaskResponseTypeDef

Usage example with kwargs

kwargs: StartImportTaskRequestRequestTypeDef = {  # (1)
    "name": ...,
    "importUrl": ...,
}

parent.start_import_task(**kwargs)

1. See StartImportTaskRequestRequestTypeDef

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

Method definition

await def stop_continuous_export(
    self,
    *,
    exportId: str,
) -> StopContinuousExportResponseTypeDef:  # (1)
    ...

1. See StopContinuousExportResponseTypeDef

Usage example with kwargs

kwargs: StopContinuousExportRequestRequestTypeDef = {  # (1)
    "exportId": ...,
}

parent.stop_continuous_export(**kwargs)

1. See StopContinuousExportRequestRequestTypeDef

stop_data_collection_by_agent_ids

Instructs the specified agents or connectors to stop collecting data.

Type annotations and code completion for session.client("discovery").stop_data_collection_by_agent_ids method. boto3 documentation

Method definition

await def stop_data_collection_by_agent_ids(
    self,
    *,
    agentIds: Sequence[str],
) -> StopDataCollectionByAgentIdsResponseTypeDef:  # (1)
    ...

1. See StopDataCollectionByAgentIdsResponseTypeDef

Usage example with kwargs

kwargs: StopDataCollectionByAgentIdsRequestRequestTypeDef = {  # (1)
    "agentIds": ...,
}

parent.stop_data_collection_by_agent_ids(**kwargs)

1. See StopDataCollectionByAgentIdsRequestRequestTypeDef

update_application

Updates metadata about an application.

Type annotations and code completion for session.client("discovery").update_application method. boto3 documentation

Method definition

await def update_application(
    self,
    *,
    configurationId: str,
    name: str = ...,
    description: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "configurationId": ...,
}

parent.update_application(**kwargs)

1. See UpdateApplicationRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.client("discovery").__aenter__ method. boto3 documentation

Method definition

await def __aenter__(
    self,
) -> ApplicationDiscoveryServiceClient:
    ...

__aexit__

Type annotations and code completion for session.client("discovery").__aexit__ method. boto3 documentation

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") -> DescribeAgentsPaginator
• client.get_paginator("describe_continuous_exports") -> DescribeContinuousExportsPaginator
• client.get_paginator("describe_export_configurations") -> DescribeExportConfigurationsPaginator
• client.get_paginator("describe_export_tasks") -> DescribeExportTasksPaginator
• client.get_paginator("describe_tags") -> DescribeTagsPaginator
• client.get_paginator("list_configurations") -> ListConfigurationsPaginator