Skip to content

Discovery Classes

AgentConfigurationStatus

agentId

  • Type: typing.Optional[str]

operationSucceeded

  • Type: typing.Optional[bool]

description

  • Type: typing.Optional[str]

AgentInfo

agentId

  • Type: typing.Optional[str]

hostName

  • Type: typing.Optional[str]

agentNetworkInfoList

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.AgentNetworkInfo]]

connectorId

  • Type: typing.Optional[str]

version

  • Type: typing.Optional[str]

health

  • Type: typing.Optional[typing.Literal['BLACKLISTED', 'HEALTHY', 'RUNNING', 'SHUTDOWN', 'UNHEALTHY', 'UNKNOWN']]

lastHealthPingTime

  • Type: typing.Optional[str]

collectionStatus

  • Type: typing.Optional[str]

agentType

  • Type: typing.Optional[str]

registeredTime

  • Type: typing.Optional[str]

AgentNetworkInfo

ipAddress

  • Type: typing.Optional[str]

macAddress

  • Type: typing.Optional[str]

AssociateConfigurationItemsToApplicationRequest

applicationConfigurationId

  • Type:
  • Required: Yes

configurationIds

  • Type: typing.List[str]
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchDeleteAgentError

agentId

  • Type:
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

errorCode

  • Type: typing.Literal['AGENT_IN_USE', 'INTERNAL_SERVER_ERROR', 'NOT_FOUND']
  • Required: Yes

BatchDeleteAgentsRequest

deleteAgents

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.DeleteAgent]
  • Required: Yes

BatchDeleteAgentsResponse

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.BatchDeleteAgentError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDeleteConfigurationTask

taskId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['COMPLETED', 'DELETING', 'FAILED', 'INITIALIZING', 'VALIDATING']]

startTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

configurationType

  • Type: typing.Optional[typing.Literal['SERVER']]

requestedConfigurations

  • Type: typing.Optional[typing.List[str]]

deletedConfigurations

  • Type: typing.Optional[typing.List[str]]

failedConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.FailedConfiguration]]

deletionWarnings

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.DeletionWarning]]

BatchDeleteImportDataError

importTaskId

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[typing.Literal['INTERNAL_SERVER_ERROR', 'NOT_FOUND', 'OVER_LIMIT']]

errorDescription

  • Type: typing.Optional[str]

BatchDeleteImportDataRequest

importTaskIds

  • Type: typing.List[str]
  • Required: Yes

deleteHistory

  • Type: typing.Optional[bool]

BatchDeleteImportDataResponse

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.BatchDeleteImportDataError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ConfigurationTag

configurationType

  • Type: typing.Optional[typing.Literal['APPLICATION', 'CONNECTION', 'PROCESS', 'SERVER']]

configurationId

  • Type: typing.Optional[str]

key

  • Type: typing.Optional[str]

value

  • Type: typing.Optional[str]

timeOfCreation

  • Type: typing.Optional[datetime.datetime]

ContinuousExportDescription

exportId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'ERROR', 'INACTIVE', 'START_FAILED', 'START_IN_PROGRESS', 'STOP_FAILED', 'STOP_IN_PROGRESS']]

statusDetail

  • Type: typing.Optional[str]

s3Bucket

  • Type: typing.Optional[str]

startTime

  • Type: typing.Optional[datetime.datetime]

stopTime

  • Type: typing.Optional[datetime.datetime]

dataSource

  • Type: typing.Optional[typing.Literal['AGENT']]

schemaStorageConfig

  • Type: typing.Optional[typing.Dict[str, str]]

CreateApplicationRequest

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

wave

  • Type: typing.Optional[str]

CreateApplicationResponse

configurationId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateTagsRequest

configurationIds

  • Type: typing.List[str]
  • Required: Yes

tags

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.Tag]
  • Required: Yes

CustomerAgentInfo

activeAgents

  • Type:
  • Required: Yes

healthyAgents

  • Type:
  • Required: Yes

blackListedAgents

  • Type:
  • Required: Yes

shutdownAgents

  • Type:
  • Required: Yes

unhealthyAgents

  • Type:
  • Required: Yes

