Amazon Application Discovery Service Configurations API

openapi: 3.1.0
info:
  title: Amazon Application Discovery Service Agents Configurations API
  description: AWS Application Discovery Service helps you plan your migration to AWS by collecting usage and configuration data about your on-premises servers, network infrastructure, and storage. Application Discovery Service enables you to understand the configuration, usage, and behavior of your servers and to develop a migration plan.
  version: '2015-11-01'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
  x-generated-from: documentation
  x-last-validated: '2026-04-19'
servers:
- url: https://discovery.us-east-1.amazonaws.com
  description: AWS Application Discovery Service endpoint
security:
- sigv4: []
tags:
- name: Configurations
  description: Operations for querying discovered configuration items
paths:
  /v1/describeConfigurations:
    post:
      operationId: describeConfigurations
      summary: Amazon Application Discovery Service Describe Configurations
      description: Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type from one of the following — server, application, process, or connection. Output fields are specific to the asset type.
      tags:
      - Configurations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConfigurationsRequest'
            examples:
              DescribeConfigurationsRequestExample:
                summary: Default describeConfigurations request
                x-microcks-default: true
                value:
                  configurationIds:
                  - d-SERVER-500456
                  - d-SERVER-500457
      responses:
        '200':
          description: Configurations described successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConfigurationsResponse'
              examples:
                DescribeConfigurations200Example:
                  summary: Default describeConfigurations 200 response
                  x-microcks-default: true
                  value:
                    configurations:
                    - configurationId: d-SERVER-500456
                      hostName: server-01.example.com
                      osName: Linux
                      osVersion: Ubuntu 20.04
                      cpuType: Intel Xeon
                      totalRamInMB: '32768'
                      totalDiskSizeInGB: '500'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/listConfigurations:
    post:
      operationId: listConfigurations
      summary: Amazon Application Discovery Service List Configurations
      description: Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.
      tags:
      - Configurations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConfigurationsRequest'
            examples:
              ListConfigurationsRequestExample:
                summary: Default listConfigurations request
                x-microcks-default: true
                value:
                  configurationType: SERVER
                  maxResults: 10
      responses:
        '200':
          description: Configurations listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConfigurationsResponse'
              examples:
                ListConfigurations200Example:
                  summary: Default listConfigurations 200 response
                  x-microcks-default: true
                  value:
                    configurations:
                    - configurationId: d-SERVER-500456
                      hostName: server-01.example.com
                      osName: Linux
                    nextToken: ''
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/getDiscoverySummary:
    post:
      operationId: getDiscoverySummary
      summary: Amazon Application Discovery Service Get Discovery Summary
      description: Retrieves a short summary of discovered assets. This API operation takes no request parameters and is called as is at the command prompt.
      tags:
      - Configurations
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Discovery summary returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDiscoverySummaryResponse'
              examples:
                GetDiscoverySummary200Example:
                  summary: Default getDiscoverySummary 200 response
                  x-microcks-default: true
                  value:
                    servers: 42
                    mappedServerCount: 15
                    unmappedServerCount: 27
                    applications: 5
                    serversMappedToApplications: 15
                    serversMappedtoTags: 30
                    agentSummary:
                      activeAgents: 3
                      healthyAgents: 3
                      blackListedAgents: 0
                      shutdownAgents: 0
                      unhealthyAgents: 0
                      totalAgents: 3
                      unknownAgents: 0
                    connectorSummary:
                      activeConnectors: 0
                      healthyConnectors: 0
                      blackListedConnectors: 0
                      shutdownConnectors: 0
                      unhealthyConnectors: 0
                      totalConnectors: 0
                      unknownConnectors: 0
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/listServerNeighbors:
    post:
      operationId: listServerNeighbors
      summary: Amazon Application Discovery Service List Server Neighbors
      description: Retrieves a list of servers that are one network hop away from a specified server.
      tags:
      - Configurations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListServerNeighborsRequest'
            examples:
              ListServerNeighborsRequestExample:
                summary: Default listServerNeighbors request
                x-microcks-default: true
                value:
                  configurationId: d-SERVER-500456
                  maxResults: 10
      responses:
        '200':
          description: Server neighbors listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListServerNeighborsResponse'
              examples:
                ListServerNeighbors200Example:
                  summary: Default listServerNeighbors 200 response
                  x-microcks-default: true
                  value:
                    neighbors:
                    - sourceServerId: d-SERVER-500456
                      destinationServerId: d-SERVER-500457
                      connectionsCount: 125
                      transportProtocol: TCP
                      destinationPort: 443
                    knownDependencyCount: 1
                    nextToken: ''
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/startBatchDeleteConfigurationTask:
    post:
      operationId: startBatchDeleteConfigurationTask
      summary: Amazon Application Discovery Service Start Batch Delete Configuration Task
      description: Takes a list of configurationIds as input and starts an asynchronous deletion task to remove the specified configuration items and their relationships.
      tags:
      - Configurations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartBatchDeleteConfigurationTaskRequest'
            examples:
              StartBatchDeleteConfigurationTaskRequestExample:
                summary: Default startBatchDeleteConfigurationTask request
                x-microcks-default: true
                value:
                  configurationType: SERVER
                  configurationIds:
                  - d-SERVER-500456
      responses:
        '200':
          description: Batch delete task started successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartBatchDeleteConfigurationTaskResponse'
              examples:
                StartBatchDeleteConfigurationTask200Example:
                  summary: Default startBatchDeleteConfigurationTask 200 response
                  x-microcks-default: true
                  value:
                    taskId: task-500123
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/describeBatchDeleteConfigurationTask:
    post:
      operationId: describeBatchDeleteConfigurationTask
      summary: Amazon Application Discovery Service Describe Batch Delete Configuration Task
      description: Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
      tags:
      - Configurations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeBatchDeleteConfigurationTaskRequest'
            examples:
              DescribeBatchDeleteConfigurationTaskRequestExample:
                summary: Default describeBatchDeleteConfigurationTask request
                x-microcks-default: true
                value:
                  taskId: task-500123
      responses:
        '200':
          description: Batch delete task described successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeBatchDeleteConfigurationTaskResponse'
              examples:
                DescribeBatchDeleteConfigurationTask200Example:
                  summary: Default describeBatchDeleteConfigurationTask 200 response
                  x-microcks-default: true
                  value:
                    task:
                      taskId: task-500123
                      status: COMPLETE
                      startTime: '2026-04-19T10:00:00Z'
                      endTime: '2026-04-19T10:05:00Z'
                      configurationType: SERVER
                      requestedConfigurations:
                      - d-SERVER-500456
                      deletedConfigurations:
                      - d-SERVER-500456
                      failedConfigurations: []
                      deletionWarnings: []
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GetDiscoverySummaryResponse:
      type: object
      properties:
        servers:
          type: integer
          description: The number of servers discovered.
          example: 42
        applications:
          type: integer
          description: The number of applications discovered.
          example: 5
        serversMappedToApplications:
          type: integer
          description: The number of servers mapped to applications.
          example: 15
        serversMappedtoTags:
          type: integer
          description: The number of servers mapped to tags.
          example: 30
        mappedServerCount:
          type: integer
          description: The number of servers mapped to applications or tags.
          example: 15
        unmappedServerCount:
          type: integer
          description: The number of servers not mapped to any application.
          example: 27
        agentSummary:
          $ref: '#/components/schemas/CustomerAgentInfo'
        connectorSummary:
          $ref: '#/components/schemas/CustomerConnectorInfo'
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: The error message describing what went wrong.
          example: The specified resource was not found.
        code:
          type: string
          description: The error code.
          example: ResourceNotFoundException
    Filter:
      type: object
      required:
      - name
      - values
      - condition
      properties:
        name:
          type: string
          description: The name of the filter.
          example: hostName
        values:
          type: array
          description: A string value on which to filter.
          items:
            type: string
          example:
          - server-01.example.com
        condition:
          type: string
          description: A conditional operator. The following operators are valid — EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS.
          enum:
          - EQUALS
          - NOT_EQUALS
          - CONTAINS
          - NOT_CONTAINS
          example: EQUALS
    BatchDeleteConfigurationTask:
      type: object
      properties:
        taskId:
          type: string
          description: The deletion task's unique identifier.
          example: task-500123
        status:
          type: string
          description: The current execution status of the deletion task.
          enum:
          - INITIALIZING
          - VALIDATING
          - DELETING
          - COMPLETED
          - FAILED
          example: COMPLETED
        startTime:
          type: string
          description: An epoch seconds timestamp (Unix) of when the deletion task was started.
          example: '2026-04-19T10:00:00Z'
        endTime:
          type: string
          description: An epoch seconds timestamp (Unix) of when the deletion task was completed.
          example: '2026-04-19T10:05:00Z'
        configurationType:
          type: string
          description: The type of configuration item to delete.
          example: SERVER
        requestedConfigurations:
          type: array
          description: The list of configuration IDs that were originally requested to be deleted by this task.
          items:
            type: string
          example:
          - d-SERVER-500456
        deletedConfigurations:
          type: array
          description: The list of configuration IDs that were successfully deleted by this task.
          items:
            type: string
          example:
          - d-SERVER-500456
        failedConfigurations:
          type: array
          description: A list of configuration IDs that produced an associated error.
          items:
            $ref: '#/components/schemas/FailedConfiguration'
        deletionWarnings:
          type: array
          description: A list of warnings associated with this deletion task.
          items:
            $ref: '#/components/schemas/DeletionWarning'
    DeletionWarning:
      type: object
      properties:
        configurationId:
          type: string
          description: The configuration ID of the configuration item associated with the deletion warning.
          example: d-SERVER-500456
        warningCode:
          type: integer
          description: The integer warning code associated with the warning message.
          example: 1
        warningText:
          type: string
          description: A descriptive message of the warning the associated configuration item produced.
          example: Configuration item may have dependencies
    OrderByElement:
      type: object
      required:
      - fieldName
      properties:
        fieldName:
          type: string
          description: The field on which to order.
          example: hostName
        sortOrder:
          type: string
          description: Ordering direction.
          enum:
          - ASC
          - DESC
          example: ASC
    DescribeBatchDeleteConfigurationTaskRequest:
      type: object
      required:
      - taskId
      properties:
        taskId:
          type: string
          description: The ID of the task to delete.
          example: task-500123
    StartBatchDeleteConfigurationTaskResponse:
      type: object
      properties:
        taskId:
          type: string
          description: The unique ID associated with the task.
          example: task-500123
    ListConfigurationsResponse:
      type: object
      properties:
        configurations:
          type: array
          description: Returns configuration details, including the configuration ID, attribute names, and attribute values.
          items:
            type: object
            additionalProperties:
              type: string
        nextToken:
          type: string
          description: Token to retrieve the next set of results.
          example: ''
    FailedConfiguration:
      type: object
      properties:
        configurationId:
          type: string
          description: The configuration ID of the configuration that failed to delete.
          example: d-SERVER-500456
        errorStatusCode:
          type: integer
          description: The error status code.
          example: 404
        errorMessage:
          type: string
          description: A descriptive message indicating why the associated configuration failed to delete.
          example: Configuration item not found
    DescribeBatchDeleteConfigurationTaskResponse:
      type: object
      properties:
        task:
          $ref: '#/components/schemas/BatchDeleteConfigurationTask'
    DescribeConfigurationsRequest:
      type: object
      required:
      - configurationIds
      properties:
        configurationIds:
          type: array
          description: One or more configuration IDs.
          items:
            type: string
          example:
          - d-SERVER-500456
    DescribeConfigurationsResponse:
      type: object
      properties:
        configurations:
          type: array
          description: A key in the response map. The value is an array of data.
          items:
            type: object
            additionalProperties:
              type: string
    StartBatchDeleteConfigurationTaskRequest:
      type: object
      required:
      - configurationType
      - configurationIds
      properties:
        configurationType:
          type: string
          description: The type of configuration item to delete. Supported types are SERVER.
          enum:
          - SERVER
          example: SERVER
        configurationIds:
          type: array
          description: The list of configuration IDs that will be deleted by this task.
          items:
            type: string
          example:
          - d-SERVER-500456
    NeighborConnectionDetail:
      type: object
      required:
      - sourceServerId
      - destinationServerId
      - connectionsCount
      properties:
        sourceServerId:
          type: string
          description: The ID of the server that opened the network connection.
          example: d-SERVER-500456
        destinationServerId:
          type: string
          description: The ID of the server that accepted the network connection.
          example: d-SERVER-500457
        destinationPort:
          type: integer
          description: The destination network port for the connection.
          example: 443
        transportProtocol:
          type: string
          description: The network protocol used for the connection.
          example: TCP
        connectionsCount:
          type: integer
          format: int64
          description: The number of open network connections with the neighboring server.
          example: 125
    ListServerNeighborsResponse:
      type: object
      properties:
        neighbors:
          type: array
          description: List of distinct servers that are one hop away from the given server.
          items:
            $ref: '#/components/schemas/NeighborConnectionDetail'
        nextToken:
          type: string
          description: Token to retrieve the next set of results.
          example: ''
        knownDependencyCount:
          type: integer
          description: Count of distinct servers that are one hop away from the given server.
          example: 1
    CustomerAgentInfo:
      type: object
      properties:
        activeAgents:
          type: integer
          description: Number of active discovery agents.
          example: 3
        healthyAgents:
          type: integer
          description: Number of healthy discovery agents.
          example: 3
        blackListedAgents:
          type: integer
          description: Number of blacklisted discovery agents.
          example: 0
        shutdownAgents:
          type: integer
          description: Number of discovery agents with status SHUTDOWN.
          example: 0
        unhealthyAgents:
          type: integer
          description: Number of unhealthy discovery agents.
          example: 0
        totalAgents:
          type: integer
          description: Total number of discovery agents.
          example: 3
        unknownAgents:
          type: integer
          description: Number of unknown discovery agents.
          example: 0
    ListServerNeighborsRequest:
      type: object
      required:
      - configurationId
      properties:
        configurationId:
          type: string
          description: Configuration ID of the server for which neighbors are being listed.
          example: d-SERVER-500456
        portInformationNeeded:
          type: boolean
          description: Flag to indicate if port and protocol information is needed as part of the response.
          example: false
        neighborConfigurationIds:
          type: array
          description: List of configuration IDs to test for one-hop-away. Mandatory parameter when PortInformationNeeded is true.
          items:
            type: string
          example:
          - d-SERVER-500457
        maxResults:
          type: integer
          description: Maximum number of results to return in a single page of output.
          example: 10
        nextToken:
          type: string
          description: Token to retrieve the next set of results.
          example: ''
    ListConfigurationsRequest:
      type: object
      required:
      - configurationType
      properties:
        configurationType:
          type: string
          description: A valid configuration identified by Application Discovery Service.
          enum:
          - SERVER
          - PROCESS
          - CONNECTION
          - APPLICATION
          example: SERVER
        filters:
          type: array
          description: You can filter the list using a key-value format.
          items:
            $ref: '#/components/schemas/Filter'
        maxResults:
          type: integer
          description: The total number of items to return. The maximum value is 100.
          minimum: 0
          maximum: 100
          example: 10
        nextToken:
          type: string
          description: Token to retrieve the next set of results.
          example: ''
        orderBy:
          type: array
          description: Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.
          items:
            $ref: '#/components/schemas/OrderByElement'
    CustomerConnectorInfo:
      type: object
      properties:
        activeConnectors:
          type: integer
          description: Number of active discovery connectors.
          example: 0
        healthyConnectors:
          type: integer
          description: Number of healthy discovery connectors.
          example: 0
        blackListedConnectors:
          type: integer
          description: Number of blacklisted discovery connectors.
          example: 0
        shutdownConnectors:
          type: integer
          description: Number of discovery connectors with status SHUTDOWN.
          example: 0
        unhealthyConnectors:
          type: integer
          description: Number of unhealthy discovery connectors.
          example: 0
        totalConnectors:
          type: integer
          description: Total number of discovery connectors.
          example: 0
        unknownConnectors:
          type: integer
          description: Number of unknown discovery connectors.
          example: 0
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication