ApplicationDiscoveryServiceClient

Index > ApplicationDiscoveryService > ApplicationDiscoveryServiceClient

Auto-generated documentation for ApplicationDiscoveryService type annotations stubs module mypy-boto3-discovery.

ApplicationDiscoveryServiceClient

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

# ApplicationDiscoveryServiceClient usage example

from boto3.session import Session
from mypy_boto3_discovery.client import ApplicationDiscoveryServiceClient

def get_discovery_client() -> ApplicationDiscoveryServiceClient:
    return Session().client("discovery")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("discovery").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("discovery")

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)

# Exceptions.exceptions type checking example

from mypy_boto3_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 boto3.client("discovery").associate_configuration_items_to_application method. boto3 documentation

# associate_configuration_items_to_application method definition

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)

1. See AssociateConfigurationItemsToApplicationRequestRequestTypeDef

batch_delete_agents

Deletes one or more agents or collectors as specified by ID.

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

# batch_delete_agents method definition

def batch_delete_agents(
    self,
    *,
    deleteAgents: Sequence[DeleteAgentTypeDef],  # (1)
) -> BatchDeleteAgentsResponseTypeDef:  # (2)
    ...

1. See DeleteAgentTypeDef
2. See BatchDeleteAgentsResponseTypeDef

# batch_delete_agents method usage example with argument unpacking

kwargs: BatchDeleteAgentsRequestRequestTypeDef = {  # (1)
    "deleteAgents": ...,
}

parent.batch_delete_agents(**kwargs)

1. See BatchDeleteAgentsRequestRequestTypeDef

batch_delete_import_data

Deletes one or more import tasks, each identified by their import ID.

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

# batch_delete_import_data method definition

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

1. See BatchDeleteImportDataResponseTypeDef

# batch_delete_import_data method usage example with argument unpacking

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 boto3.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 boto3.client("discovery").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_application

Creates an application with the given name and description.

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

# create_application method definition

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

1. See CreateApplicationResponseTypeDef

# create_application method usage example with argument unpacking

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 boto3.client("discovery").create_tags method. boto3 documentation

# create_tags method definition

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

1. See TagTypeDef

# create_tags method usage example with argument unpacking

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 boto3.client("discovery").delete_applications method. boto3 documentation

# delete_applications method definition

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)

1. See DeleteApplicationsRequestRequestTypeDef

delete_tags

Deletes the association between configuration items and one or more tags.

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

# delete_tags method definition

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

1. See TagTypeDef

# delete_tags method usage example with argument unpacking

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

parent.delete_tags(**kwargs)

1. See DeleteTagsRequestRequestTypeDef

describe_agents

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

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

# describe_agents method definition

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

1. See FilterTypeDef
2. See DescribeAgentsResponseTypeDef

# describe_agents method usage example with argument unpacking

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

parent.describe_agents(**kwargs)

1. See DescribeAgentsRequestRequestTypeDef

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 boto3.client("discovery").describe_batch_delete_configuration_task method. boto3 documentation

# describe_batch_delete_configuration_task method definition

def describe_batch_delete_configuration_task(
    self,
    *,
    taskId: str,
) -> DescribeBatchDeleteConfigurationTaskResponseTypeDef:  # (1)
    ...

1. See DescribeBatchDeleteConfigurationTaskResponseTypeDef

# describe_batch_delete_configuration_task method usage example with argument unpacking

kwargs: DescribeBatchDeleteConfigurationTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_batch_delete_configuration_task(**kwargs)

1. See DescribeBatchDeleteConfigurationTaskRequestRequestTypeDef

describe_configurations

Retrieves attributes for a list of configuration item IDs.

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

# describe_configurations method definition

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

1. See DescribeConfigurationsResponseTypeDef

# describe_configurations method usage example with argument unpacking

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 boto3.client("discovery").describe_continuous_exports method. boto3 documentation

# describe_continuous_exports method definition

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

1. See DescribeContinuousExportsResponseTypeDef

# describe_continuous_exports method usage example with argument unpacking

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

parent.describe_continuous_exports(**kwargs)

1. See DescribeContinuousExportsRequestRequestTypeDef

describe_export_configurations

DescribeExportConfigurations is deprecated.

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

# describe_export_configurations method definition

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

1. See DescribeExportConfigurationsResponseTypeDef

# describe_export_configurations method usage example with argument unpacking

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 boto3.client("discovery").describe_export_tasks method. boto3 documentation

# describe_export_tasks method definition

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

1. See ExportFilterTypeDef
2. See DescribeExportTasksResponseTypeDef

