Menu
AWS Application Discovery Service
API Reference (API Version 2015-11-01)

Querying Discovered Configuration Items

A configuration itemis an IT asset that was discovered in your data center by an agent or the connector. When you use Application Discovery Service, you can specify filters and query specific configuration items for server, application, process, and connection assets.

The tables in the following sections list the available input filters and output sorting options for two Application Discovery Service actions:

  • DescribeConfigurations

  • ListConfigurations

The filtering and sorting options are organized by the type of asset to which apply (server, application, process, or connection).

Using the DescribeConfigurationsAction

The DescribeConfigurationsaction retrieves attributes for a list of configuration IDs. All the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards. For more information about command syntax, see DescribeConfigurations.

The DescribeConfigurationsaction does not support filtering.

Output fields for DescribeConfigurations

The following tables, organized by asset type, list the supported output fields of the DescribeConfigurationsaction. The ones marked as mandatory are always present in the output.

Server assets

Field Mandatory
server.agentId
server.applications
server.applications.hasMoreValues
server.configurationId
server.cpuType
server.hostName
server.hypervisor
server.networkInterfaceInfo
server.networkInterfaceInfo.hasMoreValues
server.osName
server.osVersion
server.tags
server.tags.hasMoreValues
server.timeOfCreation
server.type
server.performance.avgCpuUsagePct
server.performance.avgDiskReadIOPS
server.performance.avgDiskReadsPerSecondInKB
server.performance.avgDiskWriteIOPS
server.performance.avgDiskWritesPerSecondInKB
server.performance.avgFreeRAMInKB
server.performance.avgNetworkReadsPerSecondInKB
server.performance.avgNetworkWritesPerSecondInKB
server.performance.maxCpuUsagePct
server.performance.maxDiskReadIOPS
server.performance.maxDiskReadsPerSecondInKB
server.performance.maxDiskWriteIOPS
server.performance.maxDiskWritesPerSecondInKB
server.performance.maxNetworkReadsPerSecondInKB
server.performance.maxNetworkWritesPerSecondInKB
server.performance.minFreeRAMInKB
server.performance.numCores
server.performance.numCpus
server.performance.numDisks
server.performance.numNetworkCards
server.performance.totalRAMInKB

Process assets

Field Mandatory
process.commandLine
process.configurationId
process.name
process.path
process.timeOfCreation

Application assets

Field Mandatory
application.configurationId
application.description
application.lastModifiedTime
application.name
application.serverCount
application.timeOfCreation

Using the ListConfigurationsAction

The ListConfigurationsaction retrieves a list of configuration items according to the criteria that you specify in a filter. For more information about command syntax, see ListConfigurations.

Output fields for ListConfigurations

The following tables, organized by asset type, list the supported output fields of the ListConfigurationsaction. The ones marked as mandatory are always present in the output.

Server assets

Field Mandatory
server.configurationId
server.agentId
server.hostName
server.osName
server.osVersion
server.timeOfCreation
server.type

Process assets

Field Mandatory
process.commandLine
process.configurationId
process.name
process.path
process.timeOfCreation
server.agentId
server.configurationId

Application assets

Field Mandatory
application.configurationId
application.description
application.name
application.serverCount
application.timeOfCreation
application.lastModifiedTime

Connection assets

Field Mandatory
connection.destinationIp
connection.destinationPort
connection.ipVersion
connection.latestTimestamp
connection.occurrence
connection.sourceIp
connection.transportProtocol
destinationProcess.configurationId
destinationProcess.name
destinationServer.configurationId
destinationServer.hostName
sourceProcess.configurationId
sourceProcess.name
sourceServer.configurationId
sourceServer.hostName

Supported filters for ListConfigurations

The following tables, organized by asset type, list the supported filters for the ListConfigurationsaction. Filters and values are in a key/value relationship defined by one of the supported logical conditions. You can sort the output of the indicated filters.

Server assets

Filter

Supported conditions

Supported values

Supported sorting

server.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • Any valid server configuration ID

None
server.hostName
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

server.osName
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

server.osVersion
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

server.agentId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • String

None
server.connectorId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • String

None
server.type
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

String with one of the following values:
  • EC2

  • OTHER

  • VMWARE_VM

  • VMWARE_HOST

  • VMWARE_VM_TEMPLATE

None
server.vmWareInfo.morefId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.vmWareInfo.vcenterId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.vmWareInfo.hostId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.networkInterfaceInfo.portGroupId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.networkInterfaceInfo.portGroupName
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.networkInterfaceInfo.virtualSwitchName
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.networkInterfaceInfo.ipAddress
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.networkInterfaceInfo.macAddress
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.performance.avgCpuUsagePct
  • GE
  • LE
  • GT
  • LT
  • Percentage

None
server.performance.totalDiskFreeSizeInKB
  • GE

  • LE

  • GT

  • LT

  • Double

None
server.performance.avgFreeRAMInKB
  • GE

  • LE

  • GT

  • LT

  • Double

None
server.tag.value
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.tag.key
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.application.name
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.application.description
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None
server.application.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • Any valid application configuration ID

None

server.process.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ProcessId

None

server.process.name

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None

server.process.commandLine
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

None

Application assets

Filter

Supported conditions

Supported values

Supported sorting

application.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ApplicationId

None
application.name
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

application.description
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

application.serverCount Filtering not supported. Filtering not supported.
  • ASC

  • DESC

application.timeOfCreation Filtering not supported. Filtering not supported.
  • ASC

  • DESC

application.lastModifiedTime Filtering not supported. Filtering not supported
  • ASC

  • DESC

server.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ServerId

None

Process assets

Filter

Supported conditions

Supported values

Supported sorting

process.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ProcessId

process.name
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

process.commandLine
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

server.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ServerId

server.hostName
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

server.osName
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

server.osVersion
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

server.agentId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

Connection assets

Filter

Supported conditions

Supported values

Supported sorting

connection.sourceIp
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • IP

  • ASC

  • DESC

connection.destinationIp
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • IP

  • ASC

  • DESC

connection.destinationPort
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • Integer

  • ASC

  • DESC

sourceServer.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ServerId

sourceServer.hostName
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

destinationServer.osName
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

destinationServer.osVersion
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

destinationServer.agentId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

sourceProcess.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ProcessId

sourceProcess.name
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

sourceProcess.commandLine
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

destinationProcess.configurationId
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ProcessId

destinationProcess.name
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

destinationprocess.commandLine
  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC