How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Application Discovery Service Agents API

Operations for managing discovery agents and collectors

Amazon Application Discovery Service Agents API is one of 6 APIs that Amazon Application Discovery Service publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, a JSON-LD context, sample payloads, and 6 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 2015-11-01.

Requests are made against a single base URL, https://discovery.us-east-1.amazonaws.com.

4 operations 4 paths 15 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2015-11-01
Base URL
https://discovery.us-east-1.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Amazon Application Discovery Service Agents API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (sigv4). By default, every request must be authenticated.

  • sigv4 — AWS Signature Version 4 authentication

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Agents 4

Operations for managing discovery agents and collectors

POST
/v1/describeAgents
Amazon Application Discovery Service Describe Agents
describeAgents body → 200400500
POST
/v1/batchDeleteAgents
Amazon Application Discovery Service Batch Delete Agents
batchDeleteAgents body → 200400500
POST
/v1/startDataCollectionByAgentIds
Amazon Application Discovery Service Start Data Collection by Agent IDs
startDataCollectionByAgentIds body → 200400500
POST
/v1/stopDataCollectionByAgentIds
Amazon Application Discovery Service Stop Data Collection by Agent IDs
stopDataCollectionByAgentIds body → 200400500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are AgentInfo (10 properties), DescribeAgentsRequest (4 properties), Filter (3 properties), AgentConfigurationStatus (3 properties). Each schema is shown below with its type and property counts.

StopDataCollectionByAgentIdsRequest
object
1 property 1 required
DescribeAgentsRequest
object
4 properties
AgentConfigurationStatus
object
3 properties
StartDataCollectionByAgentIdsResponse
object
1 property
BatchDeleteAgentsResponse
object
1 property
StopDataCollectionByAgentIdsResponse
object
1 property
ErrorResponse
object
2 properties
DescribeAgentsResponse
object
2 properties
AgentNetworkInfo
object
2 properties
BatchDeleteAgentError
object
3 properties
BatchDeleteAgentsRequest
object
1 property 1 required
DeleteAgent
object
2 properties 1 required
AgentInfo
object
10 properties
Filter
object
3 properties 3 required
StartDataCollectionByAgentIdsRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-application-discovery-service-agents-api-openapi.yml Raw ↑

Other APIs Amazon Application Discovery Service publishes across the network.

Amazon Application Discovery Service Applications API
Amazon Application Discovery Service Configurations API
Amazon Application Discovery Service Exports API
Amazon Application Discovery Service Imports API
Amazon Application Discovery Service Tags API
Where this information came from

This is an independent, third-party profile of Amazon Application Discovery Service Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.