Amazon RDS Rds Integration API
The Rds Integration API from Amazon RDS — 4 operation(s) for rds integration.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-rds:amazon-rds-integration-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
openapi: 3.2.0
info:
title: Amazon Relational Database Service Integration API
version: '2014-10-31'
description: Generated from AWS's published Smithy model for Amazon Relational Database 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://rds.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Integration
paths:
/?Action=CreateIntegration:
post:
operationId: CreateIntegration
summary: Create Integration
description: Creates a zero-ETL integration with Amazon Redshift.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/Integration'
example:
IntegrationName: my-integration
IntegrationArn: arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231
SourceArn: arn:aws:rds:us-east-1:123456789012:cluster:my-cluster
TargetArn: arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8
Tags: []
CreateTime: '2023-12-28T17:20:20.629Z'
KMSKeyId: arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa
Status: creating
'404':
description: DBClusterNotFoundFault; DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DBClusterNotFoundFault'
'400':
description: IntegrationAlreadyExistsFault; IntegrationConflictOperationFault; IntegrationQuotaExceededFault; KMSKeyNotAccessibleFault
content:
text/xml:
schema:
$ref: '#/components/schemas/IntegrationAlreadyExistsFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CreateIntegration
Version:
type: string
const: '2014-10-31'
- $ref: '#/components/schemas/CreateIntegrationMessage'
example:
IntegrationName: my-integration
SourceArn: arn:aws:rds:us-east-1:123456789012:cluster:my-cluster
TargetArn: arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8
tags:
- Integration
/?Action=DeleteIntegration:
post:
operationId: DeleteIntegration
summary: Delete Integration
description: Deletes a zero-ETL integration with Amazon Redshift.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/Integration'
example:
SourceArn: arn:aws:rds:us-east-1:123456789012:cluster:my-cluster
IntegrationName: my-integration
IntegrationArn: arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231
TargetArn: arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8
Tags: []
CreateTime: '2023-12-28T17:20:20.629Z'
KMSKeyId: arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa
Status: deleting
'400':
description: IntegrationConflictOperationFault; InvalidIntegrationStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/IntegrationConflictOperationFault'
'404':
description: IntegrationNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/IntegrationNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DeleteIntegration
Version:
type: string
const: '2014-10-31'
- $ref: '#/components/schemas/DeleteIntegrationMessage'
example:
IntegrationIdentifier: 5b9f3d79-7392-4a3e-896c-58eaa1b53231
tags:
- Integration
/?Action=DescribeIntegrations:
post:
operationId: DescribeIntegrations
summary: Describe Integrations
description: Describe one or more zero-ETL integrations with Amazon Redshift.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIntegrationsResponse'
example:
Integrations:
- IntegrationName: my-integration
IntegrationArn: arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231
SourceArn: arn:aws:rds:us-east-1:123456789012:cluster:my-cluster
TargetArn: arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8
Tags: []
CreateTime: '2023-12-28T17:20:20.629Z'
KMSKeyId: arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa
Status: active
'404':
description: IntegrationNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/IntegrationNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeIntegrations
Version:
type: string
const: '2014-10-31'
- $ref: '#/components/schemas/DescribeIntegrationsMessage'
example:
IntegrationIdentifier: 5b9f3d79-7392-4a3e-896c-58eaa1b53231
tags:
- Integration
/?Action=ModifyIntegration:
post:
operationId: ModifyIntegration
summary: Modify Integration
description: Modifies a zero-ETL integration with Amazon Redshift.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/Integration'
example:
SourceArn: arn:aws:rds:us-east-1:123456789012:cluster:my-cluster
IntegrationName: my-renamed-integration
IntegrationArn: arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231
TargetArn: arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8
Tags: []
DataFilter: 'include: *.*'
CreateTime: '2023-12-28T17:20:20.629Z'
KMSKeyId: arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa
Status: active
'400':
description: IntegrationConflictOperationFault; InvalidIntegrationStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/IntegrationConflictOperationFault'
'404':
description: IntegrationNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/IntegrationNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: ModifyIntegration
Version:
type: string
const: '2014-10-31'
- $ref: '#/components/schemas/ModifyIntegrationMessage'
example:
IntegrationIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
IntegrationName: my-renamed-integration
tags:
- Integration
components:
schemas:
DBClusterNotFoundFault:
type: object
properties:
message:
type: string
IntegrationConflictOperationFault:
type: object
properties:
message:
type: string
Tag:
type: object
properties:
Key:
type: string
description: 'A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can''t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").'
Value:
type: string
description: 'A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can''t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").'
CreateIntegrationMessage:
type: object
properties:
SourceArn:
type: string
description: The Amazon Resource Name (ARN) of the database to use as the source for replication.
TargetArn:
type: string
description: The ARN of the Redshift data warehouse to use as the target for replication.
IntegrationName:
type: string
description: The name of the integration.
KMSKeyId:
type: string
description: The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.
AdditionalEncryptionContext:
type: object
additionalProperties:
type: string
description: An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
DataFilter:
type: string
description: Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift.
Description:
type: string
description: A description of the integration.
required:
- SourceArn
- TargetArn
- IntegrationName
IntegrationError:
type: object
properties:
ErrorCode:
type: string
description: The error code associated with the integration.
ErrorMessage:
type: string
description: A message explaining the error.
required:
- ErrorCode
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
Integration:
type: object
properties:
SourceArn:
type: string
description: The Amazon Resource Name (ARN) of the database used as the source for replication.
TargetArn:
type: string
description: The ARN of the Redshift data warehouse used as the target for replication.
IntegrationName:
type: string
description: The name of the integration.
IntegrationArn:
type: string
description: The ARN of the integration.
KMSKeyId:
type: string
description: The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
AdditionalEncryptionContext:
type: object
additionalProperties:
type: string
description: The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
Status:
type: string
enum:
- creating
- active
- modifying
- failed
- deleting
- syncing
- needs_attention
description: The current status of the integration.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
DataFilter:
type: string
description: Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
Description:
type: string
description: A description of the integration.
CreateTime:
type: string
format: date-time
description: The time when the integration was created, in Universal Coordinated Time (UTC).
Errors:
type: array
items:
$ref: '#/components/schemas/IntegrationError'
description: Any errors associated with the integration.
IntegrationNotFoundFault:
type: object
properties:
message:
type: string
ModifyIntegrationMessage:
type: object
properties:
IntegrationIdentifier:
type: string
description: The unique identifier of the integration to modify.
IntegrationName:
type: string
description: A new name for the integration.
DataFilter:
type: string
description: A new data filter for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift.
Description:
type: string
description: A new description for the integration.
required:
- IntegrationIdentifier
DeleteIntegrationMessage:
type: object
properties:
IntegrationIdentifier:
type: string
description: The unique identifier of the integration.
required:
- IntegrationIdentifier
DescribeIntegrationsMessage:
type: object
properties:
IntegrationIdentifier:
type: string
description: The unique identifier of the integration.
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: A filter that specifies one or more resources to return.
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 you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
Marker:
type: string
description: An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
IntegrationAlreadyExistsFault:
type: object
properties:
message:
type: string
DescribeIntegrationsResponse:
type: object
properties:
Marker:
type: string
description: A pagination token that can be used in a later DescribeIntegrations request.
Integrations:
type: array
items:
$ref: '#/components/schemas/Integration'
description: A list of integrations.
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)