totalAgents

  • Type:
  • Required: Yes

unknownAgents

  • Type:
  • Required: Yes

CustomerAgentlessCollectorInfo

activeAgentlessCollectors

  • Type:
  • Required: Yes

healthyAgentlessCollectors

  • Type:
  • Required: Yes

denyListedAgentlessCollectors

  • Type:
  • Required: Yes

shutdownAgentlessCollectors

  • Type:
  • Required: Yes

unhealthyAgentlessCollectors

  • Type:
  • Required: Yes

totalAgentlessCollectors

  • Type:
  • Required: Yes

unknownAgentlessCollectors

  • Type:
  • Required: Yes

CustomerConnectorInfo

activeConnectors

  • Type:
  • Required: Yes

healthyConnectors

  • Type:
  • Required: Yes

blackListedConnectors

  • Type:
  • Required: Yes

shutdownConnectors

  • Type:
  • Required: Yes

unhealthyConnectors

  • Type:
  • Required: Yes

totalConnectors

  • Type:
  • Required: Yes

unknownConnectors

  • Type:
  • Required: Yes

CustomerMeCollectorInfo

activeMeCollectors

  • Type:
  • Required: Yes

healthyMeCollectors

  • Type:
  • Required: Yes

denyListedMeCollectors

  • Type:
  • Required: Yes

shutdownMeCollectors

  • Type:
  • Required: Yes

unhealthyMeCollectors

  • Type:
  • Required: Yes

totalMeCollectors

  • Type:
  • Required: Yes

unknownMeCollectors

  • Type:
  • Required: Yes

DeleteAgent

agentId

  • Type:
  • Required: Yes

force

  • Type: typing.Optional[bool]

DeleteApplicationsRequest

configurationIds

  • Type: typing.List[str]
  • Required: Yes

DeleteTagsRequest

configurationIds

  • Type: typing.List[str]
  • Required: Yes

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.Tag]]

DeletionWarning

configurationId

  • Type: typing.Optional[str]

warningCode

  • Type: typing.Optional[int]

warningText

  • Type: typing.Optional[str]

DescribeAgentsRequest

agentIds

  • Type: typing.Optional[typing.List[str]]

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.Filter]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

DescribeAgentsRequestPaginate

agentIds

  • Type: typing.Optional[typing.List[str]]

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.Filter]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.PaginatorConfig]

DescribeAgentsResponse

agentsInfo

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.AgentInfo]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

DescribeBatchDeleteConfigurationTaskRequest

taskId

  • Type:
  • Required: Yes

DescribeBatchDeleteConfigurationTaskResponse

task

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeConfigurationsRequest

configurationIds

  • Type: typing.List[str]
  • Required: Yes

DescribeConfigurationsResponse

configurations

  • Type: typing.List[typing.Dict[str, str]]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeContinuousExportsRequest

exportIds

  • Type: typing.Optional[typing.List[str]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

DescribeContinuousExportsRequestPaginate

exportIds

  • Type: typing.Optional[typing.List[str]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.PaginatorConfig]

DescribeContinuousExportsResponse

descriptions

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ContinuousExportDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

DescribeExportConfigurationsRequest

exportIds

  • Type: typing.Optional[typing.List[str]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

DescribeExportConfigurationsRequestPaginate

exportIds

  • Type: typing.Optional[typing.List[str]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.PaginatorConfig]

DescribeExportConfigurationsResponse

exportsInfo

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ExportInfo]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

DescribeExportTasksRequest

exportIds

  • Type: typing.Optional[typing.List[str]]

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ExportFilter]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

DescribeExportTasksRequestPaginate

exportIds

  • Type: typing.Optional[typing.List[str]]

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ExportFilter]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.PaginatorConfig]

DescribeExportTasksResponse

exportsInfo

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ExportInfo]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

DescribeImportTasksRequest

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ImportTaskFilter]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

DescribeImportTasksRequestPaginate

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ImportTaskFilter]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.PaginatorConfig]

DescribeImportTasksResponse

tasks

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ImportTask]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

DescribeTagsRequest

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.TagFilter]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

DescribeTagsRequestPaginate

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.TagFilter]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.PaginatorConfig]

