Amazon Application Discovery Service Agents API

openapi: 3.1.0
info:
  title: AWS Application Discovery Service Agents API
  version: '2015-11-01'
  description: Generated from AWS's published Smithy model for AWS Application Discovery Service. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://discovery.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#BatchDeleteAgents:
    post:
      operationId: BatchDeleteAgents
      summary: Batch Delete Agents
      description: Deletes one or more agents or collectors as specified by ID. Deleting an agent or collector does not delete
        the previously discovered data. To delete the data collected, use StartBatchDeleteConfigurationTask.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchDeleteAgentsResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: InvalidParameterException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.BatchDeleteAgents
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchDeleteAgentsRequest'
      tags:
      - Agents
  /#DescribeAgents:
    post:
      operationId: DescribeAgents
      summary: Describe Agents
      description: Lists agents or collectors as specified by ID or other filters. All agents/collectors associated with your
        user can be listed if you call DescribeAgents as is without passing any parameters.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAgentsResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.DescribeAgents
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAgentsRequest'
      tags:
      - Agents
  /#StartDataCollectionByAgentIds:
    post:
      operationId: StartDataCollectionByAgentIds
      summary: Start Data Collection By Agent Ids
      description: Instructs the specified agents to start collecting data.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartDataCollectionByAgentIdsResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.StartDataCollectionByAgentIds
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartDataCollectionByAgentIdsRequest'
      tags:
      - Agents
  /#StopDataCollectionByAgentIds:
    post:
      operationId: StopDataCollectionByAgentIds
      summary: Stop Data Collection By Agent Ids
      description: Instructs the specified agents to stop collecting data.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopDataCollectionByAgentIdsResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.StopDataCollectionByAgentIds
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopDataCollectionByAgentIdsRequest'
      tags:
      - Agents
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: discovery
  schemas:
    AgentConfigurationStatus:
      type: object
      properties:
        agentId:
          type: string
          description: The agent ID.
        operationSucceeded:
          type: boolean
          description: Information about the status of the StartDataCollection and StopDataCollection operations. The system
            has recorded the data collection operation. The agent receives this command the next time it polls for a new command.
        description:
          type: string
          description: A description of the operation performed.
    AgentInfo:
      type: object
      properties:
        agentId:
          type: string
          description: The agent or collector ID.
        hostName:
          type: string
          description: The name of the host where the agent or collector resides. The host can be a server or virtual machine.
        agentNetworkInfoList:
          type: array
          items:
            $ref: '#/components/schemas/AgentNetworkInfo'
          description: Network details about the host where the agent or collector resides.
        connectorId:
          type: string
          description: The ID of the connector.
        version:
          type: string
          description: The agent or collector version.
        health:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          - RUNNING
          - UNKNOWN
          - BLACKLISTED
          - SHUTDOWN
          description: The health of the agent.
        lastHealthPingTime:
          type: string
          description: Time since agent health was reported.
        collectionStatus:
          type: string
          description: Status of the collection process for an agent.
        agentType:
          type: string
          description: Type of agent.
        registeredTime:
          type: string
          description: Agent's first registration timestamp in UTC.
    AgentNetworkInfo:
      type: object
      properties:
        ipAddress:
          type: string
          description: The IP address for the host where the agent/collector resides.
        macAddress:
          type: string
          description: The MAC address for the host where the agent/collector resides.
    AuthorizationErrorException:
      type: object
      properties:
        message:
          type: string
    BatchDeleteAgentError:
      type: object
      properties:
        agentId:
          type: string
          description: The ID of the agent or data collector to delete.
        errorMessage:
          type: string
          description: The description of the error that occurred for the delete failed agent.
        errorCode:
          type: string
          enum:
          - NOT_FOUND
          - INTERNAL_SERVER_ERROR
          - AGENT_IN_USE
          description: 'The type of error that occurred for the delete failed agent. Valid status are: AGENT_IN_USE | NOT_FOUND
            | INTERNAL_SERVER_ERROR.'
      required:
      - agentId
      - errorMessage
      - errorCode
    BatchDeleteAgentsRequest:
      type: object
      properties:
        deleteAgents:
          type: array
          items:
            $ref: '#/components/schemas/DeleteAgent'
          description: The list of agents to delete.
      required:
      - deleteAgents
    BatchDeleteAgentsResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchDeleteAgentError'
          description: A list of agent IDs that failed to delete during the deletion task, each paired with an error message.
    DeleteAgent:
      type: object
      properties:
        agentId:
          type: string
          description: The ID of the agent or data collector to delete.
        force:
          type: boolean
          description: Optional flag used to force delete an agent or data collector. It is needed to delete any agent in
            HEALTHY/UNHEALTHY/RUNNING status. Note that deleting an agent that is actively reporting health causes it to be
            re-registered with a different agent ID after data collector re-connects with Amazon Web Services.
      required:
      - agentId
    DescribeAgentsRequest:
      type: object
      properties:
        agentIds:
          type: array
          items:
            type: string
          description: The agent or the collector IDs for which you want information. If you specify no IDs, the system returns
            information about all agents/collectors associated with your user.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'You can filter the request using various logical operators and a key-value format. For example: {"key":
            "collectionStatus", "value": "STARTED"}'
        maxResults:
          type: integer
          description: The total number of agents/collectors to return in a single page of output. The maximum value is 100.
        nextToken:
          type: string
          description: Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds
            but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that
            token in this query to get the next set of 10.
    DescribeAgentsResponse:
      type: object
      properties:
        agentsInfo:
          type: array
          items:
            $ref: '#/components/schemas/AgentInfo'
          description: Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you
            did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control
            (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of
            each agent/collector.
        nextToken:
          type: string
          description: Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds
            but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this
            token in the next query to retrieve the next set of 10.
    Filter:
      type: object
      properties:
        name:
          type: string
          description: The name of the filter.
        values:
          type: array
          items:
            type: string
          description: A string value on which to filter. For example, if you choose the destinationServer.osVersion filter
            name, you could specify Ubuntu for the value.
        condition:
          type: string
          description: 'A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS.
            If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify
            multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations
            or ListConfigurations returns attributes of matching configuration items.'
      required:
      - name
      - values
      - condition
    HomeRegionNotSetException:
      type: object
      properties:
        message:
          type: string
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
    ServerInternalErrorException:
      type: object
      properties:
        message:
          type: string
    StartDataCollectionByAgentIdsRequest:
      type: object
      properties:
        agentIds:
          type: array
          items:
            type: string
          description: The IDs of the agents from which to start collecting data. If you send a request to an agent ID that
            you do not have permission to contact, according to your Amazon Web Services account, the service does not throw
            an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents
            and you do not have permission to contact some of those agents, the system does not throw an exception. Instead,
            the system shows Failed in the Description field.
      required:
      - agentIds
    StartDataCollectionByAgentIdsResponse:
      type: object
      properties:
        agentsConfigurationStatus:
          type: array
          items:
            $ref: '#/components/schemas/AgentConfigurationStatus'
          description: Information about agents that were instructed to start collecting data. Information includes the agent
            ID, a description of the operation performed, and whether the agent configuration was updated.
    StopDataCollectionByAgentIdsRequest:
      type: object
      properties:
        agentIds:
          type: array
          items:
            type: string
          description: The IDs of the agents from which to stop collecting data.
      required:
      - agentIds
    StopDataCollectionByAgentIdsResponse:
      type: object
      properties:
        agentsConfigurationStatus:
          type: array
          items:
            $ref: '#/components/schemas/AgentConfigurationStatus'
          description: Information about the agents that were instructed to stop collecting data. Information includes the
            agent ID, a description of the operation performed, and whether the agent configuration was updated.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/application-discovery-service/service/2015-11-01/application-discovery-service-2015-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)