# describe_export_tasks method usage example with argument unpacking

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 boto3.client("discovery").describe_import_tasks method. boto3 documentation

# describe_import_tasks method definition

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

1. See ImportTaskFilterTypeDef
2. See DescribeImportTasksResponseTypeDef

# describe_import_tasks method usage example with argument unpacking

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 boto3.client("discovery").describe_tags method. boto3 documentation

# describe_tags method definition

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

1. See TagFilterTypeDef
2. See DescribeTagsResponseTypeDef

# describe_tags method usage example with argument unpacking

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 boto3.client("discovery").disassociate_configuration_items_from_application method. boto3 documentation

# disassociate_configuration_items_from_application method definition

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)

1. See DisassociateConfigurationItemsFromApplicationRequestRequestTypeDef

export_configurations

Deprecated.

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

# export_configurations method definition

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 boto3.client("discovery").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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 boto3.client("discovery").get_discovery_summary method. boto3 documentation

# get_discovery_summary method definition

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 boto3.client("discovery").list_configurations method. boto3 documentation

# list_configurations method definition

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

# list_configurations method usage example with argument unpacking

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 boto3.client("discovery").list_server_neighbors method. boto3 documentation

# list_server_neighbors method definition

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

1. See ListServerNeighborsResponseTypeDef

# list_server_neighbors method usage example with argument unpacking

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

parent.list_server_neighbors(**kwargs)

1. See ListServerNeighborsRequestRequestTypeDef

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 boto3.client("discovery").start_batch_delete_configuration_task method. boto3 documentation

# start_batch_delete_configuration_task method definition

def start_batch_delete_configuration_task(
    self,
    *,
    configurationType: DeletionConfigurationItemTypeType,  # (1)
    configurationIds: Sequence[str],
) -> StartBatchDeleteConfigurationTaskResponseTypeDef:  # (2)
    ...

1. See DeletionConfigurationItemTypeType
2. See StartBatchDeleteConfigurationTaskResponseTypeDef

# start_batch_delete_configuration_task method usage example with argument unpacking

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

parent.start_batch_delete_configuration_task(**kwargs)

1. See StartBatchDeleteConfigurationTaskRequestRequestTypeDef

start_continuous_export

Start the continuous flow of agent's discovered data into Amazon Athena.

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

# start_continuous_export method definition

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

1. See StartContinuousExportResponseTypeDef

start_data_collection_by_agent_ids

Instructs the specified agents to start collecting data.

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

# start_data_collection_by_agent_ids method definition

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

1. See StartDataCollectionByAgentIdsResponseTypeDef

# start_data_collection_by_agent_ids method usage example with argument unpacking

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

parent.start_data_collection_by_agent_ids(**kwargs)

1. See StartDataCollectionByAgentIdsRequestRequestTypeDef

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 boto3.client("discovery").start_export_task method. boto3 documentation

# start_export_task method definition

def start_export_task(
    self,
    *,
    exportDataFormat: Sequence[ExportDataFormatType] = ...,  # (1)
    filters: Sequence[ExportFilterTypeDef] = ...,  # (2)
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
    preferences: ExportPreferencesTypeDef = ...,  # (3)
) -> StartExportTaskResponseTypeDef:  # (4)
    ...

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

# start_export_task method usage example with argument unpacking

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 Amazon Web Services Application Discovery Service (Application Discovery Service) tools such as the Amazon Web Services Application D...

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

# start_import_task method definition

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

1. See StartImportTaskResponseTypeDef

# start_import_task method usage example with argument unpacking

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 boto3.client("discovery").stop_continuous_export method. boto3 documentation

# stop_continuous_export method definition

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

1. See StopContinuousExportResponseTypeDef

# stop_continuous_export method usage example with argument unpacking

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

parent.stop_continuous_export(**kwargs)

1. See StopContinuousExportRequestRequestTypeDef

stop_data_collection_by_agent_ids

Instructs the specified agents to stop collecting data.

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

# stop_data_collection_by_agent_ids method definition

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

1. See StopDataCollectionByAgentIdsResponseTypeDef

# stop_data_collection_by_agent_ids method usage example with argument unpacking

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 boto3.client("discovery").update_application method. boto3 documentation

# update_application method definition

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

# update_application method usage example with argument unpacking

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

parent.update_application(**kwargs)

1. See UpdateApplicationRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.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_import_tasks") -> DescribeImportTasksPaginator
• client.get_paginator("describe_tags") -> DescribeTagsPaginator
• client.get_paginator("list_configurations") -> ListConfigurationsPaginator