DescribeTagsResponse

tags

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ConfigurationTag]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

DisassociateConfigurationItemsFromApplicationRequest

applicationConfigurationId

  • Type:
  • Required: Yes

configurationIds

  • Type: typing.List[str]
  • Required: Yes

Ec2RecommendationsExportPreferences

enabled

  • Type: typing.Optional[bool]

cpuPerformanceMetricBasis

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.UsageMetricBasis]

ramPerformanceMetricBasis

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.UsageMetricBasis]

tenancy

  • Type: typing.Optional[typing.Literal['DEDICATED', 'SHARED']]

excludedInstanceTypes

  • Type: typing.Optional[typing.List[str]]

preferredRegion

  • Type: typing.Optional[str]

reservedInstanceOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.ReservedInstanceOptions]

ExportConfigurationsResponse

exportId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ExportFilter

name

  • Type:
  • Required: Yes

values

  • Type: typing.List[str]
  • Required: Yes

condition

  • Type:
  • Required: Yes

ExportInfo

exportId

  • Type:
  • Required: Yes

exportStatus

  • Type: typing.Literal['FAILED', 'IN_PROGRESS', 'SUCCEEDED']
  • Required: Yes

statusMessage

  • Type:
  • Required: Yes

exportRequestTime

  • Type:
  • Required: Yes

configurationsDownloadUrl

  • Type: typing.Optional[str]

isTruncated

  • Type: typing.Optional[bool]

requestedStartTime

  • Type: typing.Optional[datetime.datetime]

requestedEndTime

  • Type: typing.Optional[datetime.datetime]

ExportPreferences

ec2RecommendationsPreferences

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.Ec2RecommendationsExportPreferences]

FailedConfiguration

configurationId

  • Type: typing.Optional[str]

errorStatusCode

  • Type: typing.Optional[int]

errorMessage

  • Type: typing.Optional[str]

Filter

name

  • Type:
  • Required: Yes

values

  • Type: typing.List[str]
  • Required: Yes

condition

  • Type:
  • Required: Yes

GetDiscoverySummaryResponse

servers

  • Type:
  • Required: Yes

applications

  • Type:
  • Required: Yes

serversMappedToApplications

  • Type:
  • Required: Yes

serversMappedtoTags

  • Type:
  • Required: Yes

agentSummary

  • Type:
  • Required: Yes

connectorSummary

  • Type:
  • Required: Yes

meCollectorSummary

  • Type:
  • Required: Yes

agentlessCollectorSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ImportTask

importTaskId

  • Type: typing.Optional[str]

clientRequestToken

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

importUrl

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['DELETE_COMPLETE', 'DELETE_FAILED', 'DELETE_FAILED_LIMIT_EXCEEDED', 'DELETE_IN_PROGRESS', 'IMPORT_COMPLETE', 'IMPORT_COMPLETE_WITH_ERRORS', 'IMPORT_FAILED', 'IMPORT_FAILED_RECORD_LIMIT_EXCEEDED', 'IMPORT_FAILED_SERVER_LIMIT_EXCEEDED', 'IMPORT_FAILED_UNSUPPORTED_FILE_TYPE', 'IMPORT_IN_PROGRESS', 'INTERNAL_ERROR']]

importRequestTime

  • Type: typing.Optional[datetime.datetime]

importCompletionTime

  • Type: typing.Optional[datetime.datetime]

importDeletedTime

  • Type: typing.Optional[datetime.datetime]

fileClassification

  • Type: typing.Optional[typing.Literal['IMPORT_TEMPLATE', 'MODELIZEIT_EXPORT', 'RVTOOLS_EXPORT', 'VMWARE_NSX_EXPORT']]

serverImportSuccess

  • Type: typing.Optional[int]

serverImportFailure

  • Type: typing.Optional[int]

applicationImportSuccess

  • Type: typing.Optional[int]

applicationImportFailure

  • Type: typing.Optional[int]

errorsAndFailedEntriesZip

  • Type: typing.Optional[str]

ImportTaskFilter

name

  • Type: typing.Optional[typing.Literal['FILE_CLASSIFICATION', 'IMPORT_TASK_ID', 'NAME', 'STATUS']]

