Amazon Relational Database Service API Reference API Version 2011-04-01 Amazon Relational Database Service: API Reference Copyright © 2011 Amazon Web Services LLC or its affiliates. All rights reserved. Amazon Relational Database Service API Reference Table of Contents Welcome 1 Actions 2 AuthorizeDBSecurityGroupIngress 4 CreateDBInstance 7 CreateDBInstanceReadReplica 17 CreateDBParameterGroup 23 CreateDBSecurityGroup 26 CreateDBSnapshot 28 DeleteDBInstance 31 DeleteDBParameterGroup 36 DeleteDBSecurityGroup 38 DeleteDBSnapshot 40 DescribeDBEngineVersions 43 DescribeDBInstances 47 DescribeDBParameterGroups 50 DescribeDBParameters 52 DescribeDBSecurityGroups 55 DescribeDBSnapshots 58 DescribeEngineDefaultParameters 61 DescribeEvents 64 DescribeOrderableDBInstanceOptions 68 DescribeReservedDBInstances 72 DescribeReservedDBInstancesOfferings 75 ModifyDBInstance 78 ModifyDBParameterGroup 87 PurchaseReservedDBInstancesOffering 89 RebootDBInstance 92 ResetDBParameterGroup 96 RestoreDBInstanceFromDBSnapshot 98 RestoreDBInstanceToPointInTime 104 RevokeDBSecurityGroupIngress 111 Data Types 114 AvailabilityZone 115 DBEngineVersion 115 DBInstance 116 DBParameterGroup 118 DBParameterGroupStatus 119 DBSecurityGroup 119 DBSecurityGroupMembership 120 DBSnapshot 120 DescribeDBEngineVersionsResult 121 DescribeDBInstancesResult 122 DescribeDBParameterGroupsResult 122 DescribeDBParametersResult 123 DescribeDBSecurityGroupsResult 123 DescribeDBSnapshotsResult 123 DescribeEventsResult 124 DescribeOrderableDBInstanceOptionsResult 124 DescribeReservedDBInstancesOfferingsResult 124 DescribeReservedDBInstancesResult 125 EC2SecurityGroup 125 Endpoint 126 EngineDefaults 126 Event 127 IPRange 127 Amazon Relational Database Service API Reference ModifyDBParameterGroupResult 127 OrderableDBInstanceOption 128 Parameter 128 PendingModifiedValues 129 ReservedDBInstance 130 ReservedDBInstancesOffering 131 ResetDBParameterGroupResult 132 Common Query Parameters 133 Common Errors 135 Amazon Relational Database Service API Reference Welcome 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, resizable 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 familiar MySQL or Oracle database server.This means the code, applications, and tools you already use today with your existing MySQL or Oracle 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 database 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 is the Amazon RDS API Reference. It contains a comprehensive description of all Amazon RDS Query APIs and data types.To get started with Amazon RDS, go to the Amazon RDS Getting Started Guide. For more information on Amazon RDS concepts and usage scenarios, go to the Amazon RDS User Guide. This document was last updated on October 7, 2011. API Version 2011-04-01 1 Amazon Relational Database Service API Reference Actions The actions described in this guide are called using the AWS Query protocol. The following actions are supported: • AuthorizeDBSecurityGroupIngress (p. 4) • CreateDBInstance (p. 7) • CreateDBInstanceReadReplica (p. 17) • CreateDBParameterGroup (p. 23) • CreateDBSecurityGroup (p. 26) • CreateDBSnapshot (p. 28) • DeleteDBInstance (p. 31) • DeleteDBParameterGroup (p. 36) • DeleteDBSecurityGroup (p. 38) • DeleteDBSnapshot (p. 40) • DescribeDBEngineVersions (p. 43) • DescribeDBInstances (p. 47) • DescribeDBParameterGroups (p. 50) • DescribeDBParameters (p. 52) • DescribeDBSecurityGroups (p. 55) • DescribeDBSnapshots (p. 58) • DescribeEngineDefaultParameters (p. 61) • DescribeEvents (p. 64) • DescribeOrderableDBInstanceOptions (p. 68) • DescribeReservedDBInstances (p. 72) • DescribeReservedDBInstancesOfferings (p. 75) • ModifyDBInstance (p. 78) • ModifyDBParameterGroup (p. 87) • PurchaseReservedDBInstancesOffering (p. 89) API Version 2011-04-01 2 Amazon Relational Database Service API Reference • RebootDBInstance (p. 92) • ResetDBParameterGroup (p. 96) • RestoreDBInstanceFromDBSnapshot (p. 98) • RestoreDBInstanceToPointInTime (p. 104) • RevokeDBSecurityGroupIngress (p. 111) API Version 2011-04-01 3 Amazon Relational Database Service API Reference AuthorizeDBSecurityGroupIngress Description Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 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 or (EC2SecurityGroupName AND EC2SecurityGroupOwnerId). Note You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB Instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.133). RequiredDescriptionName NoThe IP range to authorize. Type: String CIDRIP YesThe name of the DB Security Group to add authorization to. Type: String DBSecurityGroupName NoName of the EC2 Security Group to authorize. Type: String EC2SecurityGroupName NoAWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter.The AWS Access Key ID is not an acceptable value. Type: String EC2SecurityGroupOwnerId Response Elements The following elements come wrapped in a DBSecurityGroup structure. DescriptionName Provides the description of the DB Security Group. Type: String DBSecurityGroupDescription Specifies the name of the DB Security Group. Type: String DBSecurityGroupName Contains a list of EC2SecurityGroup (p. 125) elements. Type: EC2SecurityGroup (p. 125) list EC2SecurityGroups API Version 2011-04-01 4 Amazon Relational Database Service API Reference AuthorizeDBSecurityGroupIngress DescriptionName Contains a list of IPRange (p. 127) elements. Type: IPRange (p. 127) list IPRanges Provides the AWS ID of the owner of a specific DB Security Group. Type: String OwnerId Errors For information about the common errors that all actions use, see Common Errors (p. 135). HTTP Status Code DescriptionError 400The specified CIDRIP or EC2 security group is already authorized for the specified DB security group. AuthorizationAlreadyExists 400Database security group authorization quota has been reached. AuthorizationQuotaExceeded 404DBSecurityGroupName does not refer to an existing DB Security Group. DBSecurityGroupNotFound 400The state of the DB Security Group does not allow deletion. InvalidDBSecurityGroupState Examples Sample Request https://rds.amazonaws.com/ ?CIDRIP=192.168.1.1%2F24 &DBSecurityGroupName=mydbsecuritygroup &Version=2011-04-01 &Action=AuthorizeDBSecurityGroupIngress &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2009-10-22T17%3A10%3A50.274Z &AWSAccessKeyId=<AWS Access Key ID> &Signature=<Signature> Sample Response <AuthorizeDBSecurityGroupIngressResponse xmlns="http://rds.amazonaws.com/admin/2011-04-01/"> <AuthorizeDBSecurityGroupIngressResult> <DBSecurityGroup> <EC2SecurityGroups/> <DBSecurityGroupDescription>My new API Version 2011-04-01 5 Amazon Relational Database Service API Reference Errors DBSecurityGroup</DBSecurityGroupDescription> <IPRanges> <IPRange> <CIDRIP>192.168.1.1/24</CIDRIP> <Status>authorizing</Status> </IPRange> </IPRanges> <OwnerId>621567473609</OwnerId> <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName> </DBSecurityGroup> </AuthorizeDBSecurityGroupIngressResult> <ResponseMetadata> <RequestId>d9799197-bf2d-11de-b88d-993294bf1c81</RequestId> </ResponseMetadata> </AuthorizeDBSecurityGroupIngressResponse> API Version 2011-04-01 6 Amazon Relational Database Service API Reference Examples [...]... 0b447b66-bf36-11de-a88b-7b5b3d23b3a7 API Version 2011-04-01 24 Amazon Relational Database Service API Reference Examples API Version 2011-04-01 25 Amazon Relational Database Service API Reference CreateDBSecurityGroup CreateDBSecurityGroup Description Creates a new DB Security Group DB... default DB Security Group for the database engine Type: String list API Version 2011-04-01 9 Amazon Relational Database Service API Reference Request Parameters Name Description Required Engine The name of the database engine to be used for this instance Yes Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee Type: String EngineVersion The version number of the database engine to use No MySQL Example:... allowed amount of storage available across all DB Instances API Version 2011-04-01 20 400 Amazon Relational Database Service API Reference Examples Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateDBInstanceReadReplica &DBInstanceIdentifier=myreadreplica &SourceDBInstanceIdentifier=mydbinstance &Version= 2011-04-01 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-15T23%3A35%3A07.325Z... user-supplied database identifier This is the unique key that identifies a DB Instance Type: String DBInstanceStatus Specifies the current state of this database Type: String API Version 2011-04-01 18 Amazon Relational Database Service API Reference Response Elements Name Description DBName The meaning of this parameter differs according to the database engine you use MySQL Contains the name of the initial database. .. Request would result in user exceeding the allowed number 400 of DB Snapshots API Version 2011-04-01 29 Amazon Relational Database Service API Reference Examples Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateDBSnapshot &DBInstanceIdentifier=simcoprod01 &DBSnapshotIdentifier=mydbsnapshot &Version= 2011-04-01 &SignatureVersion=2&SignatureMethod=HmacSHA256 &Timestamp=2011-05-23T06%3A27%3A42.551Z... hyphens Example: mydbinstance Type: String API Version 2011-04-01 8 Amazon Relational Database Service API Reference Request Parameters Name Description Required DBName The meaning of this parameter differs according to No the database engine you use MySQL The name of the database to create when the DB Instance is created If this parameter is not specified, no database is created in the DB Instance Constraints:... String API Version 2011-04-01 28 Amazon Relational Database Service API Reference Errors Name Description DBInstanceIdentifier Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from Type: String DBSnapshotIdentifier Specifies the identifier for the DB Snapshot Type: String Engine Specifies the name of the database engine Type: String EngineVersion Specifies the version. .. 03:30-04:00 mydatabase true thu:07:00thu:07:30 20 db.m1.small awsuser API Version 2011-04-01 21 Amazon Relational Database Service API Reference Examples ... Minimum 30-minute window Type: String API Version 2011-04-01 12 No Amazon Relational Database Service API Reference Response Elements Response Elements The following elements come wrapped in a DBInstance structure Name Description AllocatedStorage Specifies the allocated storage size specified in gigabytes Type: Integer AutoMinorVersionUpgrade Indicates that minor version patches are applied automatically... (p 135) API Version 2011-04-01 26 Amazon Relational Database Service API Reference Examples Error Description HTTP Status Code DBSecurityGroupAlreadyExists A database security group with the name specified in DBSecurityGroupName already exists 400 DBSecurityGroupQuotaExceeded Request would result in user exceeding the allowed number of DB Security Groups 400 Examples Sample Request https://rds.amazonaws.com/ . Amazon Relational Database Service API Reference API Version 2011-04-01 Amazon Relational Database Service: API Reference Copyright © 2011 Amazon Web Services. 133 Common Errors 135 Amazon Relational Database Service API Reference Welcome Amazon Relational Database Service (Amazon RDS) is a web service that makes