UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 1.81 MB
{"openapi":"3.0.0","info":{"version":"2014-10-31","x-release":"v4","title":"Amazon Relational Database Service","description":"<fullname>Amazon Relational Database Service</fullname> <p/> <p>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.</p> <p>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.</p> <p>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.</p> <p> <b>Amazon RDS API Reference</b> </p> <ul> <li> <p>For the alphabetical list of API actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html\">API Actions</a>.</p> </li> <li> <p>For the alphabetical list of data types, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html\">Data Types</a>.</p> </li> <li> <p>For a list of common query parameters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html\">Common Parameters</a>.</p> </li> <li> <p>For descriptions of the error codes, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html\">Common Errors</a>.</p> </li> </ul> <p> <b>Amazon RDS User Guide</b> </p> <ul> <li> <p>For a summary of the Amazon RDS interfaces, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces\">Available RDS Interfaces</a>.</p> </li> <li> <p>For more information about how to use the Query API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html\">Using the Query API</a>.</p> </li> </ul>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"rds","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/rds-2014-10-31.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/rds/"},"servers":[{"url":"http://rds.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon RDS multi-region endpoint"},{"url":"https://rds.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon RDS multi-region endpoint"},{"url":"http://rds.amazonaws.com","variables":{},"description":"The general Amazon RDS multi-region endpoint"},{"url":"https://rds.amazonaws.com","variables":{},"description":"The general Amazon RDS multi-region endpoint"},{"url":"http://rds.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon RDS endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://rds.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon RDS endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/#Action=AddRoleToDBCluster":{"get":{"x-aws-operation-name":"AddRoleToDBCluster","operationId":"GET_AddRoleToDBCluster","description":"Associates an Identity and Access Management (IAM) role with a DB cluster.","responses":{"200":{"description":"Success"},"480":{"description":"DBClusterNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterNotFoundFault"}}}},"481":{"description":"DBClusterRoleAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterRoleAlreadyExistsFault"}}}},"482":{"description":"InvalidDBClusterStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBClusterStateFault"}}}},"483":{"description":"DBClusterRoleQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterRoleQuotaExceededFault"}}}}},"parameters":[{"name":"DBClusterIdentifier","in":"query","required":true,"description":"The name of the DB cluster to associate the IAM role with.","schema":{"type":"string"}},{"name":"RoleArn","in":"query","required":true,"description":"The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example <code>arn:aws:iam::123456789012:role/AuroraAccessRole</code>.","schema":{"type":"string"}},{"name":"FeatureName","in":"query","required":false,"description":"The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see <a>DBEngineVersion</a>.","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddRoleToDBCluster"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"AddRoleToDBCluster","operationId":"POST_AddRoleToDBCluster","description":"Associates an Identity and Access Management (IAM) role with a DB cluster.","responses":{"200":{"description":"Success"},"480":{"description":"DBClusterNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterNotFoundFault"}}}},"481":{"description":"DBClusterRoleAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterRoleAlreadyExistsFault"}}}},"482":{"description":"InvalidDBClusterStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBClusterStateFault"}}}},"483":{"description":"DBClusterRoleQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterRoleQuotaExceededFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AddRoleToDBClusterMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddRoleToDBCluster"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=AddRoleToDBInstance":{"get":{"x-aws-operation-name":"AddRoleToDBInstance","operationId":"GET_AddRoleToDBInstance","description":"<p>Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.</p> <note> <p>To add a role to a DB instance, the status of the DB instance must be <code>available</code>.</p> </note> <p>This command doesn't apply to RDS Custom.</p>","responses":{"200":{"description":"Success"},"480":{"description":"DBInstanceNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBInstanceNotFoundFault"}}}},"481":{"description":"DBInstanceRoleAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBInstanceRoleAlreadyExistsFault"}}}},"482":{"description":"InvalidDBInstanceStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBInstanceStateFault"}}}},"483":{"description":"DBInstanceRoleQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBInstanceRoleQuotaExceededFault"}}}}},"parameters":[{"name":"DBInstanceIdentifier","in":"query","required":true,"description":"The name of the DB instance to associate the IAM role with.","schema":{"type":"string"}},{"name":"RoleArn","in":"query","required":true,"description":"The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example <code>arn:aws:iam::123456789012:role/AccessRole</code>.","schema":{"type":"string"}},{"name":"FeatureName","in":"query","required":true,"description":"The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see <a>DBEngineVersion</a>.","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddRoleToDBInstance"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"AddRoleToDBInstance","operationId":"POST_AddRoleToDBInstance","description":"<p>Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.</p> <note> <p>To add a role to a DB instance, the status of the DB instance must be <code>available</code>.</p> </note> <p>This command doesn't apply to RDS Custom.</p>","responses":{"200":{"description":"Success"},"480":{"description":"DBInstanceNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBInstanceNotFoundFault"}}}},"481":{"description":"DBInstanceRoleAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBInstanceRoleAlreadyExistsFault"}}}},"482":{"description":"InvalidDBInstanceStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBInstanceStateFault"}}}},"483":{"description":"DBInstanceRoleQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBInstanceRoleQuotaExceededFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AddRoleToDBInstanceMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddRoleToDBInstance"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=AddSourceIdentifierToSubscription":{"get":{"x-aws-operation-name":"AddSourceIdentifierToSubscription","operationId":"GET_AddSourceIdentifierToSubscription","description":"Adds a source identifier to an existing RDS event notification subscription.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AddSourceIdentifierToSubscriptionResult"}}}},"480":{"description":"SubscriptionNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/SubscriptionNotFoundFault"}}}},"481":{"description":"SourceNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/SourceNotFoundFault"}}}}},"parameters":[{"name":"SubscriptionName","in":"query","required":true,"description":"The name of the RDS event notification subscription you want to add a source identifier to.","schema":{"type":"string"}},{"name":"SourceIdentifier","in":"query","required":true,"description":"<p>The identifier of the event source to be added.</p> <p>Constraints:</p> <ul> <li> <p>If the source type is a DB instance, a <code>DBInstanceIdentifier</code> value must be supplied.</p> </li> <li> <p>If the source type is a DB cluster, a <code>DBClusterIdentifier</code> value must be supplied.</p> </li> <li> <p>If the source type is a DB parameter group, a <code>DBParameterGroupName</code> value must be supplied.</p> </li> <li> <p>If the source type is a DB security group, a <code>DBSecurityGroupName</code> value must be supplied.</p> </li> <li> <p>If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> value must be supplied.</p> </li> <li> <p>If the source type is a DB cluster snapshot, a <code>DBClusterSnapshotIdentifier</code> value must be supplied.</p> </li> <li> <p>If the source type is an RDS Proxy, a <code>DBProxyName</code> value must be supplied.</p> </li> </ul>","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddSourceIdentifierToSubscription"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"AddSourceIdentifierToSubscription","operationId":"POST_AddSourceIdentifierToSubscription","description":"Adds a source identifier to an existing RDS event notification subscription.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AddSourceIdentifierToSubscriptionResult"}}}},"480":{"description":"SubscriptionNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/SubscriptionNotFoundFault"}}}},"481":{"description":"SourceNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/SourceNotFoundFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AddSourceIdentifierToSubscriptionMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddSourceIdentifierToSubscription"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=AddTagsToResource":{"get":{"x-aws-operation-name":"AddTagsToResource","operationId":"GET_AddTagsToResource","description":"<p>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.</p> <p>For an overview on tagging Amazon RDS resources, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html\">Tagging Amazon RDS Resources</a>.</p>","responses":{"200":{"description":"Success"},"480":{"description":"DBInstanceNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBInstanceNotFoundFault"}}}},"481":{"description":"DBClusterNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterNotFoundFault"}}}},"482":{"description":"DBSnapshotNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBSnapshotNotFoundFault"}}}},"483":{"description":"DBProxyNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBProxyNotFoundFault"}}}},"484":{"description":"DBProxyTargetGroupNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBProxyTargetGroupNotFoundFault"}}}},"485":{"description":"BlueGreenDeploymentNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/BlueGreenDeploymentNotFoundFault"}}}}},"parameters":[{"name":"ResourceName","in":"query","required":true,"description":"The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing\"> Constructing an RDS Amazon Resource Name (ARN)</a>.","schema":{"type":"string"}},{"name":"Tags","in":"query","required":true,"description":"The tags to be assigned to the Amazon RDS resource.","schema":{"type":"array","description":"A list of tags. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html\">Tagging Amazon RDS Resources</a> in the <i>Amazon RDS User Guide.</i> ","items":{"allOf":[{"$ref":"#/components/schemas/Tag"},{"xml":{"name":"Tag"}}]}}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddTagsToResource"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"AddTagsToResource","operationId":"POST_AddTagsToResource","description":"<p>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.</p> <p>For an overview on tagging Amazon RDS resources, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html\">Tagging Amazon RDS Resources</a>.</p>","responses":{"200":{"description":"Success"},"480":{"description":"DBInstanceNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBInstanceNotFoundFault"}}}},"481":{"description":"DBClusterNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterNotFoundFault"}}}},"482":{"description":"DBSnapshotNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBSnapshotNotFoundFault"}}}},"483":{"description":"DBProxyNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBProxyNotFoundFault"}}}},"484":{"description":"DBProxyTargetGroupNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBProxyTargetGroupNotFoundFault"}}}},"485":{"description":"BlueGreenDeploymentNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/BlueGreenDeploymentNotFoundFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AddTagsToResourceMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddTagsToResource"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=ApplyPendingMaintenanceAction":{"get":{"x-aws-operation-name":"ApplyPendingMaintenanceAction","operationId":"GET_ApplyPendingMaintenanceAction","description":"Applies a pending maintenance action to a resource (for example, to a DB instance).","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplyPendingMaintenanceActionResult"}}}},"480":{"description":"ResourceNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundFault"}}}},"481":{"description":"InvalidDBClusterStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBClusterStateFault"}}}},"482":{"description":"InvalidDBInstanceStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBInstanceStateFault"}}}}},"parameters":[{"name":"ResourceIdentifier","in":"query","required":true,"description":"The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing\"> Constructing an RDS Amazon Resource Name (ARN)</a>.","schema":{"type":"string"}},{"name":"ApplyAction","in":"query","required":true,"description":"<p>The pending maintenance action to apply to this resource.</p> <p>Valid values: <code>system-update</code>, <code>db-upgrade</code>, <code>hardware-maintenance</code>, <code>ca-certificate-rotation</code> </p>","schema":{"type":"string"}},{"name":"OptInType","in":"query","required":true,"description":"<p>A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type <code>immediate</code> can't be undone.</p> <p>Valid values:</p> <ul> <li> <p> <code>immediate</code> - Apply the maintenance action immediately.</p> </li> <li> <p> <code>next-maintenance</code> - Apply the maintenance action during the next maintenance window for the resource.</p> </li> <li> <p> <code>undo-opt-in</code> - Cancel any existing <code>next-maintenance</code> opt-in requests.</p> </li> </ul>","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ApplyPendingMaintenanceAction"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"ApplyPendingMaintenanceAction","operationId":"POST_ApplyPendingMaintenanceAction","description":"Applies a pending maintenance action to a resource (for example, to a DB instance).","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplyPendingMaintenanceActionResult"}}}},"480":{"description":"ResourceNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundFault"}}}},"481":{"description":"InvalidDBClusterStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBClusterStateFault"}}}},"482":{"description":"InvalidDBInstanceStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBInstanceStateFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplyPendingMaintenanceActionMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ApplyPendingMaintenanceAction"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=AuthorizeDBSecurityGroupIngress":{"get":{"x-aws-operation-name":"AuthorizeDBSecurityGroupIngress","operationId":"GET_AuthorizeDBSecurityGroupIngress","description":"<p>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).</p> <p>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.</p> <p>For an overview of CIDR ranges, go to the <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>.</p> <note> <p>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 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html\">Migrate from EC2-Classic to a VPC</a> in the <i>Amazon EC2 User Guide</i>, the blog <a href=\"http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/\">EC2-Classic Networking is Retiring – Here’s How to Prepare</a>, and <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html\">Moving a DB instance not in a VPC into a VPC</a> in the <i>Amazon RDS User Guide</i>.</p> </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AuthorizeDBSecurityGroupIngressResult"}}}},"480":{"description":"DBSecurityGroupNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBSecurityGroupNotFoundFault"}}}},"481":{"description":"InvalidDBSecurityGroupStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBSecurityGroupStateFault"}}}},"482":{"description":"AuthorizationAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AuthorizationAlreadyExistsFault"}}}},"483":{"description":"AuthorizationQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AuthorizationQuotaExceededFault"}}}}},"parameters":[{"name":"DBSecurityGroupName","in":"query","required":true,"description":"The name of the DB security group to add authorization to.","schema":{"type":"string"}},{"name":"CIDRIP","in":"query","required":false,"description":"The IP range to authorize.","schema":{"type":"string"}},{"name":"EC2SecurityGroupName","in":"query","required":false,"description":"Name of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.","schema":{"type":"string"}},{"name":"EC2SecurityGroupId","in":"query","required":false,"description":"Id of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.","schema":{"type":"string"}},{"name":"EC2SecurityGroupOwnerId","in":"query","required":false,"description":"Amazon Web Services account number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AuthorizeDBSecurityGroupIngress"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"AuthorizeDBSecurityGroupIngress","operationId":"POST_AuthorizeDBSecurityGroupIngress","description":"<p>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).</p> <p>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.</p> <p>For an overview of CIDR ranges, go to the <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>.</p> <note> <p>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 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html\">Migrate from EC2-Classic to a VPC</a> in the <i>Amazon EC2 User Guide</i>, the blog <a href=\"http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/\">EC2-Classic Networking is Retiring – Here’s How to Prepare</a>, and <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html\">Moving a DB instance not in a VPC into a VPC</a> in the <i>Amazon RDS User Guide</i>.</p> </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AuthorizeDBSecurityGroupIngressResult"}}}},"480":{"description":"DBSecurityGroupNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBSecurityGroupNotFoundFault"}}}},"481":{"description":"InvalidDBSecurityGroupStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBSecurityGroupStateFault"}}}},"482":{"description":"AuthorizationAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AuthorizationAlreadyExistsFault"}}}},"483":{"description":"AuthorizationQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AuthorizationQuotaExceededFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AuthorizeDBSecurityGroupIngressMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AuthorizeDBSecurityGroupIngress"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=BacktrackDBCluster":{"get":{"x-aws-operation-name":"BacktrackDBCluster","operationId":"GET_BacktrackDBCluster","description":"<p>Backtracks a DB cluster to a specific time, without creating a new DB cluster.</p> <p>For more information on backtracking, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html\"> Backtracking an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action applies only to Aurora MySQL DB clusters.</p> </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterBacktrack"}}}},"480":{"description":"DBClusterNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterNotFoundFault"}}}},"481":{"description":"InvalidDBClusterStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBClusterStateFault"}}}}},"parameters":[{"name":"DBClusterIdentifier","in":"query","required":true,"description":"<p>The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster1</code> </p>","schema":{"type":"string"}},{"name":"BacktrackTo","in":"query","required":true,"description":"<p>The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a> </p> <note> <p>If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.</p> </note> <p>Constraints:</p> <ul> <li> <p>Must contain a valid ISO 8601 timestamp.</p> </li> <li> <p>Can't contain a timestamp set in the future.</p> </li> </ul> <p>Example: <code>2017-07-08T18:00Z</code> </p>","schema":{"type":"string","format":"date-time"}},{"name":"Force","in":"query","required":false,"description":"A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.","schema":{"type":"boolean"}},{"name":"UseEarliestTimeOnPointInTimeUnavailable","in":"query","required":false,"description":"A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when <i>BacktrackTo</i> is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and <i>BacktrackTo</i> is set to a timestamp earlier than the earliest backtrack time, an error occurs.","schema":{"type":"boolean"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["BacktrackDBCluster"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"BacktrackDBCluster","operationId":"POST_BacktrackDBCluster","description":"<p>Backtracks a DB cluster to a specific time, without creating a new DB cluster.</p> <p>For more information on backtracking, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html\"> Backtracking an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action applies only to Aurora MySQL DB clusters.</p> </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterBacktrack"}}}},"480":{"description":"DBClusterNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterNotFoundFault"}}}},"481":{"description":"InvalidDBClusterStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBClusterStateFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/BacktrackDBClusterMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["BacktrackDBCluster"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=CancelExportTask":{"get":{"x-aws-operation-name":"CancelExportTask","operationId":"GET_CancelExportTask","description":"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.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ExportTask"}}}},"480":{"description":"ExportTaskNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ExportTaskNotFoundFault"}}}},"481":{"description":"InvalidExportTaskStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidExportTaskStateFault"}}}}},"parameters":[{"name":"ExportTaskIdentifier","in":"query","required":true,"description":"The identifier of the snapshot or cluster export task to cancel.","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CancelExportTask"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"CancelExportTask","operationId":"POST_CancelExportTask","description":"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.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ExportTask"}}}},"480":{"description":"ExportTaskNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ExportTaskNotFoundFault"}}}},"481":{"description":"InvalidExportTaskStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidExportTaskStateFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CancelExportTaskMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CancelExportTask"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=CopyDBClusterParameterGroup":{"get":{"x-aws-operation-name":"CopyDBClusterParameterGroup","operationId":"GET_CopyDBClusterParameterGroup","description":"Copies the specified DB cluster parameter group.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CopyDBClusterParameterGroupResult"}}}},"480":{"description":"DBParameterGroupNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBParameterGroupNotFoundFault"}}}},"481":{"description":"DBParameterGroupQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBParameterGroupQuotaExceededFault"}}}},"482":{"description":"DBParameterGroupAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBParameterGroupAlreadyExistsFault"}}}}},"parameters":[{"name":"SourceDBClusterParameterGroupIdentifier","in":"query","required":true,"description":"<p>The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing\"> Constructing an ARN for Amazon RDS</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB cluster parameter group.</p> </li> </ul>","schema":{"type":"string"}},{"name":"TargetDBClusterParameterGroupIdentifier","in":"query","required":true,"description":"<p>The identifier for the copied DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Can't be null, empty, or blank</p> </li> <li> <p>Must contain from 1 to 255 letters, numbers, or hyphens</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>my-cluster-param-group1</code> </p>","schema":{"type":"string"}},{"name":"TargetDBClusterParameterGroupDescription","in":"query","required":true,"description":"A description for the copied DB cluster parameter group.","schema":{"type":"string"}},{"name":"Tags","in":"query","required":false,"description":"","schema":{"type":"array","description":"A list of tags. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html\">Tagging Amazon RDS Resources</a> in the <i>Amazon RDS User Guide.</i> ","items":{"allOf":[{"$ref":"#/components/schemas/Tag"},{"xml":{"name":"Tag"}}]}}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CopyDBClusterParameterGroup"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"CopyDBClusterParameterGroup","operationId":"POST_CopyDBClusterParameterGroup","description":"Copies the specified DB cluster parameter group.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CopyDBClusterParameterGroupResult"}}}},"480":{"description":"DBParameterGroupNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBParameterGroupNotFoundFault"}}}},"481":{"description":"DBParameterGroupQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBParameterGroupQuotaExceededFault"}}}},"482":{"description":"DBParameterGroupAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBParameterGroupAlreadyExistsFault"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CopyDBClusterParameterGroupMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CopyDBClusterParameterGroup"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2014-10-31"]}}]}},"/#Action=CopyDBClusterSnapshot":{"get":{"x-aws-operation-name":"CopyDBClusterSnapshot","operationId":"GET_CopyDBClusterSnapshot","description":"<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p> <p>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 <code>CopyDBClusterSnapshot</code> 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:</p> <ul> <li> <p> <code>KmsKeyId</code> - 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.</p> </li> <li> <p> <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - 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 <code>SourceDBClusterSnapshotIdentifier</code> in the presigned URL.</p> </li> </ul> <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in \"copying\" status.</p> <p>For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html\"> Copying a Snapshot</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ DB cluster deployments</a> in the <i>Amazon RDS User Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CopyDBClusterSnapshotResult"}}}},"480":{"description":"DBClusterSnapshotAlreadyExistsFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterSnapshotAlreadyExistsFault"}}}},"481":{"description":"DBClusterSnapshotNotFoundFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DBClusterSnapshotNotFoundFault"}}}},"482":{"description":"InvalidDBClusterStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBClusterStateFault"}}}},"483":{"description":"InvalidDBClusterSnapshotStateFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidDBClusterSnapshotStateFault"}}}},"484":{"description":"SnapshotQuotaExceededFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/SnapshotQuotaExceededFault"}}}},"485":{"description":"KMSKeyNotAccessibleFault","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/KMSKeyNotAccessibleFault"}}}}},"parameters":[{"name":"SourceDBClusterSnapshotIdentifier","in":"query","required":true,"description":"<p>The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.</p> <p>You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> <li> <p>If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.</p> </li> <li> <p>If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions\"> Copying Snapshots Across Amazon Web Services Regions</a> in the <i>Amazon Aurora User Guide</i>.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>","schema":{"type":"string"}},{"name":"TargetDBClusterSnapshotIdentifier","in":"query","required":true,"description":"<p>The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot2</code> </p>","schema":{"type":"string"}},{"name":"KmsKeyId","in":"query","required":false,"description":"<p>The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.</p> <p>If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.</p> <p>If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for <code>KmsKeyId</code>.</p> <p>To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set <code>KmsKeyId</code> to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amaz