values

  • Type: typing.Optional[typing.List[str]]

ListConfigurationsRequest

configurationType

  • Type: typing.Literal['APPLICATION', 'CONNECTION', 'PROCESS', 'SERVER']
  • Required: Yes

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.Filter]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

orderBy

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.OrderByElement]]

ListConfigurationsRequestPaginate

configurationType

  • Type: typing.Literal['APPLICATION', 'CONNECTION', 'PROCESS', 'SERVER']
  • Required: Yes

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.Filter]]

orderBy

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.OrderByElement]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.PaginatorConfig]

ListConfigurationsResponse

configurations

  • Type: typing.List[typing.Dict[str, str]]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListServerNeighborsRequest

configurationId

  • Type:
  • Required: Yes

portInformationNeeded

  • Type: typing.Optional[bool]

neighborConfigurationIds

  • Type: typing.Optional[typing.List[str]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListServerNeighborsResponse

neighbors

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.NeighborConnectionDetail]
  • Required: Yes

knownDependencyCount

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

NeighborConnectionDetail

sourceServerId

  • Type:
  • Required: Yes

destinationServerId

  • Type:
  • Required: Yes

connectionsCount

  • Type:
  • Required: Yes

destinationPort

  • Type: typing.Optional[int]

transportProtocol

  • Type: typing.Optional[str]

OrderByElement

fieldName

  • Type:
  • Required: Yes

sortOrder

  • Type: typing.Optional[typing.Literal['ASC', 'DESC']]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ReservedInstanceOptions

purchasingOption

  • Type: typing.Literal['ALL_UPFRONT', 'NO_UPFRONT', 'PARTIAL_UPFRONT']
  • Required: Yes

offeringClass

  • Type: typing.Literal['CONVERTIBLE', 'STANDARD']
  • Required: Yes

termLength

  • Type: typing.Literal['ONE_YEAR', 'THREE_YEAR']
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

StartBatchDeleteConfigurationTaskRequest

configurationType

  • Type: typing.Literal['SERVER']
  • Required: Yes

configurationIds

  • Type: typing.List[str]
  • Required: Yes

StartBatchDeleteConfigurationTaskResponse

taskId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartContinuousExportResponse

exportId

  • Type:
  • Required: Yes

s3Bucket

  • Type:
  • Required: Yes

startTime

  • Type:
  • Required: Yes

dataSource

  • Type: typing.Literal['AGENT']
  • Required: Yes

schemaStorageConfig

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartDataCollectionByAgentIdsRequest

agentIds

  • Type: typing.List[str]
  • Required: Yes

StartDataCollectionByAgentIdsResponse

agentsConfigurationStatus

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.AgentConfigurationStatus]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartExportTaskRequest

exportDataFormat

  • Type: typing.Optional[typing.List[typing.Literal['CSV']]]

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.ExportFilter]]

startTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

endTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

preferences

  • Type: typing.Optional[aws_resource_validator.pydantic_models.discovery.discovery_classes.ExportPreferences]

StartExportTaskResponse

exportId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartImportTaskRequest

name

  • Type:
  • Required: Yes

importUrl

  • Type:
  • Required: Yes

clientRequestToken

  • Type: typing.Optional[str]

StartImportTaskResponse

task

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopContinuousExportRequest

exportId

  • Type:
  • Required: Yes

StopContinuousExportResponse

startTime

  • Type:
  • Required: Yes

stopTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopDataCollectionByAgentIdsRequest

agentIds

  • Type: typing.List[str]
  • Required: Yes

StopDataCollectionByAgentIdsResponse

agentsConfigurationStatus

  • Type: typing.List[aws_resource_validator.pydantic_models.discovery.discovery_classes.AgentConfigurationStatus]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Tag

key

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

TagFilter

name

  • Type:
  • Required: Yes

values

  • Type: typing.List[str]
  • Required: Yes

UpdateApplicationRequest

configurationId

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

wave

  • Type: typing.Optional[str]

UsageMetricBasis

name

  • Type: typing.Optional[str]

percentageAdjust

  • Type: typing.Optional[float]