Amazon RDS

Amazon RDS Rds Db Proxy Target API

The Rds Db Proxy Target API from Amazon RDS — 3 operation(s) for rds db proxy target.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 3

POST /?Action=DeregisterDBProxyTargets Deregister DBProxy Targets #
POST /?Action=DescribeDBProxyTargets Describe DBProxy Targets #
POST /?Action=RegisterDBProxyTargets Register DBProxy Targets #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-rds/openapi/amazon-rds-db-proxy-target-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-rds:amazon-rds-db-proxy-target-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

amazon-rds-db-proxy-target-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Relational Database Service Db Proxy Target API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 3 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Db Proxy Target
paths:
  /?Action=DeregisterDBProxyTargets:
    post:
      operationId: DeregisterDBProxyTargets
      summary: Deregister DBProxy Targets
      description: Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeregisterDBProxyTargetsResponse'
        '404':
          description: DBProxyNotFoundFault; DBProxyTargetGroupNotFoundFault; DBProxyTargetNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyNotFoundFault'
        '400':
          description: InvalidDBProxyStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBProxyStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeregisterDBProxyTargets
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeregisterDBProxyTargetsRequest'
      tags:
      - Db Proxy Target
  /?Action=DescribeDBProxyTargets:
    post:
      operationId: DescribeDBProxyTargets
      summary: Describe DBProxy Targets
      description: Returns information about DBProxyTarget objects. This API supports pagination.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeDBProxyTargetsResponse'
        '404':
          description: DBProxyNotFoundFault; DBProxyTargetGroupNotFoundFault; DBProxyTargetNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyNotFoundFault'
        '400':
          description: InvalidDBProxyStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBProxyStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeDBProxyTargets
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBProxyTargetsRequest'
      tags:
      - Db Proxy Target
  /?Action=RegisterDBProxyTargets:
    post:
      operationId: RegisterDBProxyTargets
      summary: Register DBProxy Targets
      description: Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/RegisterDBProxyTargetsResponse'
        '404':
          description: DBClusterNotFoundFault; DBInstanceNotFoundFault; DBProxyNotFoundFault; DBProxyTargetGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
        '400':
          description: DBProxyTargetAlreadyRegisteredFault; InsufficientAvailableIPsInSubnetFault; InvalidDBClusterStateFault; InvalidDBInstanceStateFault; InvalidDBProxyStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyTargetAlreadyRegisteredFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: RegisterDBProxyTargets
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/RegisterDBProxyTargetsRequest'
      tags:
      - Db Proxy Target
components:
  schemas:
    DeregisterDBProxyTargetsResponse:
      type: object
      properties: {}
    DBProxyNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DescribeDBProxyTargetsResponse:
      type: object
      properties:
        Targets:
          type: array
          items:
            $ref: '#/components/schemas/DBProxyTarget'
          description: An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: One or more filter values. Filter values are case-sensitive.
      required:
      - Name
      - Values
    RegisterDBProxyTargetsRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
        TargetGroupName:
          type: string
          description: The identifier of the DBProxyTargetGroup.
        DBInstanceIdentifiers:
          type: array
          items:
            type: string
          description: One or more DB instance identifiers.
        DBClusterIdentifiers:
          type: array
          items:
            type: string
          description: One or more DB cluster identifiers.
      required:
      - DBProxyName
    DeregisterDBProxyTargetsRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
        TargetGroupName:
          type: string
          description: The identifier of the DBProxyTargetGroup.
        DBInstanceIdentifiers:
          type: array
          items:
            type: string
          description: One or more DB instance identifiers.
        DBClusterIdentifiers:
          type: array
          items:
            type: string
          description: One or more DB cluster identifiers.
      required:
      - DBProxyName
    DBProxyTarget:
      type: object
      properties:
        TargetArn:
          type: string
          description: The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
        Endpoint:
          type: string
          description: The writer endpoint for the RDS DB instance or Aurora DB cluster.
        TrackedClusterId:
          type: string
          description: The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
        RdsResourceId:
          type: string
          description: The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
        Port:
          type: integer
          description: The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
        Type:
          type: string
          enum:
          - RDS_INSTANCE
          - RDS_SERVERLESS_ENDPOINT
          - TRACKED_CLUSTER
          description: Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
        Role:
          type: string
          enum:
          - READ_WRITE
          - READ_ONLY
          - UNKNOWN
          description: A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
        TargetHealth:
          $ref: '#/components/schemas/TargetHealth'
    DescribeDBProxyTargetsRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The identifier of the DBProxyTarget to describe.
        TargetGroupName:
          type: string
          description: The identifier of the DBProxyTargetGroup to describe.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: This parameter is not currently supported.
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        MaxRecords:
          type: integer
          description: 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.'
      required:
      - DBProxyName
    DBProxyTargetAlreadyRegisteredFault:
      type: object
      properties:
        message:
          type: string
    TargetHealth:
      type: object
      properties:
        State:
          type: string
          enum:
          - REGISTERING
          - AVAILABLE
          - UNAVAILABLE
          - UNUSED
          description: 'The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target: registering > unavailable > available > unavailable > available'
        Reason:
          type: string
          enum:
          - UNREACHABLE
          - CONNECTION_FAILED
          - AUTH_FAILURE
          - PENDING_PROXY_CAPACITY
          - INVALID_REPLICATION_STATE
          - PROMOTED
          description: The reason for the current health State of the RDS Proxy target.
        Description:
          type: string
          description: A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.
    RegisterDBProxyTargetsResponse:
      type: object
      properties:
        DBProxyTargets:
          type: array
          items:
            $ref: '#/components/schemas/DBProxyTarget'
          description: One or more DBProxyTarget objects that are created when you register targets with a target group.
    InvalidDBProxyStateFault:
      type: object
      properties:
        message:
          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: rds
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/rds/service/2014-10-31/rds-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)