Amazon Bedrock Bedrock Connectors API

The Bedrock Connectors API from Amazon Bedrock — 2 operation(s) for bedrock connectors.

GitHub OpenAPI

Operations 4

POST /payments/managers/{paymentManagerId}/connectors Create Payment Connector #
GET /payments/managers/{paymentManagerId}/connectors/{paymentConnectorId} Get Payment Connector #
PATCH /payments/managers/{paymentManagerId}/connectors/{paymentConnectorId} Update Payment Connector #
DELETE /payments/managers/{paymentManagerId}/connectors/{paymentConnectorId} Delete Payment Connector #

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-bedrock:amazon-bedrock-connectors-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.

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

OpenAPI Specification

amazon-bedrock-connectors-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Bedrock Connectors API
  version: '2023-04-20'
  description: Generated from AWS's published Smithy model for Amazon Bedrock. 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://bedrock-agentcore-control.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /payments/managers/{paymentManagerId}/connectors:
    post:
      operationId: CreatePaymentConnector
      summary: Create Payment Connector
      description: Creates a new payment connector for a payment manager. A payment connector integrates with a supported
        payment provider to enable payment processing capabilities.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentConnectorResponse'
        '403':
          description: AccessDeniedException; SubscriptionRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentcoreControlValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentConnectorRequest'
      tags:
      - Connectors
  /payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}:
    get:
      operationId: GetPaymentConnector
      summary: Get Payment Connector
      description: Retrieves information about a specific payment connector.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentConnectorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentcoreControlValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPaymentConnectorRequest'
      tags:
      - Connectors
    patch:
      operationId: UpdatePaymentConnector
      summary: Update Payment Connector
      description: Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify
        the fields you want to change.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePaymentConnectorResponse'
        '403':
          description: AccessDeniedException; SubscriptionRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentcoreControlValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePaymentConnectorRequest'
      tags:
      - Connectors
    delete:
      operationId: DeletePaymentConnector
      summary: Delete Payment Connector
      description: Deletes a payment connector.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePaymentConnectorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeletePaymentConnectorRequest'
      tags:
      - Connectors
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: bedrock-agentcore
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    BedrockAgentcoreControlValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CannotParse
          - FieldValidationFailed
          - IdempotentParameterMismatchException
          - EventInOtherSession
          - ResourceConflict
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
      required:
      - message
      - reason
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreatePaymentConnectorRequest:
      type: object
      properties:
        paymentManagerId:
          type: string
          description: The unique identifier of the payment manager to create the connector for.
        name:
          type: string
          description: The name of the payment connector.
        description:
          type: string
          description: A description of the payment connector.
        type:
          type: string
          enum:
          - CoinbaseCDP
          - StripePrivy
          description: The type of payment connector, which determines the payment provider integration.
        credentialProviderConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/CredentialsProviderConfiguration'
          description: The credential provider configurations for the payment connector. These configurations specify how
            the connector authenticates with the payment provider.
        provisionMode:
          type: string
          enum:
          - MANUAL
          - QUICK_CREATE
          description: The provision mode for creating the payment connector. If you don't specify a value, the default is
            MANUAL. MANUAL - You provide the credential provider configurations directly. QUICK_CREATE - The service orchestrates
            OAuth consent and provisions the credential provider for you.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
            If you don't specify this field, a value is randomly generated for you. If this token matches a previous request,
            the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
      required:
      - paymentManagerId
      - name
      - type
      - credentialProviderConfigurations
    CreatePaymentConnectorResponse:
      type: object
      properties:
        paymentConnectorId:
          type: string
          description: The unique identifier of the created payment connector.
        paymentManagerId:
          type: string
          description: The unique identifier of the parent payment manager.
        name:
          type: string
          description: The name of the created payment connector.
        type:
          type: string
          enum:
          - CoinbaseCDP
          - StripePrivy
          description: The type of the created payment connector.
        credentialProviderConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/CredentialsProviderConfiguration'
          description: The credential provider configurations for the created payment connector.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the payment connector was created.
        status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - DELETING
          - READY
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          - AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED
          - PENDING_AUTHENTICATION
          - PROVISIONING
          - AUTHENTICATION_EXPIRED
          - AUTHENTICATION_FAILED
          description: The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING,
            CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
        authorizationUrl:
          type: string
          description: The URL that the user must open to complete OAuth consent. This field is only present when the payment
            connector status is PENDING_AUTHENTICATION.
      required:
      - paymentConnectorId
      - paymentManagerId
      - name
      - type
      - credentialProviderConfigurations
      - createdAt
      - status
    CredentialsProviderConfiguration:
      type: object
      properties:
        coinbaseCDP:
          $ref: '#/components/schemas/PaymentCredentialProviderConfiguration'
        stripePrivy:
          $ref: '#/components/schemas/PaymentCredentialProviderConfiguration'
      description: Exactly one member is set.
    DeletePaymentConnectorRequest:
      type: object
      properties:
        paymentManagerId:
          type: string
          description: The unique identifier of the parent payment manager.
        paymentConnectorId:
          type: string
          description: The unique identifier of the payment connector to delete.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
            If you don't specify this field, a value is randomly generated for you. If this token matches a previous request,
            the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
      required:
      - paymentManagerId
      - paymentConnectorId
    DeletePaymentConnectorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - DELETING
          - READY
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          - AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED
          - PENDING_AUTHENTICATION
          - PROVISIONING
          - AUTHENTICATION_EXPIRED
          - AUTHENTICATION_FAILED
          description: The current status of the payment connector, set to DELETING when deletion is initiated. Possible values
            include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
        paymentConnectorId:
          type: string
          description: The unique identifier of the deleted payment connector.
      required:
      - status
    GetPaymentConnectorRequest:
      type: object
      properties:
        paymentManagerId:
          type: string
          description: The unique identifier of the parent payment manager.
        paymentConnectorId:
          type: string
          description: The unique identifier of the payment connector to retrieve.
      required:
      - paymentManagerId
      - paymentConnectorId
    GetPaymentConnectorResponse:
      type: object
      properties:
        paymentConnectorId:
          type: string
          description: The unique identifier of the payment connector.
        name:
          type: string
          description: The name of the payment connector.
        description:
          type: string
          description: The description of the payment connector.
        type:
          type: string
          enum:
          - CoinbaseCDP
          - StripePrivy
          description: The type of the payment connector, which determines the payment provider integration.
        provisionMode:
          type: string
          enum:
          - MANUAL
          - QUICK_CREATE
          description: Specifies how the payment connector was provisioned. Payment connectors that were created before this
            field was available return MANUAL. MANUAL - You provided the credential provider configurations, so you own the
            credentials. Rotate them with the payment provider, then call UpdatePaymentCredentialProvider. QUICK_CREATE -
            AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate
            them with RotatePaymentConnectorCredentials.
        credentialProviderConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/CredentialsProviderConfiguration'
          description: The credential provider configurations for the payment connector.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the payment connector was created.
        lastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp when the payment connector was last updated.
        status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - DELETING
          - READY
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          - AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED
          - PENDING_AUTHENTICATION
          - PROVISIONING
          - AUTHENTICATION_EXPIRED
          - AUTHENTICATION_FAILED
          description: The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING,
            CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
        authorizationUrl:
          type: string
          description: The URL that the user must open to complete OAuth consent. This field is only present when the payment
            connector status is PENDING_AUTHENTICATION.
        credentialsUpdatedAt:
          type: string
          format: date-time
          description: The timestamp when the payment connector's current service-managed credentials took effect. It is first
            set when the credentials are provisioned and is updated by each rotation. This field is present only for payment
            connectors with a provisionMode of QUICK_CREATE.
      required:
      - paymentConnectorId
      - name
      - type
      - credentialProviderConfigurations
      - createdAt
      - lastUpdatedAt
      - status
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    PaymentCredentialProviderConfiguration:
      type: object
      properties:
        credentialProviderArn:
          type: string
          description: The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials
            for the payment provider.
      required:
      - credentialProviderArn
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    UpdatePaymentConnectorRequest:
      type: object
      properties:
        paymentManagerId:
          type: string
          description: The unique identifier of the parent payment manager.
        paymentConnectorId:
          type: string
          description: The unique identifier of the payment connector to update.
        description:
          type: string
          description: The updated description of the payment connector.
        type:
          type: string
          enum:
          - CoinbaseCDP
          - StripePrivy
          description: The updated type of the payment connector.
        credentialProviderConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/CredentialsProviderConfiguration'
          description: The updated credential provider configurations for the payment connector.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
            If you don't specify this field, a value is randomly generated for you. If this token matches a previous request,
            the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
      required:
      - paymentManagerId
      - paymentConnectorId
    UpdatePaymentConnectorResponse:
      type: object
      properties:
        paymentConnectorId:
          type: string
          description: The unique identifier of the updated payment connector.
        paymentManagerId:
          type: string
          description: The unique identifier of the parent payment manager.
        name:
          type: string
          description: The name of the updated payment connector.
        type:
          type: string
          enum:
          - CoinbaseCDP
          - StripePrivy
          description: The type of the updated payment connector.
        credentialProviderConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/CredentialsProviderConfiguration'
          description: The credential provider configurations for the updated payment connector.
        lastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp when the payment connector was last updated.
        status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - DELETING
          - READY
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          - AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED
          - PENDING_AUTHENTICATION
          - PROVISIONING
          - AUTHENTICATION_EXPIRED
          - AUTHENTICATION_FAILED
          description: The current status of the updated payment connector. Possible values include CREATING, READY, UPDATING,
            DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
        authorizationUrl:
          type: string
          description: The URL that the user must open to complete OAuth consent. This field is only present when the payment
            connector status is PENDING_AUTHENTICATION.
      required:
      - paymentConnectorId
      - paymentManagerId
      - name
      - type
      - credentialProviderConfigurations
      - lastUpdatedAt
      - status
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field.
        message:
          type: string
          description: A message describing why this field failed validation.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/bedrock-agentcore-control/service/2023-06-05/bedrock-agentcore-control-2023-06-05.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)