Amazon Relational Database Service
Amazon Relational Database Service Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a…
Data & analytics#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Relational Database Service Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique. Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use. This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide. Amazon RDS API Reference For the alphabetical list of API actions, see API Actions . For the alphabetical list of data types, see Data Types . For a list of common query parameters, see Common Parameters . For descriptions of the error codes, see Common Errors . Amazon RDS User Guide For a summary of the Amazon RDS interfaces, see Available RDS Interfaces . For more information about how to use the Query API, see Using the Query API .
Endpoints 168
- POSTAdd role to dB cluster
/#Action=AddRoleToDBCluster?Action=AddRoleToDBCluster&Version=2014-10-31Associates an Identity and Access Management (IAM) role with a DB cluster. - POSTAdd role to dB instance
/#Action=AddRoleToDBInstance?Action=AddRoleToDBInstance&Version=2014-10-31Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance… - POSTAdd source identifier to subscription
/#Action=AddSourceIdentifierToSubscription?Action=AddSourceIdentifierToSubscription&Version=2014-10-31Adds a source identifier to an existing RDS event notification subscription. - POSTAdd tags to resource
/#Action=AddTagsToResource?Action=AddTagsToResource&Version=2014-10-31Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources,… - POSTApply pending maintenance action
/#Action=ApplyPendingMaintenanceAction?Action=ApplyPendingMaintenanceAction&Version=2014-10-31Applies a pending maintenance action to a resource (for example, to a DB instance). - POSTAuthorize dB security group ingress
/#Action=AuthorizeDBSecurityGroupIngress?Action=AuthorizeDBSecurityGroupIngress&Version=2014-10-31Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the… - POSTBacktrack dB cluster
/#Action=BacktrackDBCluster?Action=BacktrackDBCluster&Version=2014-10-31Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in… - POSTCancel dB capacity reservation
/#Action=CancelDBCapacityReservation?Action=CancelDBCapacityReservation&Version=2014-10-31Cancels a DB capacity reservation. Amazon RDS changes the state of the reservation to cancelled and stops reporting available capacity for it. Amazon RDS then… - POSTCancel export task
/#Action=CancelExportTask?Action=CancelExportTask&Version=2014-10-31Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed. - POSTCopy dB cluster parameter group
/#Action=CopyDBClusterParameterGroup?Action=CopyDBClusterParameterGroup&Version=2014-10-31Copies the specified DB cluster parameter group. You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group,… - POSTCopy dB cluster snapshot
/#Action=CopyDBClusterSnapshot?Action=CopyDBClusterSnapshot&Version=2014-10-31Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the… - POSTCopy dB parameter group
/#Action=CopyDBParameterGroup?Action=CopyDBParameterGroup&Version=2014-10-31Copies the specified DB parameter group. You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the… - POSTCopy dB snapshot
/#Action=CopyDBSnapshot?Action=CopyDBSnapshot&Version=2014-10-31Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to… - POSTCopy option group
/#Action=CopyOptionGroup?Action=CopyOptionGroup&Version=2014-10-31Copies the specified option group. - POSTCreate blue green deployment
/#Action=CreateBlueGreenDeployment?Action=CreateBlueGreenDeployment&Version=2014-10-31Creates a blue/green deployment. A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the… - POSTCreate custom dB engine version
/#Action=CreateCustomDBEngineVersion?Action=CreateCustomDBEngineVersion&Version=2014-10-31Creates a custom DB engine version (CEV). - POSTCreate dB capacity reservation
/#Action=CreateDBCapacityReservation?Action=CreateDBCapacityReservation&Version=2014-10-31Creates a DB capacity reservation. A DB capacity reservation reserves compute and memory capacity for DB instances of one DB instance class and one database… - POSTCreate dB cluster
/#Action=CreateDBCluster?Action=CreateDBCluster&Version=2014-10-31Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly… - POSTCreate dB cluster endpoint
/#Action=CreateDBClusterEndpoint?Action=CreateDBClusterEndpoint&Version=2014-10-31Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action applies only to Aurora DB clusters. - POSTCreate dB cluster parameter group
/#Action=CreateDBClusterParameterGroup?Action=CreateDBClusterParameterGroup&Version=2014-10-31Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter… - POSTCreate dB cluster snapshot
/#Action=CreateDBClusterSnapshot?Action=CreateDBClusterSnapshot&Version=2014-10-31Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide . For more information… - POSTCreate dB instance
/#Action=CreateDBInstance?Action=CreateDBInstance&Version=2014-10-31Creates a new DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you… - POSTCreate dB instance read replica
/#Action=CreateDBInstanceReadReplica?Action=CreateDBInstanceReadReplica&Version=2014-10-31Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB… - POSTCreate dB parameter group
/#Action=CreateDBParameterGroup?Action=CreateDBParameterGroup&Version=2014-10-31Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To… - POSTCreate dB proxy
/#Action=CreateDBProxy?Action=CreateDBProxy&Version=2014-10-31Creates a new DB proxy. - POSTCreate dB proxy endpoint
/#Action=CreateDBProxyEndpoint?Action=CreateDBProxyEndpoint&Version=2014-10-31Creates a DBProxyEndpoint . Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or… - POSTCreate dB security group
/#Action=CreateDBSecurityGroup?Action=CreateDBSecurityGroup&Version=2014-10-31Creates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are… - POSTCreate dB shard group
/#Action=CreateDBShardGroup?Action=CreateDBShardGroup&Version=2014-10-31Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB… - POSTCreate dB snapshot
/#Action=CreateDBSnapshot?Action=CreateDBSnapshot&Version=2014-10-31Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state. - POSTCreate dB subnet group
/#Action=CreateDBSubnetGroup?Action=CreateDBSubnetGroup&Version=2014-10-31Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region. - POSTCreate event subscription
/#Action=CreateEventSubscription?Action=CreateEventSubscription&Version=2014-10-31Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console,… - POSTCreate global cluster
/#Action=CreateGlobalCluster?Action=CreateGlobalCluster&Version=2014-10-31Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write… - POSTCreate integration
/#Action=CreateIntegration?Action=CreateIntegration&Version=2014-10-31Creates a zero-ETL integration with Amazon Redshift. - POSTCreate option group
/#Action=CreateOptionGroup?Action=CreateOptionGroup&Version=2014-10-31Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom. - POSTCreate tenant database
/#Action=CreateTenantDatabase?Action=CreateTenantDatabase&Version=2014-10-31Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported. - POSTDelete blue green deployment
/#Action=DeleteBlueGreenDeployment?Action=DeleteBlueGreenDeployment&Version=2014-10-31Deletes a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using… - POSTDelete custom dB engine version
/#Action=DeleteCustomDBEngineVersion?Action=DeleteCustomDBEngineVersion&Version=2014-10-31Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it… - POSTDelete dB cluster
/#Action=DeleteDBCluster?Action=DeleteDBCluster&Version=2014-10-31The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted… - POSTDelete dB cluster automated backup
/#Action=DeleteDBClusterAutomatedBackup?Action=DeleteDBClusterAutomatedBackup&Version=2014-10-31Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups. - POSTDelete dB cluster endpoint
/#Action=DeleteDBClusterEndpoint?Action=DeleteDBClusterEndpoint&Version=2014-10-31Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. - POSTDelete dB cluster parameter group
/#Action=DeleteDBClusterParameterGroup?Action=DeleteDBClusterParameterGroup&Version=2014-10-31Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on… - POSTDelete dB cluster snapshot
/#Action=DeleteDBClusterSnapshot?Action=DeleteDBClusterSnapshot&Version=2014-10-31Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be… - POSTDelete dB instance
/#Action=DeleteDBInstance?Action=DeleteDBInstance&Version=2014-10-31Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered.… - POSTDelete dB instance automated backup
/#Action=DeleteDBInstanceAutomatedBackup?Action=DeleteDBInstanceAutomatedBackup&Version=2014-10-31Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups. - POSTDelete dB parameter group
/#Action=DeleteDBParameterGroup?Action=DeleteDBParameterGroup&Version=2014-10-31Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances. - POSTDelete dB proxy
/#Action=DeleteDBProxy?Action=DeleteDBProxy&Version=2014-10-31Deletes an existing DB proxy. - POSTDelete dB proxy endpoint
/#Action=DeleteDBProxyEndpoint?Action=DeleteDBProxyEndpoint&Version=2014-10-31Deletes a DBProxyEndpoint . Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have… - POSTDelete dB security group
/#Action=DeleteDBSecurityGroup?Action=DeleteDBSecurityGroup&Version=2014-10-31Deletes a DB security group. The specified DB security group must not be associated with any DB instances. EC2-Classic was retired on August 15, 2022. If you… - POSTDelete dB shard group
/#Action=DeleteDBShardGroup?Action=DeleteDBShardGroup&Version=2014-10-31Deletes an Aurora Limitless Database DB shard group. - POSTDelete dB snapshot
/#Action=DeleteDBSnapshot?Action=DeleteDBSnapshot&Version=2014-10-31Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted. - POSTDelete dB subnet group
/#Action=DeleteDBSubnetGroup?Action=DeleteDBSubnetGroup&Version=2014-10-31Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. - POSTDelete event subscription
/#Action=DeleteEventSubscription?Action=DeleteEventSubscription&Version=2014-10-31Deletes an RDS event notification subscription. - POSTDelete global cluster
/#Action=DeleteGlobalCluster?Action=DeleteGlobalCluster&Version=2014-10-31Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB… - POSTDelete integration
/#Action=DeleteIntegration?Action=DeleteIntegration&Version=2014-10-31Deletes a zero-ETL integration with Amazon Redshift. - POSTDelete option group
/#Action=DeleteOptionGroup?Action=DeleteOptionGroup&Version=2014-10-31Deletes an existing option group. - POSTDelete tenant database
/#Action=DeleteTenantDatabase?Action=DeleteTenantDatabase&Version=2014-10-31Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances. You can't delete a tenant… - POSTDeregister dB proxy targets
/#Action=DeregisterDBProxyTargets?Action=DeregisterDBProxyTargets&Version=2014-10-31Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup . - POSTDescribe account attributes
/#Action=DescribeAccountAttributes?Action=DescribeAccountAttributes&Version=2014-10-31Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The… - POSTDescribe blue green deployments
/#Action=DescribeBlueGreenDeployments?Action=DescribeBlueGreenDeployments&Version=2014-10-31Describes one or more blue/green deployments. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User… - POSTDescribe certificates
/#Action=DescribeCertificates?Action=DescribeCertificates&Version=2014-10-31Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account. For more information, see Using SSL/TLS… - POSTDescribe dB capacity reservations
/#Action=DescribeDBCapacityReservations?Action=DescribeDBCapacityReservations&Version=2014-10-31Describes one or more DB capacity reservations. A DB capacity reservation reserves capacity for Amazon RDS DB instances in one or more Availability Zones. If… - POSTDescribe dB cluster automated backups
/#Action=DescribeDBClusterAutomatedBackups?Action=DescribeDBClusterAutomatedBackups&Version=2014-10-31Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted… - POSTDescribe dB cluster backtracks
/#Action=DescribeDBClusterBacktracks?Action=DescribeDBClusterBacktracks&Version=2014-10-31Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .… - POSTDescribe dB cluster endpoints
/#Action=DescribeDBClusterEndpoints?Action=DescribeDBClusterEndpoints&Version=2014-10-31Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. - POSTDescribe dB cluster parameter groups
/#Action=DescribeDBClusterParameterGroups?Action=DescribeDBClusterParameterGroups&Version=2014-10-31Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of… - POSTDescribe dB cluster parameters
/#Action=DescribeDBClusterParameters?Action=DescribeDBClusterParameters&Version=2014-10-31Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the… - POSTDescribe dB cluster snapshot attributes
/#Action=DescribeDBClusterSnapshotAttributes?Action=DescribeDBClusterSnapshotAttributes&Version=2014-10-31Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon Web Services… - POSTDescribe dB cluster snapshots
/#Action=DescribeDBClusterSnapshots?Action=DescribeDBClusterSnapshots&Version=2014-10-31Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon… - POSTDescribe dB clusters
/#Action=DescribeDBClusters?Action=DescribeDBClusters&Version=2014-10-31Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. For more information on Amazon Aurora DB clusters, see… - POSTDescribe dB engine versions
/#Action=DescribeDBEngineVersions?Action=DescribeDBEngineVersions&Version=2014-10-31Describes the properties of specific versions of DB engines. - POSTDescribe dB instance automated backups
/#Action=DescribeDBInstanceAutomatedBackups?Action=DescribeDBInstanceAutomatedBackups&Version=2014-10-31Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted… - POSTDescribe dB instances
/#Action=DescribeDBInstances?Action=DescribeDBInstances&Version=2014-10-31Describes provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon… - POSTDescribe dB log files
/#Action=DescribeDBLogFiles?Action=DescribeDBLogFiles&Version=2014-10-31Returns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom. - POSTDescribe dB major engine versions
/#Action=DescribeDBMajorEngineVersions?Action=DescribeDBMajorEngineVersions&Version=2014-10-31Describes the properties of specific major versions of DB engines. - POSTDescribe dB parameter groups
/#Action=DescribeDBParameterGroups?Action=DescribeDBParameterGroups&Version=2014-10-31Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB… - POSTDescribe dB parameters
/#Action=DescribeDBParameters?Action=DescribeDBParameters&Version=2014-10-31Returns the detailed parameter list for a particular DB parameter group. - POSTDescribe dB proxies
/#Action=DescribeDBProxies?Action=DescribeDBProxies&Version=2014-10-31Returns information about DB proxies. - POSTDescribe dB proxy endpoints
/#Action=DescribeDBProxyEndpoints?Action=DescribeDBProxyEndpoints&Version=2014-10-31Returns information about DB proxy endpoints. - POSTDescribe dB proxy target groups
/#Action=DescribeDBProxyTargetGroups?Action=DescribeDBProxyTargetGroups&Version=2014-10-31Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures. - POSTDescribe dB proxy targets
/#Action=DescribeDBProxyTargets?Action=DescribeDBProxyTargets&Version=2014-10-31Returns information about DBProxyTarget objects. This API supports pagination. - POSTDescribe dB recommendations
/#Action=DescribeDBRecommendations?Action=DescribeDBRecommendations&Version=2014-10-31Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups. - POSTDescribe dB security groups
/#Action=DescribeDBSecurityGroups?Action=DescribeDBSecurityGroups&Version=2014-10-31Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB… - POSTDescribe dB shard groups
/#Action=DescribeDBShardGroups?Action=DescribeDBShardGroups&Version=2014-10-31Describes existing Aurora Limitless Database DB shard groups. - POSTDescribe dB snapshot attributes
/#Action=DescribeDBSnapshotAttributes?Action=DescribeDBSnapshotAttributes&Version=2014-10-31Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other Amazon Web Services accounts,… - POSTDescribe dB snapshot tenant databases
/#Action=DescribeDBSnapshotTenantDatabases?Action=DescribeDBSnapshotTenantDatabases&Version=2014-10-31Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration. You… - POSTDescribe dB snapshots
/#Action=DescribeDBSnapshots?Action=DescribeDBSnapshots&Version=2014-10-31Returns information about DB snapshots. This API action supports pagination. - POSTDescribe dB subnet groups
/#Action=DescribeDBSubnetGroups?Action=DescribeDBSubnetGroups&Version=2014-10-31Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.… - POSTDescribe engine default cluster parameters
/#Action=DescribeEngineDefaultClusterParameters?Action=DescribeEngineDefaultClusterParameters&Version=2014-10-31Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What is Amazon Aurora?… - POSTDescribe engine default parameters
/#Action=DescribeEngineDefaultParameters?Action=DescribeEngineDefaultParameters&Version=2014-10-31Returns the default engine and system parameter information for the specified database engine. - POSTDescribe event categories
/#Action=DescribeEventCategories?Action=DescribeEventCategories&Version=2014-10-31Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event… - POSTDescribe event subscriptions
/#Action=DescribeEventSubscriptions?Action=DescribeEventSubscriptions&Version=2014-10-31Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName , SNSTopicARN , CustomerID ,… - POSTDescribe events
/#Action=DescribeEvents?Action=DescribeEvents&Version=2014-10-31Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past… - POSTDescribe export tasks
/#Action=DescribeExportTasks?Action=DescribeExportTasks&Version=2014-10-31Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination. - POSTDescribe global clusters
/#Action=DescribeGlobalClusters?Action=DescribeGlobalClusters&Version=2014-10-31Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What is Amazon Aurora? in… - POSTDescribe integrations
/#Action=DescribeIntegrations?Action=DescribeIntegrations&Version=2014-10-31Describe one or more zero-ETL integrations with Amazon Redshift. - POSTDescribe option group options
/#Action=DescribeOptionGroupOptions?Action=DescribeOptionGroupOptions&Version=2014-10-31Describes all available options for the specified engine. - POSTDescribe option groups
/#Action=DescribeOptionGroups?Action=DescribeOptionGroups&Version=2014-10-31Describes the available option groups. - POSTDescribe orderable dB instance options
/#Action=DescribeOrderableDBInstanceOptions?Action=DescribeOrderableDBInstanceOptions&Version=2014-10-31Describes the orderable DB instance options for a specified DB engine. - POSTDescribe pending maintenance actions
/#Action=DescribePendingMaintenanceActions?Action=DescribePendingMaintenanceActions&Version=2014-10-31Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. This API follows an eventual consistency model.… - POSTDescribe reserved dB instances
/#Action=DescribeReservedDBInstances?Action=DescribeReservedDBInstances&Version=2014-10-31Returns information about reserved DB instances for this account, or about a specified reserved DB instance. - POSTDescribe reserved dB instances offerings
/#Action=DescribeReservedDBInstancesOfferings?Action=DescribeReservedDBInstancesOfferings&Version=2014-10-31Lists available reserved DB instance offerings. - POSTDescribe serverless v2 platform versions
/#Action=DescribeServerlessV2PlatformVersions?Action=DescribeServerlessV2PlatformVersions&Version=2014-10-31Describes the properties of specific platform versions for Aurora Serverless v2. - POSTDescribe source regions
/#Action=DescribeSourceRegions?Action=DescribeSourceRegions&Version=2014-10-31Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or… - POSTDescribe tenant databases
/#Action=DescribeTenantDatabases?Action=DescribeTenantDatabases&Version=2014-10-31Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported. - POSTDescribe valid dB instance modifications
/#Action=DescribeValidDBInstanceModifications?Action=DescribeValidDBInstanceModifications&Version=2014-10-31You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call… - POSTDisable http endpoint
/#Action=DisableHttpEndpoint?Action=DisableHttpEndpoint&Version=2014-10-31Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API. For more information, see Using RDS Data API in the… - POSTDownload dB log file portion
/#Action=DownloadDBLogFilePortion?Action=DownloadDBLogFilePortion&Version=2014-10-31Downloads all or a portion of the specified log file, up to 1 MB in size. This command doesn't apply to RDS Custom. This operation uses resources on database… - POSTEnable http endpoint
/#Action=EnableHttpEndpoint?Action=EnableHttpEndpoint&Version=2014-10-31Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. When enabled, this endpoint provides a connectionless web service… - POSTFailover dB cluster
/#Action=FailoverDBCluster?Action=FailoverDBCluster&Version=2014-10-31Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB… - POSTFailover global cluster
/#Action=FailoverGlobalCluster?Action=FailoverGlobalCluster&Version=2014-10-31Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database.… - POSTList tags for resource
/#Action=ListTagsForResource?Action=ListTagsForResource&Version=2014-10-31Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide or… - POSTModify activity stream
/#Action=ModifyActivityStream?Action=ModifyActivityStream&Version=2014-10-31Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy… - POSTModify certificates
/#Action=ModifyCertificates?Action=ModifyCertificates&Version=2014-10-31Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.… - POSTModify current dB cluster capacity
/#Action=ModifyCurrentDBClusterCapacity?Action=ModifyCurrentDBClusterCapacity&Version=2014-10-31Set the capacity of an Aurora Serverless v1 DB cluster to a specific value. Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In… - POSTModify custom dB engine version
/#Action=ModifyCustomDBEngineVersion?Action=ModifyCustomDBEngineVersion&Version=2014-10-31Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions . The MediaImport service that imports… - POSTModify dB capacity reservation
/#Action=ModifyDBCapacityReservation?Action=ModifyDBCapacityReservation&Version=2014-10-31Modifies a DB capacity reservation. You can change the reserved capacity in each Availability Zone of the reservation, and you can change the end date of the… - POSTModify dB cluster
/#Action=ModifyDBCluster?Action=ModifyDBCluster&Version=2014-10-31Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new… - POSTModify dB cluster endpoint
/#Action=ModifyDBClusterEndpoint?Action=ModifyDBClusterEndpoint&Version=2014-10-31Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This operation only applies to Aurora DB clusters. - POSTModify dB cluster parameter group
/#Action=ModifyDBClusterParameterGroup?Action=ModifyDBClusterParameterGroup&Version=2014-10-31Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue ,… - POSTModify dB cluster snapshot attribute
/#Action=ModifyDBClusterSnapshotAttribute?Action=ModifyDBClusterSnapshotAttribute&Version=2014-10-31Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other… - POSTModify dB instance
/#Action=ModifyDBInstance?Action=ModifyDBInstance&Version=2014-10-31Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the… - POSTModify dB parameter group
/#Action=ModifyDBParameterGroup?Action=ModifyDBParameterGroup&Version=2014-10-31Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue , and… - POSTModify dB proxy
/#Action=ModifyDBProxy?Action=ModifyDBProxy&Version=2014-10-31Changes the settings for an existing DB proxy. - POSTModify dB proxy endpoint
/#Action=ModifyDBProxyEndpoint?Action=ModifyDBProxyEndpoint&Version=2014-10-31Changes the settings for an existing DB proxy endpoint. - POSTModify dB proxy target group
/#Action=ModifyDBProxyTargetGroup?Action=ModifyDBProxyTargetGroup&Version=2014-10-31Modifies the properties of a DBProxyTargetGroup . - POSTModify dB recommendation
/#Action=ModifyDBRecommendation?Action=ModifyDBRecommendation&Version=2014-10-31Updates the recommendation status and recommended action status for the specified recommendation. - POSTModify dB shard group
/#Action=ModifyDBShardGroup?Action=ModifyDBShardGroup&Version=2014-10-31Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in… - POSTModify dB snapshot
/#Action=ModifyDBSnapshot?Action=ModifyDBSnapshot&Version=2014-10-31Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading… - POSTModify dB snapshot attribute
/#Action=ModifyDBSnapshotAttribute?Action=ModifyDBSnapshotAttribute&Version=2014-10-31Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other Amazon Web Services… - POSTModify dB subnet group
/#Action=ModifyDBSubnetGroup?Action=ModifyDBSubnetGroup&Version=2014-10-31Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region. - POSTModify event subscription
/#Action=ModifyEventSubscription?Action=ModifyEventSubscription&Version=2014-10-31Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a… - POSTModify global cluster
/#Action=ModifyGlobalCluster?Action=ModifyGlobalCluster&Version=2014-10-31Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters… - POSTModify integration
/#Action=ModifyIntegration?Action=ModifyIntegration&Version=2014-10-31Modifies a zero-ETL integration with Amazon Redshift. - POSTModify option group
/#Action=ModifyOptionGroup?Action=ModifyOptionGroup&Version=2014-10-31Modifies an existing option group. - POSTModify tenant database
/#Action=ModifyTenantDatabase?Action=ModifyTenantDatabase&Version=2014-10-31Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only… - POSTPromote read replica
/#Action=PromoteReadReplica?Action=PromoteReadReplica&Version=2014-10-31Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous… - POSTPromote read replica dB cluster
/#Action=PromoteReadReplicaDBCluster?Action=PromoteReadReplicaDBCluster&Version=2014-10-31Promotes a read replica DB cluster to a standalone DB cluster. - POSTPurchase reserved dB instances offering
/#Action=PurchaseReservedDBInstancesOffering?Action=PurchaseReservedDBInstancesOffering&Version=2014-10-31Purchases a reserved DB instance offering. - POSTReboot dB cluster
/#Action=RebootDBCluster?Action=RebootDBCluster&Version=2014-10-31You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster… - POSTReboot dB instance
/#Action=RebootDBInstance?Action=RebootDBInstance&Version=2014-10-31You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter… - POSTReboot dB shard group
/#Action=RebootDBShardGroup?Action=RebootDBShardGroup&Version=2014-10-31You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for… - POSTRegister dB proxy targets
/#Action=RegisterDBProxyTargets?Action=RegisterDBProxyTargets&Version=2014-10-31Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup . - POSTRemove from global cluster
/#Action=RemoveFromGlobalCluster?Action=RemoveFromGlobalCluster&Version=2014-10-31Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of… - POSTRemove role from dB cluster
/#Action=RemoveRoleFromDBCluster?Action=RemoveRoleFromDBCluster&Version=2014-10-31Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster. For more information on Amazon Aurora DB… - POSTRemove role from dB instance
/#Action=RemoveRoleFromDBInstance?Action=RemoveRoleFromDBInstance&Version=2014-10-31Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance. - POSTRemove source identifier from subscription
/#Action=RemoveSourceIdentifierFromSubscription?Action=RemoveSourceIdentifierFromSubscription&Version=2014-10-31Removes a source identifier from an existing RDS event notification subscription. - POSTRemove tags from resource
/#Action=RemoveTagsFromResource?Action=RemoveTagsFromResource&Version=2014-10-31Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User… - POSTReset dB cluster parameter group
/#Action=ResetDBClusterParameterGroup?Action=ResetDBClusterParameterGroup&Version=2014-10-31Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and… - POSTReset dB parameter group
/#Action=ResetDBParameterGroup?Action=ResetDBParameterGroup&Version=2014-10-31Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:… - POSTRestore dB cluster from s3
/#Action=RestoreDBClusterFromS3?Action=RestoreDBClusterFromS3&Version=2014-10-31Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data… - POSTRestore dB cluster from snapshot
/#Action=RestoreDBClusterFromSnapshot?Action=RestoreDBClusterFromSnapshot&Version=2014-10-31Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If… - POSTRestore dB cluster to point in time
/#Action=RestoreDBClusterToPointInTime?Action=RestoreDBClusterToPointInTime&Version=2014-10-31Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days.… - POSTRestore dB instance from dB snapshot
/#Action=RestoreDBInstanceFromDBSnapshot?Action=RestoreDBInstanceFromDBSnapshot&Version=2014-10-31Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original… - POSTRestore dB instance from s3
/#Action=RestoreDBInstanceFromS3?Action=RestoreDBInstanceFromS3&Version=2014-10-31Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises… - POSTRestore dB instance to point in time
/#Action=RestoreDBInstanceToPointInTime?Action=RestoreDBInstanceToPointInTime&Version=2014-10-31Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property.… - POSTRevoke dB security group ingress
/#Action=RevokeDBSecurityGroupIngress?Action=RevokeDBSecurityGroupIngress&Version=2014-10-31Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP,… - POSTStart activity stream
/#Action=StartActivityStream?Action=StartActivityStream&Version=2014-10-31Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in… - POSTStart dB cluster
/#Action=StartDBCluster?Action=StartDBCluster&Version=2014-10-31Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation.… - POSTStart dB instance
/#Action=StartDBInstance?Action=StartDBInstance&Version=2014-10-31Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.… - POSTStart dB instance automated backups replication
/#Action=StartDBInstanceAutomatedBackupsReplication?Action=StartDBInstanceAutomatedBackupsReplication&Version=2014-10-31Enables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see… - POSTStart export task
/#Action=StartExportTask?Action=StartExportTask&Version=2014-10-31Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket. You can't export snapshot data from… - POSTStop activity stream
/#Action=StopActivityStream?Action=StopActivityStream&Version=2014-10-31Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream… - POSTStop dB cluster
/#Action=StopDBCluster?Action=StopDBCluster&Version=2014-10-31Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups.… - POSTStop dB instance
/#Action=StopDBInstance?Action=StopDBInstance&Version=2014-10-31Stops an Amazon RDS DB instance temporarily. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter… - POSTStop dB instance automated backups replication
/#Action=StopDBInstanceAutomatedBackupsReplication?Action=StopDBInstanceAutomatedBackupsReplication&Version=2014-10-31Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see… - POSTSwitchover blue green deployment
/#Action=SwitchoverBlueGreenDeployment?Action=SwitchoverBlueGreenDeployment&Version=2014-10-31Switches over a blue/green deployment. Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over,… - POSTSwitchover global cluster
/#Action=SwitchoverGlobalCluster?Action=SwitchoverGlobalCluster&Version=2014-10-31Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called… - POSTSwitchover read replica
/#Action=SwitchoverReadReplica?Action=SwitchoverReadReplica&Version=2014-10-31Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts…
API details
- Base URL
https://rds.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 168 operations on 168 pathsPOST 168
- Description format
- AWS Smithy model, API version
2014-10-31 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Relational Database Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Relational Database Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Add role to dB cluster” (POST /#Action=AddRoleToDBCluster?Action=AddRoleToDBCluster&Version=2014-10-31), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Relational Database Service?
Amazon Relational Database Service Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a… It is listed under Data & analytics and has 168 endpoints.
Who publishes the Amazon Relational Database Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Relational Database Service?
Requests go to https://rds.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Relational Database Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Relational Database Service have?
168 operations on 168 paths (168 POST).
Is forking the Amazon Relational Database Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.