integrations.sh
← all integrations

amazonaws.com – rds

OpenAPI apis-guru cloud

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, 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 .

  • For the alphabetical list of data types, see .

  • For a list of common query parameters, see .

  • For descriptions of the error codes, see .

Amazon RDS User Guide

  • For a summary of the Amazon RDS interfaces, see .

  • For more information about how to use the Query API, see .

Homepage
https://api.apis.guru/v2/specs/amazonaws.com:rds/2014-10-31.json
Provider
amazonaws.com:rds / rds
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/amazonaws.com/rds/2014-10-31/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/amazonaws.com/rds/2014-10-31/openapi.yaml

Tools (284)

Extracted live via the executor SDK.

  • actionAddRoleToDbCluster.getAddRoleToDbCluster

    Associates an Identity and Access Management (IAM) role with a DB cluster.

  • actionAddRoleToDbCluster.postAddRoleToDbCluster

    Associates an Identity and Access Management (IAM) role with a DB cluster.

  • actionAddRoleToDbInstance.getAddRoleToDbInstance

    Associates 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 must be available.

    This command doesn't apply to RDS Custom.

  • actionAddRoleToDbInstance.postAddRoleToDbInstance

    Associates 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 must be available.

    This command doesn't apply to RDS Custom.

  • actionAddSourceIdentifierToSubscription.getAddSourceIdentifierToSubscription

    Adds a source identifier to an existing RDS event notification subscription.

  • actionAddSourceIdentifierToSubscription.postAddSourceIdentifierToSubscription

    Adds a source identifier to an existing RDS event notification subscription.

  • actionAddTagsToResource.getAddTagsToResource

    Adds 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, or used in a Condition statement in an IAM policy for Amazon RDS.

    For an overview on tagging Amazon RDS resources, see .

  • actionAddTagsToResource.postAddTagsToResource

    Adds 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, or used in a Condition statement in an IAM policy for Amazon RDS.

    For an overview on tagging Amazon RDS resources, see .

  • actionApplyPendingMaintenanceAction.getApplyPendingMaintenanceAction

    Applies a pending maintenance action to a resource (for example, to a DB instance).

  • actionApplyPendingMaintenanceAction.postApplyPendingMaintenanceAction

    Applies a pending maintenance action to a resource (for example, to a DB instance).

  • actionAuthorizeDbSecurityGroupIngress.getAuthorizeDbSecurityGroupIngress

    Enables 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 application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

    You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

    For an overview of CIDR ranges, go to the .

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionAuthorizeDbSecurityGroupIngress.postAuthorizeDbSecurityGroupIngress

    Enables 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 application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

    You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

    For an overview of CIDR ranges, go to the .

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionBacktrackDbCluster.getBacktrackDbCluster

    Backtracks a DB cluster to a specific time, without creating a new DB cluster.

    For more information on backtracking, see in the Amazon Aurora User Guide.

    This action applies only to Aurora MySQL DB clusters.

  • actionBacktrackDbCluster.postBacktrackDbCluster

    Backtracks a DB cluster to a specific time, without creating a new DB cluster.

    For more information on backtracking, see in the Amazon Aurora User Guide.

    This action applies only to Aurora MySQL DB clusters.

  • actionCancelExportTask.getCancelExportTask

    Cancels 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.

  • actionCancelExportTask.postCancelExportTask

    Cancels 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.

  • actionCopyDbClusterParameterGroup.getCopyDbClusterParameterGroup

    Copies the specified DB cluster parameter group.

  • actionCopyDbClusterParameterGroup.postCopyDbClusterParameterGroup

    Copies the specified DB cluster parameter group.

  • actionCopyDbClusterSnapshot.getCopyDbClusterSnapshot

    Copies a snapshot of a DB cluster.

    To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

    You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:

    • KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.

    To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

    For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see in the Amazon Aurora User Guide.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionCopyDbClusterSnapshot.postCopyDbClusterSnapshot

    Copies a snapshot of a DB cluster.

    To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

    You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:

    • KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.

    To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

    For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see in the Amazon Aurora User Guide.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionCopyDbParameterGroup.getCopyDbParameterGroup

    Copies the specified DB parameter group.

  • actionCopyDbParameterGroup.postCopyDbParameterGroup

    Copies the specified DB parameter group.

  • actionCopyDbSnapshot.getCopyDbSnapshot

    Copies 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 another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.

    This command doesn't apply to RDS Custom.

    For more information about copying snapshots, see in the Amazon RDS User Guide.

  • actionCopyDbSnapshot.postCopyDbSnapshot

    Copies 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 another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.

    This command doesn't apply to RDS Custom.

    For more information about copying snapshots, see in the Amazon RDS User Guide.

  • actionCopyOptionGroup.getCopyOptionGroup

    Copies the specified option group.

  • actionCopyOptionGroup.postCopyOptionGroup

    Copies the specified option group.

  • actionCreateBlueGreenDeployment.getCreateBlueGreenDeployment

    Creates a blue/green deployment.

    A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.

    You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionCreateBlueGreenDeployment.postCreateBlueGreenDeployment

    Creates a blue/green deployment.

    A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.

    You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionCreateCustomDbEngineVersion.getCreateCustomDbEngineVersion

    Creates a custom DB engine version (CEV).

  • actionCreateCustomDbEngineVersion.postCreateCustomDbEngineVersion

    Creates a custom DB engine version (CEV).

  • actionCreateDbCluster.getCreateDbCluster

    Creates 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 create the writer instance for your DB cluster using the operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.

    You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see in the Amazon Aurora User Guide.

    You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionCreateDbCluster.postCreateDbCluster

    Creates 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 create the writer instance for your DB cluster using the operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.

    You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see in the Amazon Aurora User Guide.

    You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionCreateDbClusterEndpoint.getCreateDbClusterEndpoint

    Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

    This action applies only to Aurora DB clusters.

  • actionCreateDbClusterEndpoint.postCreateDbClusterEndpoint

    Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

    This action applies only to Aurora DB clusters.

  • actionCreateDbClusterParameterGroup.getCreateDbClusterParameterGroup

    Creates 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 group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.

    When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionCreateDbClusterParameterGroup.postCreateDbClusterParameterGroup

    Creates 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 group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.

    When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionCreateDbClusterSnapshot.getCreateDbClusterSnapshot

    Creates a snapshot of a DB cluster.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionCreateDbClusterSnapshot.postCreateDbClusterSnapshot

    Creates a snapshot of a DB cluster.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionCreateDbInstance.getCreateDbInstance

    Creates 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 can call this operation multiple times to add more than one DB instance to the cluster.

    For more information about creating an RDS DB instance, see in the Amazon RDS User Guide.

    For more information about creating a DB instance in an Aurora DB cluster, see in the Amazon Aurora User Guide.

  • actionCreateDbInstance.postCreateDbInstance

    Creates 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 can call this operation multiple times to add more than one DB instance to the cluster.

    For more information about creating an RDS DB instance, see in the Amazon RDS User Guide.

    For more information about creating a DB instance in an Aurora DB cluster, see in the Amazon Aurora User Guide.

  • actionCreateDbInstanceReadReplica.getCreateDbInstanceReadReplica

    Creates 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 instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see and in the Amazon RDS User Guide.

    Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster.

    All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.

    Your source DB instance or cluster must have backup retention enabled.

  • actionCreateDbInstanceReadReplica.postCreateDbInstanceReadReplica

    Creates 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 instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see and in the Amazon RDS User Guide.

    Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster.

    All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.

    Your source DB instance or cluster must have backup retention enabled.

  • actionCreateDbParameterGroup.getCreateDbParameterGroup

    Creates 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 provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

    This command doesn't apply to RDS Custom.

    After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

  • actionCreateDbParameterGroup.postCreateDbParameterGroup

    Creates 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 provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

    This command doesn't apply to RDS Custom.

    After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

  • actionCreateDbProxy.getCreateDbProxy

    Creates a new DB proxy.

  • actionCreateDbProxy.postCreateDbProxy

    Creates a new DB proxy.

  • actionCreateDbProxyEndpoint.getCreateDbProxyEndpoint

    Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

  • actionCreateDbProxyEndpoint.postCreateDbProxyEndpoint

    Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

  • actionCreateDbSecurityGroup.getCreateDbSecurityGroup

    Creates 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 not in a VPC.

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionCreateDbSecurityGroup.postCreateDbSecurityGroup

    Creates 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 not in a VPC.

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionCreateDbSnapshot.getCreateDbSnapshot

    Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

  • actionCreateDbSnapshot.postCreateDbSnapshot

    Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

  • actionCreateDbSubnetGroup.getCreateDbSubnetGroup

    Creates 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.

  • actionCreateDbSubnetGroup.postCreateDbSubnetGroup

    Creates 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.

  • actionCreateEventSubscription.getCreateEventSubscription

    Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

    You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.

    For more information about subscribing to an event for RDS DB engines, see in the Amazon RDS User Guide.

    For more information about subscribing to an event for Aurora DB engines, see in the Amazon Aurora User Guide.

  • actionCreateEventSubscription.postCreateEventSubscription

    Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

    You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.

    For more information about subscribing to an event for RDS DB engines, see in the Amazon RDS User Guide.

    For more information about subscribing to an event for Aurora DB engines, see in the Amazon Aurora User Guide.

  • actionCreateGlobalCluster.getCreateGlobalCluster

    Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

    You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

    This action applies only to Aurora DB clusters.

  • actionCreateGlobalCluster.postCreateGlobalCluster

    Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

    You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

    This action applies only to Aurora DB clusters.

  • actionCreateOptionGroup.getCreateOptionGroup

    Creates a new option group. You can create up to 20 option groups.

    This command doesn't apply to RDS Custom.

  • actionCreateOptionGroup.postCreateOptionGroup

    Creates a new option group. You can create up to 20 option groups.

    This command doesn't apply to RDS Custom.

  • actionDeleteBlueGreenDeployment.getDeleteBlueGreenDeployment

    Deletes a blue/green deployment.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionDeleteBlueGreenDeployment.postDeleteBlueGreenDeployment

    Deletes a blue/green deployment.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionDeleteCustomDbEngineVersion.getDeleteCustomDbEngineVersion

    Deletes 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 is, change the default before running this command.

    • The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.

    Typically, deletion takes a few minutes.

    The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.

    For more information, see in the Amazon RDS User Guide.

  • actionDeleteCustomDbEngineVersion.postDeleteCustomDbEngineVersion

    Deletes 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 is, change the default before running this command.

    • The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.

    Typically, deletion takes a few minutes.

    The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.

    For more information, see in the Amazon RDS User Guide.

  • actionDeleteDbCluster.getDeleteDbCluster

    The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

    If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDeleteDbCluster.postDeleteDbCluster

    The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

    If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDeleteDbClusterEndpoint.getDeleteDbClusterEndpoint

    Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

  • actionDeleteDbClusterEndpoint.postDeleteDbClusterEndpoint

    Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

  • actionDeleteDbClusterParameterGroup.getDeleteDbClusterParameterGroup

    Deletes 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 Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDeleteDbClusterParameterGroup.postDeleteDbClusterParameterGroup

    Deletes 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 Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDeleteDbClusterSnapshot.getDeleteDbClusterSnapshot

    Deletes 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 deleted.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDeleteDbClusterSnapshot.postDeleteDbClusterSnapshot

    Deletes 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 deleted.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDeleteDbInstance.getDeleteDbInstance

    The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

    If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

    When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

    If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

    • The DB cluster is a read replica of another Amazon Aurora DB cluster.

    • The DB instance is the only instance in the DB cluster.

    To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

  • actionDeleteDbInstance.postDeleteDbInstance

    The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

    If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

    When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

    If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

    • The DB cluster is a read replica of another Amazon Aurora DB cluster.

    • The DB instance is the only instance in the DB cluster.

    To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

  • actionDeleteDbInstanceAutomatedBackup.getDeleteDbInstanceAutomatedBackup

    Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

  • actionDeleteDbInstanceAutomatedBackup.postDeleteDbInstanceAutomatedBackup

    Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

  • actionDeleteDbParameterGroup.getDeleteDbParameterGroup

    Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

  • actionDeleteDbParameterGroup.postDeleteDbParameterGroup

    Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

  • actionDeleteDbProxy.getDeleteDbProxy

    Deletes an existing DB proxy.

  • actionDeleteDbProxy.postDeleteDbProxy

    Deletes an existing DB proxy.

  • actionDeleteDbProxyEndpoint.getDeleteDbProxyEndpoint

    Deletes 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 provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.

  • actionDeleteDbProxyEndpoint.postDeleteDbProxyEndpoint

    Deletes 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 provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.

  • actionDeleteDbSecurityGroup.getDeleteDbSecurityGroup

    Deletes 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 haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionDeleteDbSecurityGroup.postDeleteDbSecurityGroup

    Deletes 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 haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionDeleteDbSnapshot.getDeleteDbSnapshot

    Deletes 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.

  • actionDeleteDbSnapshot.postDeleteDbSnapshot

    Deletes 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.

  • actionDeleteDbSubnetGroup.getDeleteDbSubnetGroup

    Deletes a DB subnet group.

    The specified database subnet group must not be associated with any DB instances.

  • actionDeleteDbSubnetGroup.postDeleteDbSubnetGroup

    Deletes a DB subnet group.

    The specified database subnet group must not be associated with any DB instances.

  • actionDeleteEventSubscription.getDeleteEventSubscription

    Deletes an RDS event notification subscription.

  • actionDeleteEventSubscription.postDeleteEventSubscription

    Deletes an RDS event notification subscription.

  • actionDeleteGlobalCluster.getDeleteGlobalCluster

    Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

    This action only applies to Aurora DB clusters.

  • actionDeleteGlobalCluster.postDeleteGlobalCluster

    Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

    This action only applies to Aurora DB clusters.

  • actionDeleteOptionGroup.getDeleteOptionGroup

    Deletes an existing option group.

  • actionDeleteOptionGroup.postDeleteOptionGroup

    Deletes an existing option group.

  • actionDeregisterDbProxyTargets.getDeregisterDbProxyTargets

    Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

  • actionDeregisterDbProxyTargets.postDeregisterDbProxyTargets

    Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

  • actionDescribeAccountAttributes.getDescribeAccountAttributes

    Lists 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 description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

    This command doesn't take any parameters.

  • actionDescribeAccountAttributes.postDescribeAccountAttributes

    Lists 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 description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

    This command doesn't take any parameters.

  • actionDescribeBlueGreenDeployments.getDescribeBlueGreenDeployments

    Returns information about blue/green deployments.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionDescribeBlueGreenDeployments.postDescribeBlueGreenDeployments

    Returns information about blue/green deployments.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionDescribeCertificates.getDescribeCertificates

    Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionDescribeCertificates.postDescribeCertificates

    Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionDescribeDbClusterBacktracks.getDescribeDbClusterBacktracks

    Returns information about backtracks for a DB cluster.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    This action only applies to Aurora MySQL DB clusters.

  • actionDescribeDbClusterBacktracks.postDescribeDbClusterBacktracks

    Returns information about backtracks for a DB cluster.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    This action only applies to Aurora MySQL DB clusters.

  • actionDescribeDbClusterEndpoints.getDescribeDbClusterEndpoints

    Returns information about endpoints for an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

  • actionDescribeDbClusterEndpoints.postDescribeDbClusterEndpoints

    Returns information about endpoints for an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

  • actionDescribeDbClusterParameterGroups.getDescribeDbClusterParameterGroups

    Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDescribeDbClusterParameterGroups.postDescribeDbClusterParameterGroups

    Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDescribeDbClusterParameters.getDescribeDbClusterParameters

    Returns the detailed parameter list for a particular DB cluster parameter group.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDescribeDbClusterParameters.postDescribeDbClusterParameters

    Returns the detailed parameter list for a particular DB cluster parameter group.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDescribeDbClusters.getDescribeDbClusters

    Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

    This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

  • actionDescribeDbClusters.postDescribeDbClusters

    Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

    This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

  • actionDescribeDbClusterSnapshotAttributes.getDescribeDbClusterSnapshotAttributes

    Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

    When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

    To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

  • actionDescribeDbClusterSnapshotAttributes.postDescribeDbClusterSnapshotAttributes

    Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

    When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

    To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

  • actionDescribeDbClusterSnapshots.getDescribeDbClusterSnapshots

    Returns information about DB cluster snapshots. This API action supports pagination.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDescribeDbClusterSnapshots.postDescribeDbClusterSnapshots

    Returns information about DB cluster snapshots. This API action supports pagination.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionDescribeDbEngineVersions.getDescribeDbEngineVersions

    Returns a list of the available DB engines.

  • actionDescribeDbEngineVersions.postDescribeDbEngineVersions

    Returns a list of the available DB engines.

  • actionDescribeDbInstanceAutomatedBackups.getDescribeDbInstanceAutomatedBackups

    Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

    All parameters are optional.

  • actionDescribeDbInstanceAutomatedBackups.postDescribeDbInstanceAutomatedBackups

    Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

    All parameters are optional.

  • actionDescribeDbInstances.getDescribeDbInstances

    Returns information about provisioned RDS instances. This API supports pagination.

    This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

  • actionDescribeDbInstances.postDescribeDbInstances

    Returns information about provisioned RDS instances. This API supports pagination.

    This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

  • actionDescribeDbLogFiles.getDescribeDbLogFiles

    Returns a list of DB log files for the DB instance.

    This command doesn't apply to RDS Custom.

  • actionDescribeDbLogFiles.postDescribeDbLogFiles

    Returns a list of DB log files for the DB instance.

    This command doesn't apply to RDS Custom.

  • actionDescribeDbParameterGroups.getDescribeDbParameterGroups

    Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

  • actionDescribeDbParameterGroups.postDescribeDbParameterGroups

    Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

  • actionDescribeDbParameters.getDescribeDbParameters

    Returns the detailed parameter list for a particular DB parameter group.

  • actionDescribeDbParameters.postDescribeDbParameters

    Returns the detailed parameter list for a particular DB parameter group.

  • actionDescribeDbProxies.getDescribeDbProxies

    Returns information about DB proxies.

  • actionDescribeDbProxies.postDescribeDbProxies

    Returns information about DB proxies.

  • actionDescribeDbProxyEndpoints.getDescribeDbProxyEndpoints

    Returns information about DB proxy endpoints.

  • actionDescribeDbProxyEndpoints.postDescribeDbProxyEndpoints

    Returns information about DB proxy endpoints.

  • actionDescribeDbProxyTargetGroups.getDescribeDbProxyTargetGroups

    Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

  • actionDescribeDbProxyTargetGroups.postDescribeDbProxyTargetGroups

    Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

  • actionDescribeDbProxyTargets.getDescribeDbProxyTargets

    Returns information about DBProxyTarget objects. This API supports pagination.

  • actionDescribeDbProxyTargets.postDescribeDbProxyTargets

    Returns information about DBProxyTarget objects. This API supports pagination.

  • actionDescribeDbSecurityGroups.getDescribeDbSecurityGroups

    Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionDescribeDbSecurityGroups.postDescribeDbSecurityGroups

    Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionDescribeDbSnapshotAttributes.getDescribeDbSnapshotAttributes

    Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

    When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.

    To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

  • actionDescribeDbSnapshotAttributes.postDescribeDbSnapshotAttributes

    Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

    When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.

    To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

  • actionDescribeDbSnapshots.getDescribeDbSnapshots

    Returns information about DB snapshots. This API action supports pagination.

  • actionDescribeDbSnapshots.postDescribeDbSnapshots

    Returns information about DB snapshots. This API action supports pagination.

  • actionDescribeDbSubnetGroups.getDescribeDbSubnetGroups

    Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

    For an overview of CIDR ranges, go to the .

  • actionDescribeDbSubnetGroups.postDescribeDbSubnetGroups

    Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

    For an overview of CIDR ranges, go to the .

  • actionDescribeEngineDefaultClusterParameters.getDescribeEngineDefaultClusterParameters

    Returns the default engine and system parameter information for the cluster database engine.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

  • actionDescribeEngineDefaultClusterParameters.postDescribeEngineDefaultClusterParameters

    Returns the default engine and system parameter information for the cluster database engine.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

  • actionDescribeEngineDefaultParameters.getDescribeEngineDefaultParameters

    Returns the default engine and system parameter information for the specified database engine.

  • actionDescribeEngineDefaultParameters.postDescribeEngineDefaultParameters

    Returns the default engine and system parameter information for the specified database engine.

  • actionDescribeEventCategories.getDescribeEventCategories

    Displays 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 categories and event messages" section of the or the .

  • actionDescribeEventCategories.postDescribeEventCategories

    Displays 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 categories and event messages" section of the or the .

  • actionDescribeEvents.getDescribeEvents

    Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.

    For more information on working with events, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

    By default, RDS returns events that were generated in the past hour.

  • actionDescribeEvents.postDescribeEvents

    Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.

    For more information on working with events, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

    By default, RDS returns events that were generated in the past hour.

  • actionDescribeEventSubscriptions.getDescribeEventSubscriptions

    Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    If you specify a SubscriptionName, lists the description for that subscription.

  • actionDescribeEventSubscriptions.postDescribeEventSubscriptions

    Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    If you specify a SubscriptionName, lists the description for that subscription.

  • actionDescribeExportTasks.getDescribeExportTasks

    Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.

  • actionDescribeExportTasks.postDescribeExportTasks

    Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.

  • actionDescribeGlobalClusters.getDescribeGlobalClusters

    Returns information about Aurora global database clusters. This API supports pagination.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

  • actionDescribeGlobalClusters.postDescribeGlobalClusters

    Returns information about Aurora global database clusters. This API supports pagination.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

  • actionDescribeOptionGroupOptions.getDescribeOptionGroupOptions

    Describes all available options.

  • actionDescribeOptionGroupOptions.postDescribeOptionGroupOptions

    Describes all available options.

  • actionDescribeOptionGroups.getDescribeOptionGroups

    Describes the available option groups.

  • actionDescribeOptionGroups.postDescribeOptionGroups

    Describes the available option groups.

  • actionDescribeOrderableDbInstanceOptions.getDescribeOrderableDbInstanceOptions

    Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

  • actionDescribeOrderableDbInstanceOptions.postDescribeOrderableDbInstanceOptions

    Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

  • actionDescribePendingMaintenanceActions.getDescribePendingMaintenanceActions

    Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

  • actionDescribePendingMaintenanceActions.postDescribePendingMaintenanceActions

    Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

  • actionDescribeReservedDbInstances.getDescribeReservedDbInstances

    Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

  • actionDescribeReservedDbInstances.postDescribeReservedDbInstances

    Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

  • actionDescribeReservedDbInstancesOfferings.getDescribeReservedDbInstancesOfferings

    Lists available reserved DB instance offerings.

  • actionDescribeReservedDbInstancesOfferings.postDescribeReservedDbInstancesOfferings

    Lists available reserved DB instance offerings.

  • actionDescribeSourceRegions.getDescribeSourceRegions

    Returns 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 replicate automated backups from.

    Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.

    To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see in the Amazon EC2 API Reference.

  • actionDescribeSourceRegions.postDescribeSourceRegions

    Returns 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 replicate automated backups from.

    Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.

    To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see in the Amazon EC2 API Reference.

  • actionDescribeValidDbInstanceModifications.getDescribeValidDbInstanceModifications

    You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

    This command doesn't apply to RDS Custom.

  • actionDescribeValidDbInstanceModifications.postDescribeValidDbInstanceModifications

    You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

    This command doesn't apply to RDS Custom.

  • actionDownloadDbLogFilePortion.getDownloadDbLogFilePortion

    Downloads all or a portion of the specified log file, up to 1 MB in size.

    This command doesn't apply to RDS Custom.

  • actionDownloadDbLogFilePortion.postDownloadDbLogFilePortion

    Downloads all or a portion of the specified log file, up to 1 MB in size.

    This command doesn't apply to RDS Custom.

  • actionFailoverDbCluster.getFailoverDbCluster

    Forces 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 cluster to be the primary DB instance (the cluster writer).

    For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

    An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

    To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionFailoverDbCluster.postFailoverDbCluster

    Forces 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 cluster to be the primary DB instance (the cluster writer).

    For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

    An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

    To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionFailoverGlobalCluster.getFailoverGlobalCluster

    Initiates the failover process for an Aurora global database (GlobalCluster [blocked]).

    A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.

    For more information about failing over an Amazon Aurora global database, see in the Amazon Aurora User Guide.

    This action applies to GlobalCluster [blocked] (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.

  • actionFailoverGlobalCluster.postFailoverGlobalCluster

    Initiates the failover process for an Aurora global database (GlobalCluster [blocked]).

    A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.

    For more information about failing over an Amazon Aurora global database, see in the Amazon Aurora User Guide.

    This action applies to GlobalCluster [blocked] (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.

  • actionListTagsForResource.getListTagsForResource

    Lists all tags on an Amazon RDS resource.

    For an overview on tagging an Amazon RDS resource, see in the Amazon RDS User Guide.

  • actionListTagsForResource.postListTagsForResource

    Lists all tags on an Amazon RDS resource.

    For an overview on tagging an Amazon RDS resource, see in the Amazon RDS User Guide.

  • actionModifyActivityStream.getModifyActivityStream

    Changes 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 is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see in the Amazon RDS User Guide.

    This operation is supported for RDS for Oracle and Microsoft SQL Server.

  • actionModifyActivityStream.postModifyActivityStream

    Changes 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 is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see in the Amazon RDS User Guide.

    This operation is supported for RDS for Oracle and Microsoft SQL Server.

  • actionModifyCertificates.getModifyCertificates

    Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.

    By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.

    You might need to override the default certificate in the following situations:

    • You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.

    • RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.

    For more information about rotating your SSL/TLS certificate for RDS DB engines, see in the Amazon RDS User Guide.

    For more information about rotating your SSL/TLS certificate for Aurora DB engines, see in the Amazon Aurora User Guide.

  • actionModifyCertificates.postModifyCertificates

    Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.

    By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.

    You might need to override the default certificate in the following situations:

    • You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.

    • RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.

    For more information about rotating your SSL/TLS certificate for RDS DB engines, see in the Amazon RDS User Guide.

    For more information about rotating your SSL/TLS certificate for Aurora DB engines, see in the Amazon Aurora User Guide.

  • actionModifyCurrentDbClusterCapacity.getModifyCurrentDbClusterCapacity

    Set 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 some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

    After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

    For more information about Aurora Serverless v1, see in the Amazon Aurora User Guide.

    If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see in the Amazon Aurora User Guide.

    This action only applies to Aurora Serverless v1 DB clusters.

  • actionModifyCurrentDbClusterCapacity.postModifyCurrentDbClusterCapacity

    Set 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 some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

    After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

    For more information about Aurora Serverless v1, see in the Amazon Aurora User Guide.

    If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see in the Amazon Aurora User Guide.

    This action only applies to Aurora Serverless v1 DB clusters.

  • actionModifyCustomDbEngineVersion.getModifyCustomDbEngineVersion

    Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.

    The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.

    For more information, see in the Amazon RDS User Guide.

  • actionModifyCustomDbEngineVersion.postModifyCustomDbEngineVersion

    Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.

    The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.

    For more information, see in the Amazon RDS User Guide.

  • actionModifyDbCluster.getModifyDbCluster

    Modify the settings for 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 values in the request.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionModifyDbCluster.postModifyDbCluster

    Modify the settings for 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 values in the request.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionModifyDbClusterEndpoint.getModifyDbClusterEndpoint

    Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

  • actionModifyDbClusterEndpoint.postModifyDbClusterEndpoint

    Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

  • actionModifyDbClusterParameterGroup.getModifyDbClusterParameterGroup

    Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

    If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionModifyDbClusterParameterGroup.postModifyDbClusterParameterGroup

    Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

    If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionModifyDbClusterSnapshotAttribute.getModifyDbClusterSnapshotAttribute

    Adds 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 Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.

    Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

    If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

    To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes [blocked] API operation. The accounts are returned as values for the restore attribute.

  • actionModifyDbClusterSnapshotAttribute.postModifyDbClusterSnapshotAttribute

    Adds 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 Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.

    Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

    If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

    To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes [blocked] API operation. The accounts are returned as values for the restore attribute.

  • actionModifyDbInstance.getModifyDbInstance

    Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

  • actionModifyDbInstance.postModifyDbInstance

    Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

  • actionModifyDbParameterGroup.getModifyDbParameterGroup

    Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

  • actionModifyDbParameterGroup.postModifyDbParameterGroup

    Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

  • actionModifyDbProxy.getModifyDbProxy

    Changes the settings for an existing DB proxy.

  • actionModifyDbProxy.postModifyDbProxy

    Changes the settings for an existing DB proxy.

  • actionModifyDbProxyEndpoint.getModifyDbProxyEndpoint

    Changes the settings for an existing DB proxy endpoint.

  • actionModifyDbProxyEndpoint.postModifyDbProxyEndpoint

    Changes the settings for an existing DB proxy endpoint.

  • actionModifyDbProxyTargetGroup.getModifyDbProxyTargetGroup

    Modifies the properties of a DBProxyTargetGroup.

  • actionModifyDbProxyTargetGroup.postModifyDbProxyTargetGroup

    Modifies the properties of a DBProxyTargetGroup.

  • actionModifyDbSnapshot.getModifyDbSnapshot

    Updates 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 DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.

  • actionModifyDbSnapshot.postModifyDbSnapshot

    Updates 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 DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.

  • actionModifyDbSnapshotAttribute.getModifyDbSnapshotAttribute

    Adds 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 accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.

    Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

    If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

    To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes [blocked] API operation. The accounts are returned as values for the restore attribute.

  • actionModifyDbSnapshotAttribute.postModifyDbSnapshotAttribute

    Adds 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 accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.

    Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

    If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

    To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes [blocked] API operation. The accounts are returned as values for the restore attribute.

  • actionModifyDbSubnetGroup.getModifyDbSubnetGroup

    Modifies 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.

  • actionModifyDbSubnetGroup.postModifyDbSubnetGroup

    Modifies 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.

  • actionModifyEventSubscription.getModifyEventSubscription

    Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

    You can see a list of the event categories for a given source type (SourceType) in in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

  • actionModifyEventSubscription.postModifyEventSubscription

    Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

    You can see a list of the event categories for a given source type (SourceType) in in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

  • actionModifyGlobalCluster.getModifyGlobalCluster

    Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

  • actionModifyGlobalCluster.postModifyGlobalCluster

    Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

  • actionModifyOptionGroup.getModifyOptionGroup

    Modifies an existing option group.

  • actionModifyOptionGroup.postModifyOptionGroup

    Modifies an existing option group.

  • actionPromoteReadReplica.getPromoteReadReplica

    Promotes 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 backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.

    • This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

  • actionPromoteReadReplica.postPromoteReadReplica

    Promotes 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 backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.

    • This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

  • actionPromoteReadReplicaDbCluster.getPromoteReadReplicaDbCluster

    Promotes a read replica DB cluster to a standalone DB cluster.

  • actionPromoteReadReplicaDbCluster.postPromoteReadReplicaDbCluster

    Promotes a read replica DB cluster to a standalone DB cluster.

  • actionPurchaseReservedDbInstancesOffering.getPurchaseReservedDbInstancesOffering

    Purchases a reserved DB instance offering.

  • actionPurchaseReservedDbInstancesOffering.postPurchaseReservedDbInstancesOffering

    Purchases a reserved DB instance offering.

  • actionRebootDbCluster.getRebootDbCluster

    You 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 parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.

    Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

    Use this operation only for a non-Aurora Multi-AZ DB cluster.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionRebootDbCluster.postRebootDbCluster

    You 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 parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.

    Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

    Use this operation only for a non-Aurora Multi-AZ DB cluster.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionRebootDbInstance.getRebootDbInstance

    You 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 group associated with the DB instance, you must reboot the instance for the changes to take effect.

    Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

    For more information about rebooting, see in the Amazon RDS User Guide.

    This command doesn't apply to RDS Custom.

    If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

  • actionRebootDbInstance.postRebootDbInstance

    You 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 group associated with the DB instance, you must reboot the instance for the changes to take effect.

    Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

    For more information about rebooting, see in the Amazon RDS User Guide.

    This command doesn't apply to RDS Custom.

    If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

  • actionRegisterDbProxyTargets.getRegisterDbProxyTargets

    Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

  • actionRegisterDbProxyTargets.postRegisterDbProxyTargets

    Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

  • actionRemoveFromGlobalCluster.getRemoveFromGlobalCluster

    Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.

    This action only applies to Aurora DB clusters.

  • actionRemoveFromGlobalCluster.postRemoveFromGlobalCluster

    Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.

    This action only applies to Aurora DB clusters.

  • actionRemoveRoleFromDbCluster.getRemoveRoleFromDbCluster

    Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionRemoveRoleFromDbCluster.postRemoveRoleFromDbCluster

    Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionRemoveRoleFromDbInstance.getRemoveRoleFromDbInstance

    Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

  • actionRemoveRoleFromDbInstance.postRemoveRoleFromDbInstance

    Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

  • actionRemoveSourceIdentifierFromSubscription.getRemoveSourceIdentifierFromSubscription

    Removes a source identifier from an existing RDS event notification subscription.

  • actionRemoveSourceIdentifierFromSubscription.postRemoveSourceIdentifierFromSubscription

    Removes a source identifier from an existing RDS event notification subscription.

  • actionRemoveTagsFromResource.getRemoveTagsFromResource

    Removes metadata tags from an Amazon RDS resource.

    For an overview on tagging an Amazon RDS resource, see in the Amazon RDS User Guide.

  • actionRemoveTagsFromResource.postRemoveTagsFromResource

    Removes metadata tags from an Amazon RDS resource.

    For an overview on tagging an Amazon RDS resource, see in the Amazon RDS User Guide.

  • actionResetDbClusterParameterGroup.getResetDbClusterParameterGroup

    Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

    When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionResetDbClusterParameterGroup.postResetDbClusterParameterGroup

    Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

    When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionResetDbParameterGroup.getResetDbParameterGroup

    Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

  • actionResetDbParameterGroup.postResetDbParameterGroup

    Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

  • actionRestoreDbClusterFromS3.getRestoreDbClusterFromS3

    Creates 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 must be created using the Percona XtraBackup utility as described in in the Amazon Aurora User Guide.

    This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

  • actionRestoreDbClusterFromS3.postRestoreDbClusterFromS3

    Creates 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 must be created using the Percona XtraBackup utility as described in in the Amazon Aurora User Guide.

    This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.

    For more information on Amazon Aurora, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

  • actionRestoreDbClusterFromSnapshot.getRestoreDbClusterFromSnapshot

    Creates 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 you don't specify a security group, the new DB cluster is associated with the default security group.

    This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionRestoreDbClusterFromSnapshot.postRestoreDbClusterFromSnapshot

    Creates 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 you don't specify a security group, the new DB cluster is associated with the default security group.

    This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionRestoreDbClusterToPointInTime.getRestoreDbClusterToPointInTime

    Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

    For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionRestoreDbClusterToPointInTime.postRestoreDbClusterToPointInTime

    Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

    For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

    For more information on Amazon Aurora DB clusters, see in the Amazon Aurora User Guide.

    For more information on Multi-AZ DB clusters, see in the Amazon RDS User Guide.

  • actionRestoreDbInstanceFromDbSnapshot.getRestoreDbInstanceFromDbSnapshot

    Creates 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 configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

    If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.

    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

  • actionRestoreDbInstanceFromDbSnapshot.postRestoreDbInstanceFromDbSnapshot

    Creates 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 configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

    If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.

    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

  • actionRestoreDbInstanceFromS3.getRestoreDbInstanceFromS3

    Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see in the Amazon RDS User Guide.

    This command doesn't apply to RDS Custom.

  • actionRestoreDbInstanceFromS3.postRestoreDbInstanceFromS3

    Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see in the Amazon RDS User Guide.

    This command doesn't apply to RDS Custom.

  • actionRestoreDbInstanceToPointInTime.getRestoreDbInstanceToPointInTime

    Restores 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. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

    The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

  • actionRestoreDbInstanceToPointInTime.postRestoreDbInstanceToPointInTime

    Restores 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. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

    The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

  • actionRevokeDbSecurityGroupIngress.getRevokeDbSecurityGroupIngress

    Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionRevokeDbSecurityGroupIngress.postRevokeDbSecurityGroupIngress

    Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see in the Amazon EC2 User Guide, the blog , and in the Amazon RDS User Guide.

  • actionStartActivityStream.getStartActivityStream

    Starts a database activity stream to monitor activity on the database. For more information, see in the Amazon Aurora User Guide or in the Amazon RDS User Guide.

  • actionStartActivityStream.postStartActivityStream

    Starts a database activity stream to monitor activity on the database. For more information, see in the Amazon Aurora User Guide or in the Amazon RDS User Guide.

  • actionStartDbCluster.getStartDbCluster

    Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.

    For more information, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

  • actionStartDbCluster.postStartDbCluster

    Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.

    For more information, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

  • actionStartDbInstance.getStartDbInstance

    Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

    For more information, see in the Amazon RDS User Guide.

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

  • actionStartDbInstance.postStartDbInstance

    Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

    For more information, see in the Amazon RDS User Guide.

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

  • actionStartDbInstanceAutomatedBackupsReplication.getStartDbInstanceAutomatedBackupsReplication

    Enables replication of automated backups to a different Amazon Web Services Region.

    This command doesn't apply to RDS Custom.

    For more information, see in the Amazon RDS User Guide.

  • actionStartDbInstanceAutomatedBackupsReplication.postStartDbInstanceAutomatedBackupsReplication

    Enables replication of automated backups to a different Amazon Web Services Region.

    This command doesn't apply to RDS Custom.

    For more information, see in the Amazon RDS User Guide.

  • actionStartExportTask.getStartExportTask

    Starts 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 RDS Custom DB instances.

    You can't export cluster data from Multi-AZ DB clusters.

    For more information on exporting DB snapshot data, see in the Amazon RDS User Guide or in the Amazon Aurora User Guide.

    For more information on exporting DB cluster data, see in the Amazon Aurora User Guide.

  • actionStartExportTask.postStartExportTask

    Starts 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 RDS Custom DB instances.

    You can't export cluster data from Multi-AZ DB clusters.

    For more information on exporting DB snapshot data, see in the Amazon RDS User Guide or in the Amazon Aurora User Guide.

    For more information on exporting DB cluster data, see in the Amazon Aurora User Guide.

  • actionStopActivityStream.getStopActivityStream

    Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.

    For more information, see in the Amazon Aurora User Guide or in the Amazon RDS User Guide.

  • actionStopActivityStream.postStopActivityStream

    Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.

    For more information, see in the Amazon Aurora User Guide or in the Amazon RDS User Guide.

  • actionStopDbCluster.getStopDbCluster

    Stops 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. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

    For more information, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

  • actionStopDbCluster.postStopDbCluster

    Stops 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. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

    For more information, see in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

  • actionStopDbInstance.getStopDbInstance

    Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

    For more information, see in the Amazon RDS User Guide.

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

  • actionStopDbInstance.postStopDbInstance

    Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

    For more information, see in the Amazon RDS User Guide.

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

  • actionStopDbInstanceAutomatedBackupsReplication.getStopDbInstanceAutomatedBackupsReplication

    Stops automated backup replication for a DB instance.

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

    For more information, see in the Amazon RDS User Guide.

  • actionStopDbInstanceAutomatedBackupsReplication.postStopDbInstanceAutomatedBackupsReplication

    Stops automated backup replication for a DB instance.

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

    For more information, see in the Amazon RDS User Guide.

  • actionSwitchoverBlueGreenDeployment.getSwitchoverBlueGreenDeployment

    Switches over a blue/green deployment.

    Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionSwitchoverBlueGreenDeployment.postSwitchoverBlueGreenDeployment

    Switches over a blue/green deployment.

    Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.

    For more information, see in the Amazon RDS User Guide and in the Amazon Aurora User Guide.

  • actionSwitchoverReadReplica.getSwitchoverReadReplica

    Switches 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 the current standby database.

  • actionSwitchoverReadReplica.postSwitchoverReadReplica

    Switches 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 the current standby database.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools