find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-datasync:amazon-datasync-agent-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS DataSync Agent API
  version: '2018-11-09'
  description: Generated from AWS's published Smithy model for AWS DataSync. 5 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://datasync.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Agent
paths:
  /#DeleteAgent:
    post:
      operationId: DeleteAgent
      summary: Delete Agent
      description: Removes an DataSync agent resource from your Amazon Web Services account. Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAgentResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - FmrsService.DeleteAgent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAgentRequest'
      tags:
      - Agent
  /#DescribeAgent:
    post:
      operationId: DescribeAgent
      summary: Describe Agent
      description: Returns information about an DataSync agent, such as its name, service endpoint type, and status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAgentResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - FmrsService.DescribeAgent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAgentRequest'
      tags:
      - Agent
  /#ListAgents:
    post:
      operationId: ListAgents
      summary: List Agents
      description: Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request. With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents. ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAgentsResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - FmrsService.ListAgents
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAgentsRequest'
      tags:
      - Agent
  /#UpdateAgent:
    post:
      operationId: UpdateAgent
      summary: Update Agent
      description: Updates the name of an DataSync agent.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateAgentResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - FmrsService.UpdateAgent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateAgentRequest'
      tags:
      - Agent
components:
  schemas:
    UpdateAgentRequest:
      type: object
      properties:
        AgentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the agent to update.
        Name:
          type: string
          description: The name that you want to use to configure the agent.
      required:
      - AgentArn
    PrivateLinkConfig:
      type: object
      properties:
        VpcEndpointId:
          type: string
          description: Specifies the ID of the VPC service endpoint that's recorded for your agent. The endpoint ID is informational and isn't verified by DataSync. Your agent communicates through the private IP address in PrivateLinkEndpoint, which is set when you activate the agent.
        PrivateLinkEndpoint:
          type: string
          description: Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.
        SubnetArns:
          type: array
          items:
            type: string
          description: Specifies the ARN of the subnet where DataSync creates the network interfaces that handle data transfer traffic for your tasks. You can only specify one ARN. The subnet doesn't have to be the subnet that contains your VPC endpoint.
        SecurityGroupArns:
          type: array
          items:
            type: string
          description: Specifies the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN.
    Platform:
      type: object
      properties:
        Version:
          type: string
          description: The version of the DataSync agent.
    ListAgentsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: Specifies the maximum number of DataSync agents to list in a response. By default, a response shows a maximum of 100 agents.
        NextToken:
          type: string
          description: Specifies an opaque string that indicates the position to begin the next list of results in the response.
    DeleteAgentRequest:
      type: object
      properties:
        AgentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.
      required:
      - AgentArn
    DescribeAgentRequest:
      type: object
      properties:
        AgentArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want information about.
      required:
      - AgentArn
    AgentListEntry:
      type: object
      properties:
        AgentArn:
          type: string
          description: The Amazon Resource Name (ARN) of a DataSync agent.
        Name:
          type: string
          description: The name of an agent.
        Status:
          type: string
          enum:
          - ONLINE
          - OFFLINE
          description: The status of an agent. If the status is ONLINE, the agent is configured properly and ready to use. If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?
        Platform:
          $ref: '#/components/schemas/Platform'
    DeleteAgentResponse:
      type: object
      properties: {}
    UpdateAgentResponse:
      type: object
      properties: {}
    ListAgentsResponse:
      type: object
      properties:
        Agents:
          type: array
          items:
            $ref: '#/components/schemas/AgentListEntry'
          description: A list of DataSync agents in your Amazon Web Services account in the Amazon Web Services Region specified in the request. The list is ordered by the agents' Amazon Resource Names (ARNs).
        NextToken:
          type: string
          description: The opaque string that indicates the position to begin the next list of results in the response.
    DescribeAgentResponse:
      type: object
      properties:
        AgentArn:
          type: string
          description: The ARN of the agent.
        Name:
          type: string
          description: The name of the agent.
        Status:
          type: string
          enum:
          - ONLINE
          - OFFLINE
          description: The status of the agent. If the status is ONLINE, the agent is configured properly and ready to use. If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?
        LastConnectionTime:
          type: string
          format: date-time
          description: The last time that the agent was communicating with the DataSync service.
        CreationTime:
          type: string
          format: date-time
          description: The time that the agent was activated.
        EndpointType:
          type: string
          enum:
          - PUBLIC
          - PRIVATE_LINK
          - FIPS
          - FIPS_PRIVATE_LINK
          description: The type of service endpoint that your agent is connected to.
        PrivateLinkConfig:
          $ref: '#/components/schemas/PrivateLinkConfig'
        Platform:
          $ref: '#/components/schemas/Platform'
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
        datasyncErrorCode:
          type: string
    InternalException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
  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: datasync
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datasync/service/2018-11-09/datasync-2018-11-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)