RDA-API Amazon Relational Database Service API Reference


Amazon Relational Database Service API Reference API Version 2012-09-17 Amazon Relational Database Service: API Reference Copyright © 2011 - 2012 Amazon Web Services LLC or its affiliates. All rights reserved. Amazon Relational Database Service API Reference Welcome ................................................................................................................................................. 1 Actions .................................................................................................................................................... 2 AddTagsToResource ............................................................................................................................... 4 AuthorizeDBSecurityGroupIngress ......................................................................................................... 5 CopyDBSnapshot ................................................................................................................................... 8 CreateDBInstance ................................................................................................................................ 11 CreateDBInstanceReadReplica ............................................................................................................ 23 CreateDBParameterGroup ................................................................................................................... 29 CreateDBSecurityGroup ....................................................................................................................... 32 CreateDBSnapshot ............................................................................................................................... 34 CreateDBSubnetGroup ......................................................................................................................... 37 CreateOptionGroup .............................................................................................................................. 40 DeleteDBInstance ................................................................................................................................. 43 DeleteDBParameterGroup .................................................................................................................... 49 DeleteDBSecurityGroup ....................................................................................................................... 51 DeleteDBSnapshot ............................................................................................................................... 53 DeleteDBSubnetGroup ......................................................................................................................... 56 DeleteOptionGroup ............................................................................................................................... 58 DescribeDBEngineVersions .................................................................................................................. 59 DescribeDBInstances ........................................................................................................................... 64 DescribeDBParameterGroups .............................................................................................................. 67 DescribeDBParameters ........................................................................................................................ 69 DescribeDBSecurityGroups .................................................................................................................. 72 DescribeDBSnapshots ......................................................................................................................... 75 DescribeDBSubnetGroups ................................................................................................................... 79 DescribeEngineDefaultParameters ....................................................................................................... 82 DescribeEvents ..................................................................................................................................... 85 DescribeOptionGroupOptions .............................................................................................................. 89 DescribeOptionGroups ......................................................................................................................... 91 DescribeOrderableDBInstanceOptions ................................................................................................. 94 DescribeReservedDBInstances ............................................................................................................ 98 DescribeReservedDBInstancesOfferings ........................................................................................... 101 ListTagsForResource .......................................................................................................................... 104 ModifyDBInstance ............................................................................................................................... 105 ModifyDBParameterGroup .................................................................................................................. 115 ModifyDBSubnetGroup ....................................................................................................................... 117 ModifyOptionGroup ............................................................................................................................. 120 PromoteReadReplica .......................................................................................................................... 123 PurchaseReservedDBInstancesOffering ............................................................................................ 129 RebootDBInstance .............................................................................................................................. 132 RemoveTagsFromResource ............................................................................................................... 137 ResetDBParameterGroup ................................................................................................................... 138 RestoreDBInstanceFromDBSnapshot ................................................................................................ 140 RestoreDBInstanceToPointInTime ...................................................................................................... 147 RevokeDBSecurityGroupIngress ........................................................................................................ 155 Data Types .......................................................................................................................................... 158 AvailabilityZone ................................................................................................................................... 159 CharacterSet ....................................................................................................................................... 160 DBEngineVersion ................................................................................................................................ 160 DBInstance ......................................................................................................................................... 161 DBParameterGroup ............................................................................................................................ 163 DBParameterGroupStatus .................................................................................................................. 164 DBSecurityGroup ................................................................................................................................ 165 DBSecurityGroupMembership ............................................................................................................ 165 DBSnapshot ........................................................................................................................................ 166 DBSubnetGroup ................................................................................................................................. 167 DescribeDBEngineVersionsResult ..................................................................................................... 168 DescribeDBInstancesResult ............................................................................................................... 168 API Version 2012-09-17 3 Amazon Relational Database Service API Reference DescribeDBParameterGroupsResult .................................................................................................. 168 DescribeDBParametersResult ............................................................................................................ 169 DescribeDBSecurityGroupsResult ..................................................................................................... 169 DescribeDBSnapshotsResult ............................................................................................................. 170 DescribeDBSubnetGroupsResult ....................................................................................................... 170 DescribeEventsResult ........................................................................................................................ 170 DescribeOptionGroupOptionsResult .................................................................................................. 171 DescribeOptionGroupsResult ............................................................................................................. 171 DescribeOrderableDBInstanceOptionsResult .................................................................................... 171 DescribeReservedDBInstancesOfferingsResult ................................................................................. 172 DescribeReservedDBInstancesResult ............................................................................................... 172 EC2SecurityGroup .............................................................................................................................. 173 Endpoint ............................................................................................................................................. 173 EngineDefaults ................................................................................................................................... 174 Event ................................................................................................................................................... 174 IPRange .............................................................................................................................................. 175 ListTagsForResourceResult ................................................................................................................ 175 ModifyDBParameterGroupResult ....................................................................................................... 175 Option ................................................................................................................................................. 176 OptionConfiguration ............................................................................................................................ 176 OptionGroup ....................................................................................................................................... 176 OptionGroupMembership ................................................................................................................... 177 OptionGroupOption ............................................................................................................................. 177 OrderableDBInstanceOption ............................................................................................................... 178 Parameter ........................................................................................................................................... 179 PendingModifiedValues ...................................................................................................................... 180 RecurringCharge ................................................................................................................................ 181 ReservedDBInstance .......................................................................................................................... 181 ReservedDBInstancesOffering ........................................................................................................... 182 ResetDBParameterGroupResult ......................................................................................................... 183 Subnet ................................................................................................................................................ 183 Tag ...................................................................................................................................................... 184 Common Query Parameters ............................................................................................................... 185 Common Errors .................................................................................................................................. 187 API Version 2012-09-17 4 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 3, 2012. API Version 2012-09-17 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: · AddTagsToResource (p. 4) · AuthorizeDBSecurityGroupIngress (p. 5) · CopyDBSnapshot (p. 8) · CreateDBInstance (p. 11) · CreateDBInstanceReadReplica (p. 23) · CreateDBParameterGroup (p. 29) · CreateDBSecurityGroup (p. 32) · CreateDBSnapshot (p. 34) · CreateDBSubnetGroup (p. 37) · CreateOptionGroup (p. 40) · DeleteDBInstance (p. 43) · DeleteDBParameterGroup (p. 49) · DeleteDBSecurityGroup (p. 51) · DeleteDBSnapshot (p. 53) · DeleteDBSubnetGroup (p. 56) · DeleteOptionGroup (p. 58) · DescribeDBEngineVersions (p. 59) · DescribeDBInstances (p. 64) · DescribeDBParameterGroups (p. 67) · DescribeDBParameters (p. 69) · DescribeDBSecurityGroups (p. 72) · DescribeDBSnapshots (p. 75) · DescribeDBSubnetGroups (p. 79) · DescribeEngineDefaultParameters (p. 82) API Version 2012-09-17 2 Amazon Relational Database Service API Reference · DescribeEvents (p. 85) · DescribeOptionGroupOptions (p. 89) · DescribeOptionGroups (p. 91) · DescribeOrderableDBInstanceOptions (p. 94) · DescribeReservedDBInstances (p. 98) · DescribeReservedDBInstancesOfferings (p. 101) · ListTagsForResource (p. 104) · ModifyDBInstance (p. 105) · ModifyDBParameterGroup (p. 115) · ModifyDBSubnetGroup (p. 117) · ModifyOptionGroup (p. 120) · PromoteReadReplica (p. 123) · PurchaseReservedDBInstancesOffering (p. 129) · RebootDBInstance (p. 132) · RemoveTagsFromResource (p. 137) · ResetDBParameterGroup (p. 138) · RestoreDBInstanceFromDBSnapshot (p. 140) · RestoreDBInstanceToPointInTime (p. 147) · RevokeDBSecurityGroupIngress (p. 155) API Version 2012-09-17 3 Amazon Relational Database Service API Reference AddTagsToResource Description Adds metadata tags to a DB Instance.These tags can also be used with cost allocation reporting to track cost associated with a DB Instance. For an overview on tagging DB Instances, see DB Instance Tags. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe DB Instance the tags will be added to. Type: String ResourceName YesThe tags to be assigned to the DB Instance. Type: Tag (p. 184) list Tags.member.N Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance.DBInstanceNotFound 404DBSnapshotIdentifier does not refer to an existing DB Snapshot.DBSnapshotNotFound API Version 2012-09-17 4 Amazon Relational Database Service API Reference AddTagsToResource AuthorizeDBSecurityGroupIngress Description 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). Note You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB Instance in another.You cannot 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 Wikipedia Tutorial. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe IP range to authorize. Type: String CIDRIP YesThe name of the DB Security Group to add authorization to. Type: String DBSecurityGroupName NoId of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Type: String EC2SecurityGroupId NoName of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. 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. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Type: String EC2SecurityGroupOwnerId API Version 2012-09-17 5 Amazon Relational Database Service API Reference AuthorizeDBSecurityGroupIngress 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. 173) elements. Type: EC2SecurityGroup (p. 173) list EC2SecurityGroups Contains a list of IPRange (p. 175) elements. Type: IPRange (p. 175) list IPRanges Provides the AWS ID of the owner of a specific DB Security Group. Type: String OwnerId Provides the VpcId of the DB Security Group. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). 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=2012-09-17 &Action=AuthorizeDBSecurityGroupIngress API Version 2012-09-17 6 Amazon Relational Database Service API Reference Response Elements &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T17%3A10%3A50.274Z &AWSAccessKeyId= &Signature= Sample Response My new DBSecurityGroup 192.168.1.1/24 authorizing 621567473609 mydbsecuritygroup vpc-1ab2c3d4 d9799197-bf2d-11de-b88d-993294bf1c81 API Version 2012-09-17 7 Amazon Relational Database Service API Reference Examples CopyDBSnapshot Description Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe identifier for the source DB snapshot. Constraints: · Must be the identifier for a valid system snapshot in the "available" state. Example: rds:mydb-2012-04-02-00-01 Type: String SourceDBSnapshotIdentifier YesThe identifier for the copied snapshot. Constraints: · Cannot be null, empty, or blank · Must contain from 1 to 255 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot Type: String TargetDBSnapshotIdentifier Response Elements The following elements come wrapped in a DBSnapshot structure. DescriptionName Specifies the allocated storage size in gigabytes (GB). Type: Integer AllocatedStorage Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot. Type: String AvailabilityZone Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from. Type: String DBInstanceIdentifier API Version 2012-09-17 8 Amazon Relational Database Service API Reference CopyDBSnapshot DescriptionName Specifies the identifier for the DB Snapshot. Type: String DBSnapshotIdentifier Specifies the name of the database engine. Type: String Engine Specifies the version of the database engine. Type: String EngineVersion Specifies the time (UTC) when the snapshot was taken. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot. Type: Integer Iops License model information for the restored DB Instance. Type: String LicenseModel Provides the master username for the DB Instance. Type: String MasterUsername Specifies the port that the database engine was listening on at the time of the snapshot. Type: Integer Port Provides the time (UTC) when the snapshot was taken. Type: DateTime SnapshotCreateTime Provides the type of the DB Snapshot. Type: String SnapshotType Specifies the status of this DB Snapshot. Type: String Status Provides the Vpc Id associated with the DB Snapshot. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400DBSnapshotIdentifier is already used by an existing snapshot. DBSnapshotAlreadyExists 404DBSnapshotIdentifier does not refer to an existing DB Snapshot. DBSnapshotNotFound 400The state of the DB Security Snapshot does not allow deletion. InvalidDBSnapshotState API Version 2012-09-17 9 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 400Request would result in user exceeding the allowed number of DB Snapshots. SnapshotQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=CopyDBSnapshot &SourceDBSnapshotIdentifier=rds:simcoprod01-2012-04-02-00-01 &TargetDBSnapshotIdentifier=mydbsnapshot &Version=2012-09-17 &SignatureVersion=2&SignatureMethod=HmacSHA256 &Timestamp=2011-12-12T06%3A27%3A42.551Z &AWSAccessKeyId= &Signature= Sample Response 3306 mysql available us-east-1a general-public-license 2011-05-23T06:06:43.110Z 10 simcoprod01 5.1.50 mydbsnapshot manual master c4181d1d-8505-11e0-90aa-eb648410240d API Version 2012-09-17 10 Amazon Relational Database Service API Reference Examples CreateDBInstance Description Creates a new DB instance. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe amount of storage (in gigabytes) to be initially allocated for the database instance. MySQL Constraints: Must be an integer from 5 to 1024. Type: Integer Oracle Constraints: Must be an integer from 10 to 1024. SQL Server Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition) Type: Integer AllocatedStorage NoIndicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window. Default: true Type: Boolean AutoMinorVersionUpgrade NoThe EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone in the endpoint©s region. Example: us-east-1d Constraint:The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint. Type: String AvailabilityZone API Version 2012-09-17 11 Amazon Relational Database Service API Reference CreateDBInstance RequiredDescriptionName NoThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: · Must be a value from 0 to 8 · Cannot be set to 0 if the DB Instance is a master instance with read replicas Type: Integer BackupRetentionPeriod NoFor supported engines, indicates that the DB Instance should be associated with the specified CharacterSet. Type: String CharacterSetName YesThe compute and memory capacity of the DB Instance. Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge Note Amazon RDS does not support db.t1.micro instances in a virtual private cloud (VPC). Type: String DBInstanceClass YesThe DB Instance identifier.This parameter is stored as a lowercase string. Constraints: · Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server). · First character must be a letter. · Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance Type: String DBInstanceIdentifier API Version 2012-09-17 12 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoThe meaning of this parameter differs according to 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: · Must contain 1 to 64 alphanumeric characters · Cannot be a word reserved by the specified database engine Type: String Oracle The Oracle System ID (SID) of the created DB Instance. Default: ORCL Constraints: · Cannot be longer than 8 characters SQL Server Not applicable. Must be null. Type: String DBName NoThe name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBParameterGroupName NoA list of DB Security Groups to associate with this DB Instance. Default: The default DB Security Group for the database engine. Type: String list DBSecurityGroups.member.N API Version 2012-09-17 13 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoA DB Subnet Group to associate with this DB Instance. If there is no DB Subnet Group, then it is a non-VPC DB instance. Type: String DBSubnetGroupName YesThe name of the database engine to be used for this instance. Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web Type: String Engine NoThe version number of the database engine to use. MySQL Example: 5.1.42 Type: String Oracle Example: 11.2.0.2.v2 Type: String SQL Server Example: 10.50.2789.0.v1 Type: String EngineVersion NoThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance. Constraints: Must be an integer greater than 1000. Type: Integer Iops NoLicense model information for this DB Instance. Valid values: license-included | bring-your-own-license | general-public-license Type: String LicenseModel API Version 2012-09-17 14 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName YesThe password for the master database user. MySQL Constraints: Must contain from 8 to 41 alphanumeric characters. Type: String Oracle Constraints: Must contain from 8 to 30 alphanumeric characters. SQL Server Constraints: Must contain from 8 to 128 alphanumeric characters. Type: String MasterUserPassword YesThe name of master user for the client DB Instance. MySQL Constraints: · Must be 1 to 16 alphanumeric characters. · First character must be a letter. · Cannot be a reserved word for the chosen database engine. Type: String Oracle Constraints: · Must be 1 to 30 alphanumeric characters. · First character must be a letter. · Cannot be a reserved word for the chosen database engine. SQL Server Constraints: · Must be 1 to 128 alphanumeric characters. · First character must be a letter. · Cannot be a reserved word for the chosen database engine. Type: String MasterUsername API Version 2012-09-17 15 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoSpecifies if the DB Instance is a Multi-AZ deployment.You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Type: Boolean MultiAZ NoIndicates that the DB Instance should be associated with the specified option group. Type: String OptionGroupName NoThe port number on which the database accepts connections. MySQL Default: 3306 Valid Values: 1150-65535 Type: Integer Oracle Default: 1521 Valid Values: 1150-65535 SQL Server Default: 1433 Valid Values: 1150-65535 except for 1434 and 3389. Type: Integer Port API Version 2012-09-17 16 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoThe daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned. · US-East (Northern Virginia) Region: 03:00-11:00 UTC · US-West (Northern California) Region: 06:00-14:00 UTC · EU (Ireland) Region: 22:00-06:00 UTC · Asia Pacific (Singapore) Region: 14:00-22:00 UTC · Asia Pacific (Tokyo) Region: 17:00-03:00 UTC Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. Type: String PreferredBackupWindow NoThe weekly time range (in UTC) during which system maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned. · US-East (Northern Virginia) Region: 03:00-11:00 UTC · US-West (Northern California) Region: 06:00-14:00 UTC · EU (Ireland) Region: 22:00-06:00 UTC · Asia Pacific (Singapore) Region: 14:00-22:00 UTC · Asia Pacific (Tokyo) Region: 17:00-03:00 UTC Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. Type: String PreferredMaintenanceWindow API Version 2012-09-17 17 Amazon Relational Database Service API Reference Request Parameters Response Elements The following elements come wrapped in a DBInstance structure. DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName API Version 2012-09-17 18 Amazon Relational Database Service API Reference Response Elements DescriptionName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership API Version 2012-09-17 19 Amazon Relational Database Service API Reference Response Elements DescriptionName Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400User already has a DB Instance with the given identifier. DBInstanceAlreadyExists 404DBParameterGroupName does not refer to an existing DB Parameter Group. DBParameterGroupNotFound 404DBSecurityGroupName does not refer to an existing DB Security Group. DBSecurityGroupNotFound 400DBSubnetGroupName does not refer to an existing DB Subnet Group. DBSubnetGroupNotFound 400Request would result in user exceeding the allowed number of DB Instances. InstanceQuotaExceeded 400Specified DB Instance class is not available in the specified Availability Zone. InsufficientDBInstanceCapacity 400DB Subnet Group does not cover all availability zones after it is created because users© change. InvalidVPCNetworkState 400OptionGroupNotFound API Version 2012-09-17 20 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 400Provisioned IOPS not available in the specified Availability Zone. ProvisionedIopsNotAvailableInAZ 400Request would result in user exceeding the allowed amount of storage available across all DB Instances. StorageQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateDBInstance &DBInstanceIdentifier=SimCoProd01 &Engine=mysql &MasterUserPassword=Password01 &AllocatedStorage=10 &MasterUsername=master &Version=2012-09-17 &DBInstanceClass=db.m1.large &DBSubnetGroupName=dbSubnetgroup01 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-23T05%3A54%3A53.578Z &AWSAccessKeyId= &Signature= Sample Response mysql **** 1 false general-public-license 990524496922 Complete description subnet_grp1 Active subnet-7c5b4115 API Version 2012-09-17 21 Amazon Relational Database Service API Reference Examples us-east-1c Active subnet-7b5b4112 us-east-1b Active subnet-3ea6bd57 us-east-1d creating 5.1.50 simcoprod01 in-sync default.mysql5.1 active default 00:00-00:30 true sat:07:30-sat:08:00 10 db.m1.large master 2e5d4270-8501-11e0-bd9b-a7b1ece36d51 API Version 2012-09-17 22 Amazon Relational Database Service API Reference Examples CreateDBInstanceReadReplica Description Creates a DB Instance that acts as a Read Replica of a source DB Instance. All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except as specified below. Important The source DB Instance must have backup retention enabled. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoIndicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB Instance Type: Boolean AutoMinorVersionUpgrade NoThe Amazon EC2 Availability Zone that the Read Replica will be created in. Default: A random, system-chosen Availability Zone in the endpoint©s region. Example: us-east-1d Type: String AvailabilityZone NoThe compute and memory capacity of the Read Replica. Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge Default: Inherits from the source DB Instance. Type: String DBInstanceClass YesThe DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string. Type: String DBInstanceIdentifier NoThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance. Type: Integer Iops NoType: StringOptionGroupName API Version 2012-09-17 23 Amazon Relational Database Service API Reference CreateDBInstanceReadReplica RequiredDescriptionName NoThe port number that the DB Instance uses for connections. Default: Inherits from the source DB Instance Valid Values: 1150-65535 Type: Integer Port YesThe identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas. Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance. Type: String SourceDBInstanceIdentifier Response Elements The following elements come wrapped in a DBInstance structure. DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus API Version 2012-09-17 24 Amazon Relational Database Service API Reference Response Elements DescriptionName The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime API Version 2012-09-17 25 Amazon Relational Database Service API Reference Response Elements DescriptionName License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400User already has a DB Instance with the given identifier. DBInstanceAlreadyExists 404DBInstanceIdentifier does not refer to an existing DB Instance. DBInstanceNotFound API Version 2012-09-17 26 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 404DBParameterGroupName does not refer to an existing DB Parameter Group. DBParameterGroupNotFound 404DBSecurityGroupName does not refer to an existing DB Security Group. DBSecurityGroupNotFound 400DBSubnetGroupName does not refer to an existing DB Subnet Group. DBSubnetGroupNotFound 400Request would result in user exceeding the allowed number of DB Instances. InstanceQuotaExceeded 400Specified DB Instance class is not available in the specified Availability Zone. InsufficientDBInstanceCapacity 400The specified DB Instance is not in the available state. InvalidDBInstanceState 400DB Subnet Group does not cover all availability zones after it is created because users© change. InvalidVPCNetworkState 400OptionGroupNotFound 400Provisioned IOPS not available in the specified Availability Zone. ProvisionedIopsNotAvailableInAZ 400Request would result in user exceeding the allowed amount of storage available across all DB Instances. StorageQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateDBInstanceReadReplica &DBInstanceIdentifier=myreadreplica &SourceDBInstanceIdentifier=mydbinstance &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-15T23%3A35%3A07.325Z &AWSAccessKeyId= &Signature= Sample Response API Version 2012-09-17 27 Amazon Relational Database Service API Reference Examples mysql 0 false general-public-license creating 5.1.50 myreadreplica in-sync default.mysql5.1 mydbinstance active default 23:00-01:00 true sun:05:00-sun:09:00 10 db.m1.small master 3e24c5cd-c6e2-11df-8463-4f0c49644cb7 API Version 2012-09-17 28 Amazon Relational Database Service API Reference Examples CreateDBParameterGroup Description 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 for the new DB Parameter Group and associated settings to take effect. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe DB Parameter Group Family name. A DB Parameter Group can be associated with one and only one DB Parameter Group Family, and can be applied only to a DB Instance running a database engine and engine version compatible with that DB Parameter Group Family. Type: String DBParameterGroupFamily YesThe name of the DB Parameter Group. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Note This value is stored as a lower-case string. Type: String DBParameterGroupName YesThe description for the DB Parameter Group. Type: String Description Response Elements The following elements come wrapped in a DBParameterGroup structure. DescriptionName Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with. Type: String DBParameterGroupFamily API Version 2012-09-17 29 Amazon Relational Database Service API Reference CreateDBParameterGroup DescriptionName Provides the name of the DB Parameter Group. Type: String DBParameterGroupName Provides the customer-specified description for this DB Parameter Group. Type: String Description Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400A DB Parameter Group with the same name exists.DBParameterGroupAlreadyExists 400Request would result in user exceeding the allowed number of DB Parameter Groups. DBParameterGroupQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateDBParameterGroup &DBParameterGroupName=mydbparametergroup3 &DBParameterGroupFamily=MySQL5.1 &Version=2012-09-17 &Description=My%20new%20DBParameterGroup &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-11T18%3A09%3A29.793Z &AWSAccessKeyId= &Signature= Sample Response mysql5.1 My new DBParameterGroup mydbparametergroup3 0b447b66-bf36-11de-a88b-7b5b3d23b3a7 API Version 2012-09-17 30 Amazon Relational Database Service API Reference Errors API Version 2012-09-17 31 Amazon Relational Database Service API Reference Examples CreateDBSecurityGroup Description Creates a new DB Security Group. DB Security Groups control access to a DB Instance. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe description for the DB Security Group. Type: String DBSecurityGroupDescription YesThe name for the DB Security Group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Example: mysecuritygroup Type: String DBSecurityGroupName NoThe Id of VPC. Indicates which VPC this DB Security Group should belong to. Must be specified to create a DB Security Group for a VPC; may not be specified otherwise. Type: String EC2VpcId 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. 173) elements. Type: EC2SecurityGroup (p. 173) list EC2SecurityGroups Contains a list of IPRange (p. 175) elements. Type: IPRange (p. 175) list IPRanges Provides the AWS ID of the owner of a specific DB Security Group. Type: String OwnerId Provides the VpcId of the DB Security Group. Type: String VpcId API Version 2012-09-17 32 Amazon Relational Database Service API Reference CreateDBSecurityGroup Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400A database security group with the name specified in DBSecurityGroupName already exists. DBSecurityGroupAlreadyExists 400Request would result in user exceeding the allowed number of DB Security Groups. DBSecurityGroupQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateDBSecurityGroup &DBSecurityGroupName=mydbsecuritygroup &DBSecurityGroupDescription=My%20new%20DBSecurityGroup &EC2VpcId=vpc-1a2b3c4d &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T18%3A14%3A49.482Z &AWSAccessKeyId= &Signature= Sample Response My new DBSecurityGroup 565419523791 mydbsecuritygroup vpc-1a2b3c4d ed662948-a57b-11df-9e38-7ffab86c801f API Version 2012-09-17 33 Amazon Relational Database Service API Reference Errors CreateDBSnapshot Description Creates a DBSnapshot. The source DBInstance must be in "available" state. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe DB Instance identifier. This is the unique key that identifies a DB Instance.This parameter isn©t case sensitive. Constraints: · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBInstanceIdentifier YesThe identifier for the DB Snapshot. Constraints: · Cannot be null, empty, or blank · Must contain from 1 to 255 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id Type: String DBSnapshotIdentifier Response Elements The following elements come wrapped in a DBSnapshot structure. DescriptionName Specifies the allocated storage size in gigabytes (GB). Type: Integer AllocatedStorage Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot. Type: String AvailabilityZone API Version 2012-09-17 34 Amazon Relational Database Service API Reference CreateDBSnapshot DescriptionName Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from. Type: String DBInstanceIdentifier Specifies the identifier for the DB Snapshot. Type: String DBSnapshotIdentifier Specifies the name of the database engine. Type: String Engine Specifies the version of the database engine. Type: String EngineVersion Specifies the time (UTC) when the snapshot was taken. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot. Type: Integer Iops License model information for the restored DB Instance. Type: String LicenseModel Provides the master username for the DB Instance. Type: String MasterUsername Specifies the port that the database engine was listening on at the time of the snapshot. Type: Integer Port Provides the time (UTC) when the snapshot was taken. Type: DateTime SnapshotCreateTime Provides the type of the DB Snapshot. Type: String SnapshotType Specifies the status of this DB Snapshot. Type: String Status Provides the Vpc Id associated with the DB Snapshot. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance. DBInstanceNotFound API Version 2012-09-17 35 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 400DBSnapshotIdentifier is already used by an existing snapshot. DBSnapshotAlreadyExists 400The specified DB Instance is not in the available state.InvalidDBInstanceState 400Request would result in user exceeding the allowed number of DB Snapshots. SnapshotQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateDBSnapshot &DBInstanceIdentifier=simcoprod01 &DBSnapshotIdentifier=mydbsnapshot &Version=2012-09-17 &SignatureVersion=2&SignatureMethod=HmacSHA256 &Timestamp=2011-05-23T06%3A27%3A42.551Z &AWSAccessKeyId= &Signature= Sample Response 3306 mysql creating us-east-1a general-public-license 2011-05-23T06:06:43.110Z 10 simcoprod01 5.1.50 mydbsnapshot manual master c4181d1d-8505-11e0-90aa-eb648410240d API Version 2012-09-17 36 Amazon Relational Database Service API Reference Examples CreateDBSubnetGroup Description Creates a new DB subnet group. DB subnet groups must contain at least one subnet in each AZ in the region. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe description for the DB Subnet Group. Type: String DBSubnetGroupDescription YesThe name for the DB Subnet Group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Example: mySubnetgroup Type: String DBSubnetGroupName YesThe EC2 Subnet IDs for the DB Subnet Group. Type: String list SubnetIds.member.N Response Elements The following elements come wrapped in a DBSubnetGroup structure. DescriptionName Provides the description of the DB Subnet Group. Type: String DBSubnetGroupDescription Specifies the name of the DB Subnet Group. Type: String DBSubnetGroupName Provides the status of the DB Subnet Group. Type: String SubnetGroupStatus Contains a list of Subnet (p. 183) elements. Type: Subnet (p. 183) list Subnets Provides the VpcId of the DB Subnet Group. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). API Version 2012-09-17 37 Amazon Relational Database Service API Reference CreateDBSubnetGroup HTTP Status Code DescriptionError 400DBSubnetGroupName is already used by an existing DBSubnetGroup. DBSubnetGroupAlreadyExists 400Subnets in the DB subnet group should cover all availability zones. DBSubnetGroupListDoesNotCoverAllAz 400Request would result in user exceeding the allowed number of DB Subnet Groups. DBSubnetGroupQuotaExceeded 400Request would result in user exceeding the allowed number of subnets in a DB subnet Groups. DBSubnetQuotaExceeded 400Request subnet is valid, or all subnets are not in common Vpc. InvalidSubnet Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateDBSubnetGroup &DBSubnetGroupName=mydbsubnetgroup &DBSubnetGroupDescription=My%20new%20DBSubnetGroup &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T18%3A14%3A49.482Z &AWSAccessKeyId= &Signature= Sample Response 990524496922 Complete My new DBSubnetGroup mydbsubnetgroup Active subnet-7c5b4115 us-east-1c API Version 2012-09-17 38 Amazon Relational Database Service API Reference Examples Active subnet-7b5b4112 us-east-1b Active subnet-3ea6bd57 us-east-1d ed662948-a57b-11df-9e38-7ffab86c801f API Version 2012-09-17 39 Amazon Relational Database Service API Reference Examples CreateOptionGroup Description Creates a new Option Group. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesSpecifies the name of the engine that this option group should be associated with. Type: String EngineName YesSpecifies the major version of the engine that this option group should be associated with. Type: String MajorEngineVersion YesThe description of the option group. Type: String OptionGroupDescription YesSpecifies the name of the option group to be created. Constraints: · Must be 1 to 255 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Example: myOptiongroup Type: String OptionGroupName Response Elements The following elements come wrapped in a OptionGroup structure. DescriptionName Indicates whether this option group can be applied to both VPC and non-VPC instances. Type: Boolean AllowsVpcAndNonVpcInstanceMemberships Engine name that this option group can be applied to. Type: String EngineName Indicates the major engine version associated with this option group. Type: String MajorEngineVersion API Version 2012-09-17 40 Amazon Relational Database Service API Reference CreateOptionGroup DescriptionName Type: StringOptionGroupDescription Specifies the name of the option group. Type: String OptionGroupName Type: Option (p. 176) listOptions If AllowsVpcAndNonVpcInstanceMemberships is ©false©, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is ©true© and this field is blank, then this option group can only be applied to non-VPC instances. Otherwise, this option group can only be applied to instances that are in the VPC indicated by this field. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400OptionGroupAlreadyExists 400OptionGroupQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=CreateOptionGroup &OptionGroupName=myoptiongroup &EngineName=oracle-se1 &MajorEngineVersion=11.2 &OptionGroupDescription=Test Option Group Sample Response 11.2 myoptiongroup oracle-se1 Test Option Group API Version 2012-09-17 41 Amazon Relational Database Service API Reference Errors b2416a8a-84c9-11e1-a264-0b23c28bc344 API Version 2012-09-17 42 Amazon Relational Database Service API Reference Examples DeleteDBInstance Description The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the request was received correctly. If a final DBSnapshot is requested the status of the RDS instance will be "deleting" until the DBSnapshot is created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe DB Instance identifier for the DB Instance to be deleted. This parameter isn©t case sensitive. Constraints: · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBInstanceIdentifier NoThe DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false. Note Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String FinalDBSnapshotIdentifier API Version 2012-09-17 43 Amazon Relational Database Service API Reference DeleteDBInstance RequiredDescriptionName NoDetermines whether a final DB Snapshot is created before the DB Instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB Snapshot is created before the DB Instance is deleted. Note The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false. Default: false Type: Boolean SkipFinalSnapshot Response Elements The following elements come wrapped in a DBInstance structure. DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus API Version 2012-09-17 44 Amazon Relational Database Service API Reference Response Elements DescriptionName The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime API Version 2012-09-17 45 Amazon Relational Database Service API Reference Response Elements DescriptionName License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance. DBInstanceNotFound 400DBSnapshotIdentifier is already used by an existing snapshot. DBSnapshotAlreadyExists 400The specified DB Instance is not in the available state.InvalidDBInstanceState API Version 2012-09-17 46 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 400Request would result in user exceeding the allowed number of DB Snapshots. SnapshotQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=DeleteDBInstance &DBInstanceIdentifier=myrestoreddbinstance &SkipFinalSnapshot=true &Version=2012-09-17 &Timestamp=2011-05-23T07%3A19%3A35.947Z &SignatureVersion=2 &SignatureMethod=HmacSHA256 &AWSAccessKeyId= &Signature= Sample Response 2011-05-23T07:15:00Z mysql 1 false general-public-license deleting 5.1.50 3306
myrestoreddbinstance.cu7u2t4uz396.us-east.rds.amazonaws.com myrestoreddbinstance in-sync default.mysql5.1 active default API Version 2012-09-17 47 Amazon Relational Database Service API Reference Examples 00:00-00:30 true sat:07:30-sat:08:00 us-east-1d 2011-05-23T06:52:48.255Z 10 db.m1.large master 03ea4ae8-850d-11e0-90aa-eb648410240d API Version 2012-09-17 48 Amazon Relational Database Service API Reference Examples DeleteDBParameterGroup Description Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted. Note The specified DB Parameter Group cannot be associated with any DB Instances. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe name of the DB Parameter Group. Constraints: · Must be the name of an existing DB Parameter Group · You cannot delete a default DB Parameter Group · Cannot be associated with any DB Instances Type: String DBParameterGroupName Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBParameterGroupName does not refer to an existing DB Parameter Group. DBParameterGroupNotFound 400The DB Parameter Group cannot be deleted because it is in use. InvalidDBParameterGroupState Examples Sample Request https://rds.amazonaws.com/ ?Action=DeleteDBParameterGroup &DBParameterGroupName=mydbparametergroup &Version=2012-09-17 &SignatureVersion=2&SignatureMethod=HmacSHA256 &Timestamp=2011-05-11T18%3A47%3A08.851Z API Version 2012-09-17 49 Amazon Relational Database Service API Reference DeleteDBParameterGroup &AWSAccessKeyId= &Signature= Sample Response 4dc38be9-bf3b-11de-a88b-7b5b3d23b3a7 API Version 2012-09-17 50 Amazon Relational Database Service API Reference Examples DeleteDBSecurityGroup Description Deletes a DB Security Group. Note The specified DB Security Group must not be associated with any DB Instances. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe name of the DB Security Group to delete. Note You cannot delete the default DB Security Group. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBSecurityGroupName Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 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/ ?Action=DeleteDBSecurityGroup API Version 2012-09-17 51 Amazon Relational Database Service API Reference DeleteDBSecurityGroup &DBSecurityGroupName=mysecuritygroup &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T17%3A48%3A21.746Z &AWSAccessKeyId= &Signature= Sample Response 5d013245-4172-11df-8520-e7e1e602a915 API Version 2012-09-17 52 Amazon Relational Database Service API Reference Examples DeleteDBSnapshot Description Deletes a DBSnapshot. Note The DBSnapshot must be in the available state to be deleted. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe DBSnapshot identifier. Constraints: Must be the name of an existing DB Snapshot in the available state. Type: String DBSnapshotIdentifier Response Elements The following elements come wrapped in a DBSnapshot structure. DescriptionName Specifies the allocated storage size in gigabytes (GB). Type: Integer AllocatedStorage Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot. Type: String AvailabilityZone Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from. Type: String DBInstanceIdentifier Specifies the identifier for the DB Snapshot. Type: String DBSnapshotIdentifier Specifies the name of the database engine. Type: String Engine Specifies the version of the database engine. Type: String EngineVersion Specifies the time (UTC) when the snapshot was taken. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot. Type: Integer Iops API Version 2012-09-17 53 Amazon Relational Database Service API Reference DeleteDBSnapshot DescriptionName License model information for the restored DB Instance. Type: String LicenseModel Provides the master username for the DB Instance. Type: String MasterUsername Specifies the port that the database engine was listening on at the time of the snapshot. Type: Integer Port Provides the time (UTC) when the snapshot was taken. Type: DateTime SnapshotCreateTime Provides the type of the DB Snapshot. Type: String SnapshotType Specifies the status of this DB Snapshot. Type: String Status Provides the Vpc Id associated with the DB Snapshot. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBSnapshotIdentifier does not refer to an existing DB Snapshot. DBSnapshotNotFound 400The state of the DB Security Snapshot does not allow deletion.InvalidDBSnapshotState Examples Sample Request https://rds.amazon.com/ &DBSnapshotIdentifier=mydbsnapshot &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-23T06%3A27%3A42.551Z &AWSAccessKeyId= &Signature= API Version 2012-09-17 54 Amazon Relational Database Service API Reference Errors Sample Response 3306 2011-03-11T07:20:24.082Z mysql deleted us-east-1d general-public-license 2010-07-16T00:06:59.107Z 60 simcoprod01 5.1.47 mysnapshot2 manual master 627a43a1-8507-11e0-bd9b-a7b1ece36d51 API Version 2012-09-17 55 Amazon Relational Database Service API Reference Examples DeleteDBSubnetGroup Description Deletes a DB subnet group. Note The specified database subnet group must not be associated with any DB instances. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe name of the database subnet group to delete. Note You cannot delete the default subnet group. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBSubnetGroupName Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400DBSubnetGroupName does not refer to an existing DB Subnet Group. DBSubnetGroupNotFound 400The DB Subnet Group cannot be deleted because it is in use. InvalidDBSubnetGroupState 400InvalidDBSubnetState API Version 2012-09-17 56 Amazon Relational Database Service API Reference DeleteDBSubnetGroup Examples Sample Request https://rds.amazonaws.com/ ?Action=DeleteDBSubnetGroup &DBSubnetGroupName=mysubnetgroup &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T17%3A48%3A21.746Z &AWSAccessKeyId= &Signature= Sample Response 5d013245-4172-11df-8520-e7e1e602a915 API Version 2012-09-17 57 Amazon Relational Database Service API Reference Examples DeleteOptionGroup Description Deletes an existing Option Group. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe name of the option group to be deleted. Note You cannot delete default Option Groups. Type: String OptionGroupName Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400InvalidOptionGroupState 400OptionGroupNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=DeleteOptionGroup &OptionGroupName=myoptiongroup Sample Response API Version 2012-09-17 58 Amazon Relational Database Service API Reference DeleteOptionGroup DescribeDBEngineVersions Description Returns a list of the available DB engines. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe name of a specific DB Parameter Group family to return details for. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBParameterGroupFamily NoIndicates that only the default version of the specified engine or engine and major version combination is returned. Type: Boolean DefaultOnly NoThe database engine to return. Type: String Engine NoThe database engine version to return. Example: 5.1.49 Type: String EngineVersion NoIf this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version. Type: Boolean ListSupportedCharacterSets NoThe marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords. Type: String Marker API Version 2012-09-17 59 Amazon Relational Database Service API Reference DescribeDBEngineVersions RequiredDescriptionName NoThe maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords Response Elements The following elements come wrapped in a DescribeDBEngineVersionsResult structure. DescriptionName A list of DBEngineVersion elements. Type: DBEngineVersion (p. 160) list DBEngineVersions The identifier returned to allow retrieval of paginated results. Type: String Marker Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeDBEngineVersions &MaxRecords=100 &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-23T07%3A34%3A17.435Z &AWSAccessKeyId= &Signature= Sample Response mysql5.1 mysql 5.1.42 mysql5.1 mysql API Version 2012-09-17 60 Amazon Relational Database Service API Reference Response Elements Use instead of mysql5.1 5.1.45 yaSSL Security Fixes mysql5.1 mysql Use instead of mysql5.1 5.1.47 MySQL 5.1.47.R1 with InnoDB Plugin 1.0.8 mysql5.1 mysql Use instead of mysql5.1 5.1.48 MySQL 5.1.47.R1 with InnoDB Plugin 1.0.8 mysql5.1 mysql Use instead of mysql5.1 5.1.49 MySQL 5.1.49-R1 with innodb plugin mysql5.1 mysql Use instead of mysql5.1 5.1.50 MySQL 5.1.50-R3 mysql5.5 mysql Use instead of mysql5.1 5.5.7 MySQL 5.5.7.R1 oracle-ee-11.2 oracle-ee Oracle Database Server EE 11.2.0.2 Oracle EE release AL32UTF8 Unicode 5.0 UTF-8 Universal character set API Version 2012-09-17 61 Amazon Relational Database Service API Reference Examples oracle-ee-11.2 oracle-ee Oracle Database Server EE 11.2.0.2.v2 First Oracle Enterprise Edition One - DB Engine Version 11.2.0.2.v2 AL32UTF8 Unicode 5.0 UTF-8 Universal character set oracle-ee-11.2 oracle-ee Oracle Database Server EE 11.2.0.2.v3 Oracle EE release AL32UTF8 Unicode 5.0 UTF-8 Universal character set oracle-se-11.2 oracle-se Oracle Database Server SE 11.2.0.2 Oracle SE release AL32UTF8 Unicode 5.0 UTF-8 Universal character set oracle-se-11.2 oracle-se Oracle Database Server SE 11.2.0.2.v2 Oracle SE release AL32UTF8 Unicode 5.0 UTF-8 Universal character set oracle-se-11.2 oracle-se Oracle Database Server SE 11.2.0.2.v3 Oracle SE release AL32UTF8 Unicode 5.0 UTF-8 Universal character set oracle-se1-11.2 oracle-se1 Oracle Database Server SE1 11.2.0.2 Oracle SE1 release AL32UTF8 Unicode 5.0 UTF-8 Universal character set oracle-se1-11.2 oracle-se1 Oracle Database Server SE1 11.2.0.2.v2 Oracle SE1 release AL32UTF8 Unicode 5.0 UTF-8 Universal character set oracle-se1-11.2 oracle-se1 Oracle Database Server SE1 11.2.0.2.v3 Oracle SE1 release AL32UTF8 Unicode 5.0 UTF-8 Universal character set 1162dc55-850f-11e0-90aa-eb648410240d API Version 2012-09-17 63 Amazon Relational Database Service API Reference Examples DescribeDBInstances Description Returns information about provisioned RDS instances. This API supports pagination. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe user-supplied instance identifier. If this parameter is specified, information from only the specific DB Instance is returned. This parameter isn©t case sensitive. Constraints: · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBInstanceIdentifier NoAn optional marker provided in the previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . Type: String Marker NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords Response Elements The following elements come wrapped in a DescribeDBInstancesResult structure. DescriptionName A list of DBInstance (p. 161) instances. Type: DBInstance (p. 161) list DBInstances The marker obtained from a previous operation response. Type: String Marker API Version 2012-09-17 64 Amazon Relational Database Service API Reference DescribeDBInstances Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance.DBInstanceNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeDBInstances &Version=2012-09-17 &MaxRecords=100 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-23T06%3A54%3A55.116Z &AWSAccessKeyId=< Your AWS Access ID Key > &Signature= < Your Signature > Sample Response 2011-05-23T06:50:00Z mysql 1 false general-public-license available 5.1.50 3306
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
simcoprod01 in-sync default.mysql5.1 API Version 2012-09-17 65 Amazon Relational Database Service API Reference Errors active default 00:00-00:30 true sat:07:30-sat:08:00 us-east-1a 2011-05-23T06:06:43.110Z 10 db.m1.large master
9135fff3-8509-11e0-bd9b-a7b1ece36d51
API Version 2012-09-17 66 Amazon Relational Database Service API Reference Examples DescribeDBParameterGroups Description Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe name of a specific DB Parameter Group to return details for. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBParameterGroupName NoAn optional marker provided in the previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Marker NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords Response Elements The following elements come wrapped in a DescribeDBParameterGroupsResult structure. DescriptionName A list of DBParameterGroup (p. 163) instances. Type: DBParameterGroup (p. 163) list DBParameterGroups The marker obtained from a previous operation response. Type: String Marker API Version 2012-09-17 67 Amazon Relational Database Service API Reference DescribeDBParameterGroups Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBParameterGroupName does not refer to an existing DB Parameter Group. DBParameterGroupNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeDBParameterGroups &DBParameterGroupName=myparamsgroup &MaxRecords=100 &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T17%3A54%3A32.899Z &AWSAccessKeyId= &Signature= Sample Response mysql5.1 Default parameter group for mysql5.1 default.mysql5.1 mysql5.1 My DB Param Group testdbparamgroup cb8d9bb4-a02a-11df-bd60-c955b7d6e8e0 API Version 2012-09-17 68 Amazon Relational Database Service API Reference Errors DescribeDBParameters Description Returns the detailed parameter list for a particular DBParameterGroup. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe name of a specific DB Parameter Group to return details for. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBParameterGroupName NoAn optional marker provided in the previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Marker NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords NoThe parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default Type: String Source Response Elements The following elements come wrapped in a DescribeDBParametersResult structure. API Version 2012-09-17 69 Amazon Relational Database Service API Reference DescribeDBParameters DescriptionName The marker obtained from a previous operation response. Type: String Marker A list of Parameter (p. 179) instances. Type: Parameter (p. 179) list Parameters Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBParameterGroupName does not refer to an existing DB Parameter Group. DBParameterGroupNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeDBParameters &DBParameterGroupName=mydbparametergroup &Source=system &MaxRecords=100 &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-11T19%3A31%3A42.262Z &AWSAccessKeyId= &Signature= Sample Response /rdsdbbin/mysql string system false The MySQL installation base directory. static basedir 32768 API Version 2012-09-17 70 Amazon Relational Database Service API Reference Errors integer system true The size of the cache to hold the SQL statements for the binary log during a transaction. dynamic 4096-9223372036854775807 binlog_cache_size 8743f2cf-bf41-11de-8c8e-49155882c409 API Version 2012-09-17 71 Amazon Relational Database Service API Reference Examples DescribeDBSecurityGroups Description Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup. 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.185). RequiredDescriptionName NoThe name of the DB Security Group to return details for. Type: String DBSecurityGroupName NoAn optional marker provided in the previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Marker NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords Response Elements The following elements come wrapped in a DescribeDBSecurityGroupsResult structure. DescriptionName A list of DBSecurityGroup (p. 165) instances. Type: DBSecurityGroup (p. 165) list DBSecurityGroups The marker obtained from a previous operation response. Type: String Marker Errors For information about the common errors that all actions use, see Common Errors (p. 187). API Version 2012-09-17 72 Amazon Relational Database Service API Reference DescribeDBSecurityGroups HTTP Status Code DescriptionError 404DBSecurityGroupName does not refer to an existing DB Security Group. DBSecurityGroupNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeDBSecurityGroups &Version=2012-09-17 &MaxRecords=100 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T19%3A40%3A19.926Z &AWSAccessKeyId= &Signature= Sample Response authorized myec2securitygroup 054794666394 default 127.0.0.1/30 authorized 621567473609 default vpc-1ab2c3d4 My new DBSecurityGroup 192.168.1.1/24 API Version 2012-09-17 73 Amazon Relational Database Service API Reference Examples authorized 621567473609 mydbsecuritygroup vpc-1ab2c3d5 My new DBSecurityGroup 621567473609 mydbsecuritygroup4 vpc-1ab2c3d6 bbdad154-bf42-11de-86a4-97241dfaadff API Version 2012-09-17 74 Amazon Relational Database Service API Reference Examples DescribeDBSnapshots Description Returns information about DBSnapshots. This API supports pagination. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoA DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn©t case sensitive. Constraints: · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBInstanceIdentifier NoA specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens · If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified. Type: String DBSnapshotIdentifier NoAn optional marker provided in the previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Marker API Version 2012-09-17 75 Amazon Relational Database Service API Reference DescribeDBSnapshots RequiredDescriptionName NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords NoAn optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types. Type: String SnapshotType Response Elements The following elements come wrapped in a DescribeDBSnapshotsResult structure. DescriptionName A list of DBSnapshot (p. 166) instances. Type: DBSnapshot (p. 166) list DBSnapshots The marker obtained from a previous operation response. Type: String Marker Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBSnapshotIdentifier does not refer to an existing DB Snapshot.DBSnapshotNotFound Examples Sample Request https://rds.amazon.com/ ?Action=DescribeDBSnapshots &MaxRecords=100 &Version=2012-09-17 &Timestamp=2011-05-23T06%3A27%3A42.551Z &SignatureVersion=2 &SignatureMethod=HmacSHA256 &AWSAccessKeyId= &Signature= API Version 2012-09-17 76 Amazon Relational Database Service API Reference Response Elements Sample Response 3306 2011-05-23T06:29:03.483Z mysql available us-east-1a general-public-license 2011-05-23T06:06:43.110Z 10 simcoprod01 5.1.50 mydbsnapshot manual master 3306 2011-03-11T07:20:24.082Z mysql available us-east-1a general-public-license 2010-08-04T23:27:36.420Z 50 mydbinstance 5.1.49 mysnapshot1 manual sa 3306 2012-04-02T00:01:24.082Z mysql available us-east-1d general-public-license 2010-07-16T00:06:59.107Z 60 simcoprod01 5.1.47 rds:simcoprod01-2012-04-02-00-01 automated master c4191173-8506-11e0-90aa-eb648410240d API Version 2012-09-17 77 Amazon Relational Database Service API Reference Examples API Version 2012-09-17 78 Amazon Relational Database Service API Reference Examples DescribeDBSubnetGroups Description 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 Wikipedia Tutorial. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe name of the DB Subnet Group to return details for. Type: String DBSubnetGroupName NoAn optional marker provided in the previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Marker NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords Response Elements The following elements come wrapped in a DescribeDBSubnetGroupsResult structure. DescriptionName A list of DBSubnetGroup (p. 167) instances. Type: DBSubnetGroup (p. 167) list DBSubnetGroups The marker obtained from a previous operation response. Type: String Marker Errors For information about the common errors that all actions use, see Common Errors (p. 187). API Version 2012-09-17 79 Amazon Relational Database Service API Reference DescribeDBSubnetGroups HTTP Status Code DescriptionError 400DBSubnetGroupName does not refer to an existing DB Subnet Group. DBSubnetGroupNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeDBSubnetGroups &Version=2012-09-17 &MaxRecords=100 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T19%3A40%3A19.926Z &AWSAccessKeyId= &Signature= Sample Response 990524496922 Complete description subnet_grp1 Active subnet-7c5b4115 us-east-1c Active subnet-7b5b4112 us-east-1b Active subnet-3ea6bd57 API Version 2012-09-17 80 Amazon Relational Database Service API Reference Examples us-east-1d 990524496922 Complete description subnet_grp2 Active subnet-7c5b4115 us-east-1c Active subnet-7b5b4112 us-east-1b Active subnet-3ea6bd57 us-east-1d 31d0faee-229b-11e1-81f1-df3a2a803dad API Version 2012-09-17 81 Amazon Relational Database Service API Reference Examples DescribeEngineDefaultParameters Description Returns the default engine and system parameter information for the specified database engine. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe name of the DB Parameter Group Family. Type: String DBParameterGroupFamily NoAn optional marker provided in the previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Marker NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords Response Elements The following elements come wrapped in a EngineDefaults structure. DescriptionName Specifies the name of the DB Parameter Group Family which the engine default parameters apply to. Type: String DBParameterGroupFamily Provides an identifier to allow retrieval of paginated results. Type: String Marker Contains a list of engine default parameters. Type: Parameter (p. 179) list Parameters API Version 2012-09-17 82 Amazon Relational Database Service API Reference DescribeEngineDefaultParameters Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeEngineDefaultParameters &DBParameterGroupFamily=mysql5.1 &Version=2012-09-17 &MaxRecords=100 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T19%3A10%3A03.510Z &AWSAccessKeyId= &Signature= Sample Response bG93ZXJfY2FzZV90YWJsZV9uYW1lcw== mysql5.1 boolean engine-default false Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded static 0,1 allow-suspicious-udfs integer engine-default true Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns dynamic 1-65535 auto_increment_increment integer engine-default true Determines the starting point for the AUTO_INCREMENT column value dynamic 1-65535 auto_increment_offset API Version 2012-09-17 83 Amazon Relational Database Service API Reference Examples 6c1341eb-a124-11df-bf5c-973b09643c5d API Version 2012-09-17 84 Amazon Relational Database Service API Reference Examples DescribeEvents Description Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days. Events specific to a particular DB Instance, DB Security Group, database snapshot or DB Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe number of minutes to retrieve events for. Default: 60 Type: Integer Duration NoThe end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z Type: DateTime EndTime NoAn optional marker provided in the previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Marker NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords API Version 2012-09-17 85 Amazon Relational Database Service API Reference DescribeEvents RequiredDescriptionName NoThe identifier of the event source for which events will be returned. If not specified, then all sources are included in the response. Constraints: · If SourceIdentifier is supplied, SourceType must also be provided. · If the source type is DBInstance, then a DBInstanceIdentifier must be supplied. · If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied. · If the source type is DBParameterGroup, a DBParameterGroupName must be supplied. · If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied. · Cannot end with a hyphen or contain two consecutive hyphens. Type: String SourceIdentifier NoThe event source to retrieve events for. If no value is specified, all events are returned. Type: String Valid Values: db-instance | db-parameter-group | db-security-group | db-snapshot SourceType NoThe beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z Type: DateTime StartTime Response Elements The following elements come wrapped in a DescribeEventsResult structure. DescriptionName A list of Event (p. 174) instances. Type: Event (p. 174) list Events The marker obtained from a previous operation response. Type: String Marker API Version 2012-09-17 86 Amazon Relational Database Service API Reference Response Elements Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeEvents &Duration=1440 &MaxRecords=100 &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T20%3A00%3A44.420Z &AWSAccessKeyId= &Signature= Sample Response Applied change to security group db-security-group 2010-08-11T17:12:52.860Z mydbsecuritygroup Database instance created db-instance 2010-08-11T18:10:15.269Z mydbinstance3 Backing up database instance db-instance 2010-08-11T18:10:34.690Z mydbinstance3 Backing up DB Instance db-instance 2010-08-11T18:25:52.263Z mynewdbinstance Creating user snapshot db-snapshot 2010-08-11T18:25:52.263Z mynewdbsnapshot3 95b948cd-bf45-11de-86a4-97241dfaadff API Version 2012-09-17 87 Amazon Relational Database Service API Reference Examples API Version 2012-09-17 88 Amazon Relational Database Service API Reference Examples DescribeOptionGroupOptions Description Describes all available options. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesA required parameter. Options available for the given Engine name will be described. Type: String EngineName NoIf specified, filters the results to include only options for the specified major engine version. Type: String MajorEngineVersion NoType: StringMarker NoType: IntegerMaxRecords Response Elements The following elements come wrapped in a DescribeOptionGroupOptionsResult structure. DescriptionName Type: StringMarker List of available options. Type: OptionGroupOption (p. 177) list OptionGroupOptions Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeOptionGroupOptions &EngineName=oracle-se1 &MajorEngineVersion=11.2 Sample Response API Version 2012-09-17 89 Amazon Relational Database Service API Reference DescribeOptionGroupOptions 11.2 true Oracle Enterprise Manager 1158 OEM oracle-se1 0.2.v3 d9c8f6a1-84c7-11e1-a264-0b23c28bc344 API Version 2012-09-17 90 Amazon Relational Database Service API Reference Examples DescribeOptionGroups Description Describes the available option groups. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoFilters the list of option groups to only include groups associated with a specific database engine. Type: String EngineName NoFilters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified. Type: String MajorEngineVersion NoType: StringMarker NoType: IntegerMaxRecords NoThe name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion. Type: String OptionGroupName Response Elements The following elements come wrapped in a DescribeOptionGroupsResult structure. DescriptionName Type: StringMarker List of option groups. Type: OptionGroup (p. 176) list OptionGroupsList Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400OptionGroupNotFound API Version 2012-09-17 91 Amazon Relational Database Service API Reference DescribeOptionGroups Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeOptionGroups &OptionGroupName=myoptiongroup &MaxRecords=100 https://rds.amazonaws.com/ ?Action=DescribeOptionGroups &MaxRecords=100 Sample Response 11.2 myoptiongroup oracle-se1 Test option group 6088823d-84c8-11e1-a264-0b23c28bc344 11.2 myoptiongroup oracle-se1 Test option group 11.2 default:oracle-se1-11-2 oracle-se1 Default Option Group. API Version 2012-09-17 92 Amazon Relational Database Service API Reference Examples e4b234d9-84d5-11e1-87a6-71059839a52b API Version 2012-09-17 93 Amazon Relational Database Service API Reference Examples DescribeOrderableDBInstanceOptions Description Returns a list of orderable DB Instance options for the specified engine. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class. Type: String DBInstanceClass YesThe name of the engine to retrieve DB Instance options for. Type: String Engine NoThe engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. Type: String EngineVersion NoThe license model filter value. Specify this parameter to show only the available offerings matching the specified license model. Type: String LicenseModel NoAn optional marker provided in the previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . Type: String Marker NoThe maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords NoThe VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings. Type: Boolean Vpc Response Elements The following elements come wrapped in a DescribeOrderableDBInstanceOptionsResult structure. API Version 2012-09-17 94 Amazon Relational Database Service API Reference DescribeOrderableDBInstanceOptions DescriptionName A marker that can be used to retrieve paginated results. Type: String Marker An OrderableDBInstanceOption (p. 178) structure containing information about orderable options for the DB Instance. Type: OrderableDBInstanceOption (p. 178) list OrderableDBInstanceOptions Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeOrderableDBInstanceOptions &Engine=mysql &MaxRecords=100 &Version=2012-09-17 &Timestamp=2011-05-23T07%3A49%3A17.749Z &SignatureVersion=2 &SignatureMethod=HmacSHA256 &AWSAccessKeyId= &Signature= Sample Response true mysql general-public-license true 5.1.45 db.m1.large us-east-1a yes us-east-1b no us-east-1d yes API Version 2012-09-17 95 Amazon Relational Database Service API Reference Examples true mysql general-public-license true 5.1.45 db.m1.small us-east-1a yes us-east-1b yes us-east-1d yes true mysql general-public-license true 5.1.45 db.m1.xlarge us-east-1a yes us-east-1b yes us-east-1d yes true mysql general-public-license true 5.1.45 db.m2.2xlarge us-east-1a yes us-east-1b API Version 2012-09-17 96 Amazon Relational Database Service API Reference Examples yes us-east-1d yes true mysql general-public-license true 5.1.45 db.m2.4xlarge us-east-1a yes us-east-1b no us-east-1d no 2a0406d7-8511-11e0-90aa-eb648410240d API Version 2012-09-17 97 Amazon Relational Database Service API Reference Examples DescribeReservedDBInstances Description Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class. Type: String DBInstanceClass NoThe duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000 Type: String Duration NoThe marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords. Type: String Marker NoThe maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords NoThe Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter. Type: Boolean MultiAZ NoThe offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization" Type: String OfferingType API Version 2012-09-17 98 Amazon Relational Database Service API Reference DescribeReservedDBInstances RequiredDescriptionName NoThe product description filter value. Specify this parameter to show only those reservations matching the specified product description. Type: String ProductDescription NoThe reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. Type: String ReservedDBInstanceId NoThe offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. Type: String ReservedDBInstancesOfferingId Response Elements The following elements come wrapped in a DescribeReservedDBInstancesResult structure. DescriptionName The marker provided for paginated results. Type: String Marker A list of of reserved DB Instances. Type: ReservedDBInstance (p. 181) list ReservedDBInstances Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404The specified reserved DB Instance not found.ReservedDBInstanceNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeReservedDBInstances &ReservedDBInstanceId=customerSpecifiedID &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2012-12-18T18%3A31%3A36.118Z &AWSAccessKeyId= &Signature= API Version 2012-09-17 99 Amazon Relational Database Service API Reference Response Elements Sample Response Medium Utilization USD mysql 649fd0c8-cf6d-47a0-bfa6- 060f8e75e95f false active myreservationid 1 2010-12-15T00:25:14.131Z 31536000 227.5 0.046 db.m1.small c695119b-2961-11e1-bd06-6fe008f046c3 API Version 2012-09-17 100 Amazon Relational Database Service API Reference Examples DescribeReservedDBInstancesOfferings Description Lists available reserved DB Instance offerings. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class. Type: String DBInstanceClass NoDuration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000 Type: String Duration NoThe marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords. Type: String Marker NoThe maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer MaxRecords NoThe Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter. Type: Boolean MultiAZ NoThe offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization" Type: String OfferingType API Version 2012-09-17 101 Amazon Relational Database Service API Reference DescribeReservedDBInstancesOfferings RequiredDescriptionName NoProduct description filter value. Specify this parameter to show only the available offerings matching the specified product description. Type: String ProductDescription NoThe offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 Type: String ReservedDBInstancesOfferingId Response Elements The following elements come wrapped in a DescribeReservedDBInstancesOfferingsResult structure. DescriptionName A marker provided for paginated results. Type: String Marker A list of reserved DB Instance offerings. Type: ReservedDBInstancesOffering (p. 182) list ReservedDBInstancesOfferings Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404Specified offering does not exist.ReservedDBInstancesOfferingNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=DescribeReservedDBInstancesOfferings &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-12-18T18%3A31%3A36.118Z &AWSAccessKeyId= &Signature= API Version 2012-09-17 102 Amazon Relational Database Service API Reference Response Elements Sample Response 31536000 Heavy Utilization USD Hourly 0.123 162.0 mysql 0.0 false SampleOfferingId db.m1.small 521b420a-2961-11e1-bd06-6fe008f046c3 API Version 2012-09-17 103 Amazon Relational Database Service API Reference Examples ListTagsForResource Description Lists all tags on a DB Instance. For an overview on tagging DB Instances, see DB Instance Tags. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe DB Instance with tags to be listed. Type: String ResourceName Response Elements The following elements come wrapped in a ListTagsForResourceResult structure. DescriptionName List of tags returned by the ListTagsForResource operation. Type: Tag (p. 184) list TagList Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance.DBInstanceNotFound 404DBSnapshotIdentifier does not refer to an existing DB Snapshot.DBSnapshotNotFound API Version 2012-09-17 104 Amazon Relational Database Service API Reference ListTagsForResource ModifyDBInstance Description Modify 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. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe new storage capacity of the RDS instance. This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request. MySQL Default: Uses existing setting Valid Values: 5-1024 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer Oracle Default: Uses existing setting Valid Values: 10-1024 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. SQL Server Cannot be modified. Type: Integer AllocatedStorage NoIndicates that major version upgrades are allowed. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance©s current version. Type: Boolean AllowMajorVersionUpgrade API Version 2012-09-17 105 Amazon Relational Database Service API Reference ModifyDBInstance RequiredDescriptionName NoSpecifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance. If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance (p. 132), the next maintenance reboot, or the next failure reboot, whichever occurs first. Default: false Type: Boolean ApplyImmediately NoIndicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Type: Boolean AutoMinorVersionUpgrade NoThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: Uses existing setting Constraints: · Must be a value from 0 to 8 · Cannot be set to 0 if the DB Instance is a master instance with read replicas or of the DB Instance is a read replica Type: Integer BackupRetentionPeriod API Version 2012-09-17 106 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoThe new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions (p. 94) action. Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request. Default: Uses existing setting Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge Note Amazon RDS does not support db.t1.micro instances in a virtual private cloud (VPC). Type: String DBInstanceClass YesThe DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed. Constraints: · Must be the identifier for an existing DB Instance · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Example: Type: String DBInstanceIdentifier NoThe name of the DB Parameter Group to apply to this DB Instance. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request. Default: Uses existing setting Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance. Type: String DBParameterGroupName API Version 2012-09-17 107 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoA list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String list DBSecurityGroups.member.N NoThe version number of the database engine to upgrade to. For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family. Example: 5.1.42 Type: String EngineVersion NoThe new Provisioned IOPS (I/O operations per second) value for the RDS instance. This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request. Default: Uses existing setting Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer Iops API Version 2012-09-17 108 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoThe new password for the DB Instance master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Default: Uses existing setting Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Note Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost. Type: String MasterUserPassword NoSpecifies if the DB Instance is a Multi-AZ deployment. Constraints: Cannot be specified if the DB Instance is a read replica. Type: Boolean MultiAZ NoIndicates that the DB Instance should be associated with the specified option group. Type: String OptionGroupName NoThe daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Constraints: · Must be in the format hh24:mi-hh24:mi · Times should be Universal Time Coordinated (UTC) · Must not conflict with the preferred maintenance window · Must be at least 30 minutes Type: String PreferredBackupWindow API Version 2012-09-17 109 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoThe weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes Type: String PreferredMaintenanceWindow Response Elements The following elements come wrapped in a DBInstance structure. DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus API Version 2012-09-17 110 Amazon Relational Database Service API Reference Response Elements DescriptionName The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime API Version 2012-09-17 111 Amazon Relational Database Service API Reference Response Elements DescriptionName License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance. DBInstanceNotFound 404DBParameterGroupName does not refer to an existing DB Parameter Group. DBParameterGroupNotFound API Version 2012-09-17 112 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 404DBSecurityGroupName does not refer to an existing DB Security Group. DBSecurityGroupNotFound 400Specified DB Instance class is not available in the specified Availability Zone. InsufficientDBInstanceCapacity 400The specified DB Instance is not in the available state. InvalidDBInstanceState 400The state of the DB Security Group does not allow deletion. InvalidDBSecurityGroupState 400DB Subnet Group does not cover all availability zones after it is created because users© change. InvalidVPCNetworkState 400OptionGroupNotFound 400Provisioned IOPS not available in the specified Availability Zone. ProvisionedIopsNotAvailableInAZ 400Request would result in user exceeding the allowed amount of storage available across all DB Instances. StorageQuotaExceeded Examples Sample Request https://rds.amazonaws.com/ ?Action=ModifyDBInstance &DBInstanceIdentifier=simcoprod01 &AllocatedStorage=50 &Version=2012-09-17 &ApplyImmediately=false &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-23T08%3A02%3A09.574Z &AWSAccessKeyId= &Signature= Sample Response 2011-05-23T08:00:00Z mysql 50 API Version 2012-09-17 113 Amazon Relational Database Service API Reference Examples 1 false general-public-license available 5.1.50 3306
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
simcoprod01 in-sync default.mysql5.1 active default 00:00-00:30 true sat:07:30-sat:08:00 us-east-1a 2011-05-23T06:06:43.110Z 10 db.m1.large master
f61a020f-8512-11e0-90aa-eb648410240d
API Version 2012-09-17 114 Amazon Relational Database Service API Reference Examples ModifyDBParameterGroup Description Modifies the parameters of a DBParameterGroup. 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. Note The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB Instances for either dynamic or static parameters. For Microsoft SQL Server DB Instances, the pending-reboot method can be used only for static parameters. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe name of the DB Parameter Group. Constraints: · Must be the name of an existing DB Parameter Group · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBParameterGroupName YesAn array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. Valid Values (for the application method): immediate | pending-reboot Note You can use the immediate value with dynamic parameters only.You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots. Type: Parameter (p. 179) list Parameters.member.N Response Elements The following elements come wrapped in a ModifyDBParameterGroupResult structure. API Version 2012-09-17 115 Amazon Relational Database Service API Reference ModifyDBParameterGroup DescriptionName The name of the DB Parameter Group. Type: String DBParameterGroupName Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBParameterGroupName does not refer to an existing DB Parameter Group. DBParameterGroupNotFound 400The DB Parameter Group cannot be deleted because it is in use. InvalidDBParameterGroupState Examples Sample Request https://rds.amazonaws.com/ ?Action=ModifyDBParameterGroup &DBParameterGroupName=mydbparametergroup &Parameters.member.1.ParameterName=max_user_connections &Parameters.member.1.ParameterValue=24 &Parameters.member.1.ApplyMethod=pending-reboot &Parameters.member.2.ParameterName=max_allowed_packet &Parameters.member.2.ParameterValue=1024 &Parameters.member.2.ApplyMethod=immediate &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-11T21%3A25%3A00.686Z &AWSAccessKeyId= &Signature= Sample Response mydbparametergroup 5ba91f97-bf51-11de-bf60-ef2e377db6f3 API Version 2012-09-17 116 Amazon Relational Database Service API Reference Errors ModifyDBSubnetGroup Description Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in each AZ in the region. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe description for the DB Subnet Group. Type: String DBSubnetGroupDescription YesThe name for the DB Subnet Group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Example: mySubnetgroup Type: String DBSubnetGroupName YesThe EC2 Subnet IDs for the DB Subnet Group. Type: String list SubnetIds.member.N Response Elements The following elements come wrapped in a DBSubnetGroup structure. DescriptionName Provides the description of the DB Subnet Group. Type: String DBSubnetGroupDescription Specifies the name of the DB Subnet Group. Type: String DBSubnetGroupName Provides the status of the DB Subnet Group. Type: String SubnetGroupStatus Contains a list of Subnet (p. 183) elements. Type: Subnet (p. 183) list Subnets Provides the VpcId of the DB Subnet Group. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). API Version 2012-09-17 117 Amazon Relational Database Service API Reference ModifyDBSubnetGroup HTTP Status Code DescriptionError 400Subnets in the DB subnet group should cover all availability zones. DBSubnetGroupListDoesNotCoverAllAz 400DBSubnetGroupName does not refer to an existing DB Subnet Group. DBSubnetGroupNotFound 400Request would result in user exceeding the allowed number of subnets in a DB subnet Groups. DBSubnetQuotaExceeded 400Request subnet is valid, or all subnets are not in common Vpc. InvalidSubnet 400SubnetAlreadyInUse Examples Sample Request https://rds.amazonaws.com/ ?Action=ModifyDBSubnetGroup &DBSubnetGroupName=mydbsubnetgroup &DBSubnetGroupDescription=My%20modified%20DBSubnetGroup &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T18%3A14%3A49.482Z &AWSAccessKeyId= &Signature= Sample Response 990524496922 Complete My modified DBSubnetGroup mydbsubnetgroup Active subnet-7c5b4115 us-east-1c API Version 2012-09-17 118 Amazon Relational Database Service API Reference Examples Active subnet-7b5b4112 us-east-1b Active subnet-3ea6bd57 us-east-1d ed662948-a57b-11df-9e38-7ffab86c801f API Version 2012-09-17 119 Amazon Relational Database Service API Reference Examples ModifyOptionGroup Description Modifies an existing Option Group. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoIndicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the Option Group. Type: Boolean ApplyImmediately YesThe name of the option group to be modified. Type: String OptionGroupName NoOptions in this list are added to the Option Group or, if already present, the specified configuration is used to update the existing configuration. Type: OptionConfiguration (p. 176) list OptionsToInclude.member.N NoOptions in this list are removed from the Option Group. Type: String list OptionsToRemove.member.N Response Elements The following elements come wrapped in a OptionGroup structure. DescriptionName Indicates whether this option group can be applied to both VPC and non-VPC instances. Type: Boolean AllowsVpcAndNonVpcInstanceMemberships Engine name that this option group can be applied to. Type: String EngineName Indicates the major engine version associated with this option group. Type: String MajorEngineVersion Type: StringOptionGroupDescription Specifies the name of the option group. Type: String OptionGroupName Type: Option (p. 176) listOptions API Version 2012-09-17 120 Amazon Relational Database Service API Reference ModifyOptionGroup DescriptionName If AllowsVpcAndNonVpcInstanceMemberships is ©false©, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is ©true© and this field is blank, then this option group can only be applied to non-VPC instances. Otherwise, this option group can only be applied to instances that are in the VPC indicated by this field. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400InvalidOptionGroupState 400OptionGroupNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=ModifyOptionGroup &OptionGroupName=myoptiongroup &OptionsToInclude=OEM &DBSecurityGroupMemberships=default &ApplyImmediately=true https://rds.amazonaws.com/ ?Action=ModifyOptionGroup &OptionGroupName=myoptiongroup &OptionsToRemove=OEM &ApplyImmediately=true Sample Response myoptiongroup Test Option Group oracle-se1 11.2 ed662948-a57b-11df-9e38-7ffab86c801f myoptiongroup Test Option Group oracle-se1 11.2 ed662948-a57b-11df-9e38-7ffab86c801f API Version 2012-09-17 122 Amazon Relational Database Service API Reference Examples PromoteReadReplica Description Promotes a Read Replica DB Instance to a standalone DB Instance. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: · Must be a value from 0 to 8 Type: Integer BackupRetentionPeriod YesThe DB Instance identifier. This value is stored as a lowercase string. Constraints: · Must be the identifier for an existing Read Replica DB Instance · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Example: Type: String DBInstanceIdentifier API Version 2012-09-17 123 Amazon Relational Database Service API Reference PromoteReadReplica RequiredDescriptionName NoThe daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned. · US-East (Northern Virginia) Region: 03:00-11:00 UTC · US-West (Northern California) Region: 06:00-14:00 UTC · EU (Ireland) Region: 22:00-06:00 UTC · Asia Pacific (Singapore) Region: 14:00-22:00 UTC · Asia Pacific (Tokyo) Region: 17:00-03:00 UTC Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. Type: String PreferredBackupWindow Response Elements The following elements come wrapped in a DBInstance structure. DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass API Version 2012-09-17 124 Amazon Relational Database Service API Reference Response Elements DescriptionName Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime API Version 2012-09-17 125 Amazon Relational Database Service API Reference Response Elements DescriptionName Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier Errors For information about the common errors that all actions use, see Common Errors (p. 187). API Version 2012-09-17 126 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance.DBInstanceNotFound 400The specified DB Instance is not in the available state.InvalidDBInstanceState Examples Sample Request https://rds.amazonaws.com/ ?Action=PromoteReadReplica &DBInstanceIdentifier=simcoprod01 &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2012-08-23T08%3A02%3A09.574Z &AWSAccessKeyId= &Signature= Sample Response 2011-05-23T08:00:00Z mysql 50 1 false general-public-license available 5.1.50 3306
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
simcoprod01 in-sync default.mysql5.1 active default API Version 2012-09-17 127 Amazon Relational Database Service API Reference Examples 00:00-00:30 true sat:07:30-sat:08:00 us-east-1a 2011-05-23T06:06:43.110Z 10 db.m1.large master
f61a020f-8512-11e0-90aa-eb648410240d
API Version 2012-09-17 128 Amazon Relational Database Service API Reference Examples PurchaseReservedDBInstancesOffering Description Purchases a reserved DB Instance offering. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe number of instances to reserve. Default: 1 Type: Integer DBInstanceCount NoCustomer-specified identifier to track this reservation. Example: myreservationID Type: String ReservedDBInstanceId YesThe ID of the Reserved DB Instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 Type: String ReservedDBInstancesOfferingId Response Elements The following elements come wrapped in a ReservedDBInstance structure. DescriptionName The currency code for the reserved DB Instance. Type: String CurrencyCode The DB instance class for the reserved DB Instance. Type: String DBInstanceClass The number of reserved DB Instances. Type: Integer DBInstanceCount The duration of the reservation in seconds. Type: Integer Duration The fixed price charged for this reserved DB Instance. Type: Double FixedPrice Indicates if the reservation applies to Multi-AZ deployments. Type: Boolean MultiAZ API Version 2012-09-17 129 Amazon Relational Database Service API Reference PurchaseReservedDBInstancesOffering DescriptionName The offering type of this reserved DB Instance. Type: String OfferingType The description of the reserved DB Instance. Type: String ProductDescription The recurring price charged to run this reserved DB Instance. Type: RecurringCharge (p. 181) list RecurringCharges The unique identifier for the reservation. Type: String ReservedDBInstanceId The offering identifier. Type: String ReservedDBInstancesOfferingId The time the reservation started. Type: DateTime StartTime The state of the reserved DB Instance. Type: String State The hourly price charged for this reserved DB Instance. Type: Double UsagePrice Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404User already has a reservation with the given identifier. ReservedDBInstanceAlreadyExists 400Request would exceed the user©s DB Instance quota. ReservedDBInstanceQuotaExceeded 404Specified offering does not exist.ReservedDBInstancesOfferingNotFound Examples Sample Request https://rds.amazonaws.com/ ?Action=PurchaseReservedDBInstancesOffering &ReservedDBInstanceId=myreservationID &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706 &DBInstanceCount=1 &SignatureVersion=2 API Version 2012-09-17 130 Amazon Relational Database Service API Reference Errors &SignatureMethod=HmacSHA256 &Timestamp=2011-05-10T18%3A31%3A36.118Z &AWSAccessKeyId= &Signature= Sample Response Medium Utilization USD mysql 438012d3-4052-4cc7-b2e3- 8d3372e0e706 true payment-pending myreservationID 10 2011-12-18T23:24:56.577Z 31536000 123.0 0.123 db.m1.small 7f099901-29cf-11e1-bd06-6fe008f046c3 API Version 2012-09-17 131 Amazon Relational Database Service API Reference Examples RebootDBInstance Description Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe DB Instance identifier. This parameter is stored as a lowercase string. Constraints: · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBInstanceIdentifier NoWhen true, the reboot will be conducted through a MultiAZ failover. Constraint:You cannot specify true if the instance is not configured for MultiAZ. Type: Boolean ForceFailover Response Elements The following elements come wrapped in a DBInstance structure. DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone API Version 2012-09-17 132 Amazon Relational Database Service API Reference RebootDBInstance DescriptionName Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint API Version 2012-09-17 133 Amazon Relational Database Service API Reference Response Elements DescriptionName Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers API Version 2012-09-17 134 Amazon Relational Database Service API Reference Response Elements DescriptionName Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance.DBInstanceNotFound 400The specified DB Instance is not in the available state.InvalidDBInstanceState Examples Sample Request https://rds.amazonaws.com/ ?Action=RebootDBInstance &DBInstanceIdentifier=simcoprod01 &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-05-23T06%3A10%3A31.216Z &AWSAccessKeyId= &Signature= Sample Response 2011-05-23T06:07:38.831Z mysql 1 false general-public-license rebooting 5.1.50 3306
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
simcoprod01 API Version 2012-09-17 135 Amazon Relational Database Service API Reference Errors in-sync default.mysql5.1 active default 00:00-00:30 true sat:07:30-sat:08:00 us-east-1a 2011-05-23T06:06:43.110Z 10 db.m1.large master
5d5df758-8503-11e0-90aa-eb648410240d
API Version 2012-09-17 136 Amazon Relational Database Service API Reference Examples RemoveTagsFromResource Description Removes metadata tags from a DB Instance. For an overview on tagging DB Instances, see DB Instance Tags. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe DB Instance the tags will be removed from. Type: String ResourceName YesThe tag key (name) of the tag to be removed. Type: String list TagKeys.member.N Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBInstanceIdentifier does not refer to an existing DB Instance.DBInstanceNotFound 404DBSnapshotIdentifier does not refer to an existing DB Snapshot.DBSnapshotNotFound API Version 2012-09-17 137 Amazon Relational Database Service API Reference RemoveTagsFromResource ResetDBParameterGroup Description Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup 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. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName YesThe name of the DB Parameter Group. Constraints: · Must be 1 to 255 alphanumeric characters · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBParameterGroupName NoAn array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. MySQL Valid Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only.You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots. Oracle Valid Values (for Apply method): pending-reboot Type: Parameter (p. 179) list Parameters.member.N NoSpecifies whether (true) or not (false) to reset all parameters in the DB Parameter Group to default values. Default: true Type: Boolean ResetAllParameters API Version 2012-09-17 138 Amazon Relational Database Service API Reference ResetDBParameterGroup Response Elements The following elements come wrapped in a ResetDBParameterGroupResult structure. DescriptionName The name of the DB Parameter Group. Type: String DBParameterGroupName Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404DBParameterGroupName does not refer to an existing DB Parameter Group. DBParameterGroupNotFound 400The DB Parameter Group cannot be deleted because it is in use. InvalidDBParameterGroupState Examples Sample Request https://rds.amazonaws.com/ ?Action=ResetDBParameterGroup &DBParameterGroupName=mydbparametergroup &Parameters.member.1.ParameterName=max_user_connections &Parameters.member.1.ApplyMethod=pending-reboot &Parameters.member.2.ParameterName=max_allowed_packet &Parameters.member.2.ApplyMethod=immediate &ResetAllParameters=false &Version=2012-09-17 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &AWSAccessKeyId= &Signature= Sample Response mydbparametergroup 071e758f-bf57-11de-9f9f-53d6aee22de9 API Version 2012-09-17 139 Amazon Relational Database Service API Reference Response Elements RestoreDBInstanceFromDBSnapshot Description Creates a new DB Instance from a DB snapshot.The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoIndicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Type: Boolean AutoMinorVersionUpgrade NoThe EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint:You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a Type: String AvailabilityZone NoThe compute and memory capacity of the Amazon RDS DB instance. Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge Type: String DBInstanceClass YesThe identifier for the DB Snapshot to restore from. Constraints: · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String DBInstanceIdentifier API Version 2012-09-17 140 Amazon Relational Database Service API Reference RestoreDBInstanceFromDBSnapshot RequiredDescriptionName NoThe database name for the restored DB Instance. Note This parameter doesn©t apply to the MySQL engine. Type: String DBName YesName of the DB Instance to create from the DB Snapshot. This parameter isn©t case sensitive. Constraints: · Must contain from 1 to 255 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id Type: String DBSnapshotIdentifier NoThe DB Subnet Group name to use for the new instance. Type: String DBSubnetGroupName NoThe database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Example: oracle-ee Type: String Engine NoThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance. Constraints: Must be an integer greater than 1000. Type: Integer Iops NoLicense model information for the restored DB Instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license Type: String LicenseModel API Version 2012-09-17 141 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoSpecifies if the DB Instance is a Multi-AZ deployment. Constraint:You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Type: Boolean MultiAZ NoType: StringOptionGroupName NoThe port number on which the database accepts connections. Default: The same port as the original DB Instance Constraints: Value must be 1150-65535 Type: Integer Port Response Elements The following elements come wrapped in a DBInstance structure. DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus API Version 2012-09-17 142 Amazon Relational Database Service API Reference Response Elements DescriptionName The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime API Version 2012-09-17 143 Amazon Relational Database Service API Reference Response Elements DescriptionName License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400User already has a DB Instance with the given identifier. DBInstanceAlreadyExists 404DBSnapshotIdentifier does not refer to an existing DB Snapshot. DBSnapshotNotFound API Version 2012-09-17 144 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 400DBSubnetGroupName does not refer to an existing DB Subnet Group. DBSubnetGroupNotFound 400Request would result in user exceeding the allowed number of DB Instances. InstanceQuotaExceeded 400Specified DB Instance class is not available in the specified Availability Zone. InsufficientDBInstanceCapacity 400The state of the DB Security Snapshot does not allow deletion. InvalidDBSnapshotState 400Cannot restore from vpc backup to non-vpc DB instance. InvalidRestore 400DB Subnet Group does not cover all availability zones after it is created because users© change. InvalidVPCNetworkState 400OptionGroupNotFound 400Provisioned IOPS not available in the specified Availability Zone. ProvisionedIopsNotAvailableInAZ 400Request would result in user exceeding the allowed amount of storage available across all DB Instances. StorageQuotaExceeded Examples Sample Request https://rds.amazon.com/ ?Action=RestoreDBInstanceFromDBSnapshot &DBSnapshotIdentifier=mydbsnapshot &DBInstanceIdentifier=myrestoreddbinstance &Version=2012-09-17 &Timestamp=2011-05-23T06%3A47%3A11.071Z &SignatureVersion=2 &SignatureMethod=HmacSHA256 &AWSAccessKeyId= &Signature= Sample Response mysql API Version 2012-09-17 145 Amazon Relational Database Service API Reference Examples 1 false general-public-license creating 5.1.50 myrestoreddbinstance in-sync default.mysql5.1 active default 00:00-00:30 true sat:07:30-sat:08:00 10 db.m1.large master 7ca622e8-8508-11e0-bd9b-a7b1ece36d51 API Version 2012-09-17 146 Amazon Relational Database Service API Reference Examples RestoreDBInstanceToPointInTime Description Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group. Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoIndicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Type: Boolean AutoMinorVersionUpgrade NoThe EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint:You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a Type: String AvailabilityZone NoThe compute and memory capacity of the Amazon RDS DB instance. Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge Default:The same DBInstanceClass as the original DB Instance. Type: String DBInstanceClass NoThe database name for the restored DB Instance. Note This parameter is not used for the MySQL engine. Type: String DBName NoThe DB subnet group name to use for the new instance. Type: String DBSubnetGroupName API Version 2012-09-17 147 Amazon Relational Database Service API Reference RestoreDBInstanceToPointInTime RequiredDescriptionName NoThe database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Example: oracle-ee Type: String Engine NoThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance. Constraints: Must be an integer greater than 1000. Type: Integer Iops NoLicense model information for the restored DB Instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license Type: String LicenseModel NoSpecifies if the DB Instance is a Multi-AZ deployment. Constraint:You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Type: Boolean MultiAZ NoType: StringOptionGroupName NoThe port number on which the database accepts connections. Constraints: Value must be 1150-65535 Default:The same port as the original DB Instance. Type: Integer Port API Version 2012-09-17 148 Amazon Relational Database Service API Reference Request Parameters RequiredDescriptionName NoThe date and time to restore from. Valid Values: Value must be a UTC time Constraints: · Must be before the latest restorable time for the DB Instance · Cannot be specified if UseLatestRestorableTime parameter is true Example: 2009-09-07T23:45:00Z Type: DateTime RestoreTime YesThe identifier of the source DB Instance from which to restore. Constraints: · Must be the identifier of an existing database instance · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String SourceDBInstanceIdentifier YesThe name of the new database instance to be created. Constraints: · Must contain from 1 to 63 alphanumeric characters or hyphens · First character must be a letter · Cannot end with a hyphen or contain two consecutive hyphens Type: String TargetDBInstanceIdentifier NoSpecifies whether (true) or not (false) the DB Instance is restored from the latest backup time. Default: false Constraints: Cannot be specified if RestoreTime parameter is provided. Type: Boolean UseLatestRestorableTime API Version 2012-09-17 149 Amazon Relational Database Service API Reference Request Parameters Response Elements The following elements come wrapped in a DBInstance structure. DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName API Version 2012-09-17 150 Amazon Relational Database Service API Reference Response Elements DescriptionName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership API Version 2012-09-17 151 Amazon Relational Database Service API Reference Response Elements DescriptionName Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 400User already has a DB Instance with the given identifier. DBInstanceAlreadyExists 404DBInstanceIdentifier does not refer to an existing DB Instance. DBInstanceNotFound 400DBSubnetGroupName does not refer to an existing DB Subnet Group. DBSubnetGroupNotFound 400Request would result in user exceeding the allowed number of DB Instances. InstanceQuotaExceeded 400Specified DB Instance class is not available in the specified Availability Zone. InsufficientDBInstanceCapacity 400The specified DB Instance is not in the available state. InvalidDBInstanceState 400Cannot restore from vpc backup to non-vpc DB instance. InvalidRestore 400DB Subnet Group does not cover all availability zones after it is created because users© change. InvalidVPCNetworkState API Version 2012-09-17 152 Amazon Relational Database Service API Reference Errors HTTP Status Code DescriptionError 400OptionGroupNotFound 400SourceDBInstanceIdentifier refers to a DB Instance with BackupRetentionPeriod equal to 0. PointInTimeRestoreNotEnabled 400Provisioned IOPS not available in the specified Availability Zone. ProvisionedIopsNotAvailableInAZ 400Request would result in user exceeding the allowed amount of storage available across all DB Instances. StorageQuotaExceeded Examples Sample Request https://rds.amazon.com/ ?Action=RestoreDBInstanceToPointInTime &TargetDBInstanceIdentifier=restored-db &SourceDBInstanceIdentifier=simcoprod01 &UseLatestRestorableTime=true &Version=2012-09-17 &Timestamp=2011-05-23T07%3A06%3A02.313Z &SignatureVersion=2 &SignatureMethod=HmacSHA256 &AWSAccessKeyId= &Signature= Sample Response mysql 1 false general-public-license creating 5.1.50 restored-db in-sync default.mysql5.1 API Version 2012-09-17 153 Amazon Relational Database Service API Reference Examples active default 00:00-00:30 true sat:07:30-sat:08:00 10 db.m1.large master 1ef546bc-850b-11e0-90aa-eb648410240d API Version 2012-09-17 154 Amazon Relational Database Service API Reference Examples RevokeDBSecurityGroupIngress Description 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). Request Parameters For information about the common parameters that all actions use, see Common Query Parameters (p.185). RequiredDescriptionName NoThe IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided. Type: String CIDRIP YesThe name of the DB Security Group to revoke ingress from. Type: String DBSecurityGroupName NoThe id of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Type: String EC2SecurityGroupId NoThe name of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Type: String EC2SecurityGroupName NoThe AWS 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. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Type: String EC2SecurityGroupOwnerId Response Elements The following elements come wrapped in a DBSecurityGroup structure. API Version 2012-09-17 155 Amazon Relational Database Service API Reference RevokeDBSecurityGroupIngress 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. 173) elements. Type: EC2SecurityGroup (p. 173) list EC2SecurityGroups Contains a list of IPRange (p. 175) elements. Type: IPRange (p. 175) list IPRanges Provides the AWS ID of the owner of a specific DB Security Group. Type: String OwnerId Provides the VpcId of the DB Security Group. Type: String VpcId Errors For information about the common errors that all actions use, see Common Errors (p. 187). HTTP Status Code DescriptionError 404Specified CIDRIP or EC2 security group is not authorized for the specified DB Security Group. AuthorizationNotFound 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/ ?Action=RevokeDBSecurityGroupIngress &DBSecurityGroupName=mydbsecuritygroup &CIDRIP=192.168.1.1%2F24 &Version=2012-09-17 &SignatureVersion=2&SignatureMethod=HmacSHA256 &Timestamp=2011-02-15T22%3A32%3A12.515Z &AWSAccessKeyId= &Signature= API Version 2012-09-17 156 Amazon Relational Database Service API Reference Errors Sample Response My new DBSecurityGroup 192.168.1.1/24 revoking 621567473609 mydbsecuritygroup vpc-1ab2c3d4 beecb8ac-bf5a-11de-9f9f-53d6aee22de9 API Version 2012-09-17 157 Amazon Relational Database Service API Reference Examples Data Types The Amazon Relational Database Service API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in the response is not guaranteed. Applications should not assume a particular order. The following data types are supported: · AvailabilityZone (p. 159) · CharacterSet (p. 160) · DBEngineVersion (p. 160) · DBInstance (p. 161) · DBParameterGroup (p. 163) · DBParameterGroupStatus (p. 164) · DBSecurityGroup (p. 165) · DBSecurityGroupMembership (p. 165) · DBSnapshot (p. 166) · DBSubnetGroup (p. 167) · DescribeDBEngineVersionsResult (p. 168) · DescribeDBInstancesResult (p. 168) · DescribeDBParameterGroupsResult (p. 168) · DescribeDBParametersResult (p. 169) · DescribeDBSecurityGroupsResult (p. 169) · DescribeDBSnapshotsResult (p. 170) · DescribeDBSubnetGroupsResult (p. 170) · DescribeEventsResult (p. 170) · DescribeOptionGroupOptionsResult (p. 171) · DescribeOptionGroupsResult (p. 171) API Version 2012-09-17 158 Amazon Relational Database Service API Reference · DescribeOrderableDBInstanceOptionsResult (p. 171) · DescribeReservedDBInstancesOfferingsResult (p. 172) · DescribeReservedDBInstancesResult (p. 172) · EC2SecurityGroup (p. 173) · Endpoint (p. 173) · EngineDefaults (p. 174) · Event (p. 174) · IPRange (p. 175) · ListTagsForResourceResult (p. 175) · ModifyDBParameterGroupResult (p. 175) · Option (p. 176) · OptionConfiguration (p. 176) · OptionGroup (p. 176) · OptionGroupMembership (p. 177) · OptionGroupOption (p. 177) · OrderableDBInstanceOption (p. 178) · Parameter (p. 179) · PendingModifiedValues (p. 180) · RecurringCharge (p. 181) · ReservedDBInstance (p. 181) · ReservedDBInstancesOffering (p. 182) · ResetDBParameterGroupResult (p. 183) · Subnet (p. 183) · Tag (p. 184) AvailabilityZone Description Contains Availability Zone information. This data type is used as an element in the following data type: · OrderableDBInstanceOption (p. 178) Contents DescriptionName The name of the availability zone. Type: String Name API Version 2012-09-17 159 Amazon Relational Database Service API Reference AvailabilityZone DescriptionName Type: BooleanProvisionedIopsCapable CharacterSet Description This data type is used as a response element in the action DescribeDBEngineVersions (p. 59). Contents DescriptionName The description of the character set. Type: String CharacterSetDescription The name of the character set. Type: String CharacterSetName DBEngineVersion Description This data type is used as a response element in the action DescribeDBEngineVersions (p. 59). Contents DescriptionName The description of the database engine. Type: String DBEngineDescription The description of the database engine version. Type: String DBEngineVersionDescription The name of the DBParameterGroupFamily for the database engine. Type: String DBParameterGroupFamily The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified. Type: CharacterSet (p. 160) DefaultCharacterSet The name of the database engine. Type: String Engine API Version 2012-09-17 160 Amazon Relational Database Service API Reference CharacterSet DescriptionName The version number of the database engine. Type: String EngineVersion A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API. Type: CharacterSet (p. 160) list SupportedCharacterSets DBInstance Description Contains the result of a successful invocation of the following actions: · CreateDBInstance (p. 11) · DeleteDBInstance (p. 43) · ModifyDBInstance (p. 105) This data type is used as a response element in the DescribeDBInstances (p. 64) action. Contents DescriptionName Specifies the allocated storage size specified in gigabytes. Type: Integer AllocatedStorage Indicates that minor version patches are applied automatically. Type: Boolean AutoMinorVersionUpgrade Specifies the name of the Availability Zone the DB Instance is located in. Type: String AvailabilityZone Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer BackupRetentionPeriod If present, specifies the name of the character set that this instance is associated with. Type: String CharacterSetName Contains the name of the compute and memory capacity class of the DB Instance. Type: String DBInstanceClass API Version 2012-09-17 161 Amazon Relational Database Service API Reference DBInstance DescriptionName Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String DBInstanceIdentifier Specifies the current state of this database. Type: String DBInstanceStatus The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created.This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String DBName Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus (p. 164) list DBParameterGroups Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. Type: DBSecurityGroupMembership (p. 165) list DBSecurityGroups Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup (p. 167) DBSubnetGroup Specifies the connection endpoint. Type: Endpoint (p. 173) Endpoint Provides the name of the database engine to be used for this DB Instance. Type: String Engine Indicates the database engine version. Type: String EngineVersion Provides the date and time the DB Instance was created. Type: DateTime InstanceCreateTime API Version 2012-09-17 162 Amazon Relational Database Service API Reference Contents DescriptionName Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Iops Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime LatestRestorableTime License model information for this DB Instance. Type: String LicenseModel Contains the master username for the DB Instance. Type: String MasterUsername Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership (p. 177) OptionGroupMembership Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues (p. 180) PendingModifiedValues Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Type: String PreferredBackupWindow Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String PreferredMaintenanceWindow Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list ReadReplicaDBInstanceIdentifiers Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String ReadReplicaSourceDBInstanceIdentifier DBParameterGroup Description Contains the result of a successful invocation of the CreateDBParameterGroup (p. 29) action. API Version 2012-09-17 163 Amazon Relational Database Service API Reference DBParameterGroup This data type is used as a request parameter in the DeleteDBParameterGroup (p. 49) action, and as a response element in the DescribeDBParameterGroups (p. 67) action. Contents DescriptionName Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with. Type: String DBParameterGroupFamily Provides the name of the DB Parameter Group. Type: String DBParameterGroupName Provides the customer-specified description for this DB Parameter Group. Type: String Description DBParameterGroupStatus Description The status of the DB Parameter Group. This data type is used as a response element in the following actions: · CreateDBInstance (p. 11) · CreateDBInstanceReadReplica (p. 23) · DeleteDBInstance (p. 43) · ModifyDBInstance (p. 105) · RebootDBInstance (p. 132) · RestoreDBInstanceFromDBSnapshot (p. 140) Contents DescriptionName The name of the DP Parameter Group. Type: String DBParameterGroupName The status of parameter updates. Type: String ParameterApplyStatus API Version 2012-09-17 164 Amazon Relational Database Service API Reference Contents DBSecurityGroup Description Contains the result of a successful invocation of the following actions: · DescribeDBSecurityGroups (p. 72) · AuthorizeDBSecurityGroupIngress (p. 5) · CreateDBSecurityGroup (p. 32) · RevokeDBSecurityGroupIngress (p. 155) This data type is used as a response element in the DescribeDBSecurityGroups (p. 72) action. Contents 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. 173) elements. Type: EC2SecurityGroup (p. 173) list EC2SecurityGroups Contains a list of IPRange (p. 175) elements. Type: IPRange (p. 175) list IPRanges Provides the AWS ID of the owner of a specific DB Security Group. Type: String OwnerId Provides the VpcId of the DB Security Group. Type: String VpcId DBSecurityGroupMembership Description This data type is used as a response element in the following actions: · ModifyDBInstance (p. 105) · RebootDBInstance (p. 132) · RestoreDBInstanceFromDBSnapshot (p. 140) · RestoreDBInstanceToPointInTime (p. 147) API Version 2012-09-17 165 Amazon Relational Database Service API Reference DBSecurityGroup Contents DescriptionName The name of the DB Security Group. Type: String DBSecurityGroupName The status of the DB Security Group. Type: String Status DBSnapshot Description Contains the result of a successful invocation of the following actions: · CreateDBSnapshot (p. 34) · DeleteDBSnapshot (p. 53) This data type is used as a response element in the DescribeDBSnapshots (p. 75) action. Contents DescriptionName Specifies the allocated storage size in gigabytes (GB). Type: Integer AllocatedStorage Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot. Type: String AvailabilityZone Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from. Type: String DBInstanceIdentifier Specifies the identifier for the DB Snapshot. Type: String DBSnapshotIdentifier Specifies the name of the database engine. Type: String Engine Specifies the version of the database engine. Type: String EngineVersion Specifies the time (UTC) when the snapshot was taken. Type: DateTime InstanceCreateTime Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot. Type: Integer Iops API Version 2012-09-17 166 Amazon Relational Database Service API Reference Contents DescriptionName License model information for the restored DB Instance. Type: String LicenseModel Provides the master username for the DB Instance. Type: String MasterUsername Specifies the port that the database engine was listening on at the time of the snapshot. Type: Integer Port Provides the time (UTC) when the snapshot was taken. Type: DateTime SnapshotCreateTime Provides the type of the DB Snapshot. Type: String SnapshotType Specifies the status of this DB Snapshot. Type: String Status Provides the Vpc Id associated with the DB Snapshot. Type: String VpcId DBSubnetGroup Description Contains the result of a successful invocation of the following actions: · CreateDBSubnetGroup (p. 37) · ModifyDBSubnetGroup (p. 117) · DescribeDBSubnetGroups (p. 79) · DeleteDBSubnetGroup (p. 56) This data type is used as a response element in the DescribeDBSubnetGroups (p. 79) action. Contents DescriptionName Provides the description of the DB Subnet Group. Type: String DBSubnetGroupDescription Specifies the name of the DB Subnet Group. Type: String DBSubnetGroupName Provides the status of the DB Subnet Group. Type: String SubnetGroupStatus Contains a list of Subnet (p. 183) elements. Type: Subnet (p. 183) list Subnets API Version 2012-09-17 167 Amazon Relational Database Service API Reference DBSubnetGroup DescriptionName Provides the VpcId of the DB Subnet Group. Type: String VpcId DescribeDBEngineVersionsResult Description Contains the result of a successful invocation of the DescribeDBEngineVersions (p. 59) action. Contents DescriptionName A list of DBEngineVersion elements. Type: DBEngineVersion (p. 160) list DBEngineVersions The identifier returned to allow retrieval of paginated results. Type: String Marker DescribeDBInstancesResult Description Contains the result of a successful invocation of the DescribeDBInstances (p. 64) action. Contents DescriptionName A list of DBInstance (p. 161) instances. Type: DBInstance (p. 161) list DBInstances The marker obtained from a previous operation response. Type: String Marker DescribeDBParameterGroupsResult Description Contains the result of a successful invocation of the DescribeDBParameterGroups (p. 67) action. API Version 2012-09-17 168 Amazon Relational Database Service API Reference DescribeDBEngineVersionsResult Contents DescriptionName A list of DBParameterGroup (p. 163) instances. Type: DBParameterGroup (p. 163) list DBParameterGroups The marker obtained from a previous operation response. Type: String Marker DescribeDBParametersResult Description Contains the result of a successful invocation of the DescribeDBParameters (p. 69) action. Contents DescriptionName The marker obtained from a previous operation response. Type: String Marker A list of Parameter (p. 179) instances. Type: Parameter (p. 179) list Parameters DescribeDBSecurityGroupsResult Description Contains the result of a successful invocation of the DescribeDBSecurityGroups (p. 72) action. Contents DescriptionName A list of DBSecurityGroup (p. 165) instances. Type: DBSecurityGroup (p. 165) list DBSecurityGroups The marker obtained from a previous operation response. Type: String Marker API Version 2012-09-17 169 Amazon Relational Database Service API Reference Contents DescribeDBSnapshotsResult Description Contains the result of a successful invocation of the DescribeDBSnapshots (p. 75) action. Contents DescriptionName A list of DBSnapshot (p. 166) instances. Type: DBSnapshot (p. 166) list DBSnapshots The marker obtained from a previous operation response. Type: String Marker DescribeDBSubnetGroupsResult Description Contains the result of a successful invocation of the DescribeDBSubnetGroups (p. 79) action. Contents DescriptionName A list of DBSubnetGroup (p. 167) instances. Type: DBSubnetGroup (p. 167) list DBSubnetGroups The marker obtained from a previous operation response. Type: String Marker DescribeEventsResult Description Contains the result of a successful invocation of the DescribeEvents (p. 85) action. Contents DescriptionName A list of Event (p. 174) instances. Type: Event (p. 174) list Events API Version 2012-09-17 170 Amazon Relational Database Service API Reference DescribeDBSnapshotsResult DescriptionName The marker obtained from a previous operation response. Type: String Marker DescribeOptionGroupOptionsResult Description Contents DescriptionName Type: StringMarker List of available options. Type: OptionGroupOption (p. 177) list OptionGroupOptions DescribeOptionGroupsResult Description List of option groups. Contents DescriptionName Type: StringMarker List of option groups. Type: OptionGroup (p. 176) list OptionGroupsList DescribeOrderableDBInstanceOptionsResult Description Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions (p. 94) action. API Version 2012-09-17 171 Amazon Relational Database Service API Reference DescribeOptionGroupOptionsResult Contents DescriptionName A marker that can be used to retrieve paginated results. Type: String Marker An OrderableDBInstanceOption (p. 178) structure containing information about orderable options for the DB Instance. Type: OrderableDBInstanceOption (p. 178) list OrderableDBInstanceOptions DescribeReservedDBInstancesOfferingsResult Description Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings (p. 101) action. Contents DescriptionName A marker provided for paginated results. Type: String Marker A list of reserved DB Instance offerings. Type: ReservedDBInstancesOffering (p. 182) list ReservedDBInstancesOfferings DescribeReservedDBInstancesResult Description Contains the result of a successful invocation of the DescribeReservedDBInstances (p. 98) action. Contents DescriptionName The marker provided for paginated results. Type: String Marker A list of of reserved DB Instances. Type: ReservedDBInstance (p. 181) list ReservedDBInstances API Version 2012-09-17 172 Amazon Relational Database Service API Reference Contents EC2SecurityGroup Description This data type is used as a response element in the following actions: · AuthorizeDBSecurityGroupIngress (p. 5) · DescribeDBSecurityGroups (p. 72) · RevokeDBSecurityGroupIngress (p. 155) Contents DescriptionName Specifies the id of the EC2 Security Group. Type: String EC2SecurityGroupId Specifies the name of the EC2 Security Group. Type: String EC2SecurityGroupName Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field. Type: String EC2SecurityGroupOwnerId Provides the status of the EC2 security group. Type: String Status Endpoint Description This data type is used as a response element in the following actions: · CreateDBInstance (p. 11) · DescribeDBInstances (p. 64) · DeleteDBInstance (p. 43) Contents DescriptionName Specifies the DNS address of the DB Instance. Type: String Address Specifies the port that the database engine is listening on. Type: Integer Port API Version 2012-09-17 173 Amazon Relational Database Service API Reference EC2SecurityGroup EngineDefaults Description Contains the result of a successful invocation of the DescribeEngineDefaultParameters (p. 82) action. Contents DescriptionName Specifies the name of the DB Parameter Group Family which the engine default parameters apply to. Type: String DBParameterGroupFamily Provides an identifier to allow retrieval of paginated results. Type: String Marker Contains a list of engine default parameters. Type: Parameter (p. 179) list Parameters Event Description This data type is used as a response element in the DescribeEvents (p. 85) action. Contents DescriptionName Specifies the date and time of the event. Type: DateTime Date Provides the text of this event. Type: String Message Provides the identifier for the source of the event. Type: String SourceIdentifier Specifies the source type for this event. Type: String Valid Values: db-instance | db-parameter-group | db-security-group | db-snapshot SourceType API Version 2012-09-17 174 Amazon Relational Database Service API Reference EngineDefaults IPRange Description This data type is used as a response element in the DescribeDBSecurityGroups (p. 72) action. Contents DescriptionName Specifies the IP range. Type: String CIDRIP Specifies the status of the IP range. Type: String Status ListTagsForResourceResult Description Contents DescriptionName List of tags returned by the ListTagsForResource operation. Type: Tag (p. 184) list TagList ModifyDBParameterGroupResult Description Contains the result of a successful invocation of the ModifyDBParameterGroup (p. 115) or ResetDBParameterGroup (p. 138) action. Contents DescriptionName The name of the DB Parameter Group. Type: String DBParameterGroupName API Version 2012-09-17 175 Amazon Relational Database Service API Reference IPRange Option Description No action documentation available. Contents DescriptionName Type: DBSecurityGroupMembership (p. 165) listDBSecurityGroupMemberships The description of the option. Type: String OptionDescription The name of the option. Type: String OptionName If required, the port configured for this option to use. Type: Integer Port OptionConfiguration Description No action documentation available. Contents DescriptionName Type: String listDBSecurityGroupMemberships Type: StringOptionName Type: IntegerPort OptionGroup Description Contents DescriptionName Indicates whether this option group can be applied to both VPC and non-VPC instances. Type: Boolean AllowsVpcAndNonVpcInstanceMemberships API Version 2012-09-17 176 Amazon Relational Database Service API Reference Option DescriptionName Engine name that this option group can be applied to. Type: String EngineName Indicates the major engine version associated with this option group. Type: String MajorEngineVersion Type: StringOptionGroupDescription Specifies the name of the option group. Type: String OptionGroupName Type: Option (p. 176) listOptions If AllowsVpcAndNonVpcInstanceMemberships is ©false©, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is ©true© and this field is blank, then this option group can only be applied to non-VPC instances. Otherwise, this option group can only be applied to instances that are in the VPC indicated by this field. Type: String VpcId OptionGroupMembership Description No action documentation available. Contents DescriptionName The name of the option group that the instance belongs to. Type: String OptionGroupName The status of the DB Instance©s option group membership (e.g. in-sync, pending, pending-maintenance, applying). Type: String Status OptionGroupOption Description Available option. API Version 2012-09-17 177 Amazon Relational Database Service API Reference OptionGroupMembership Contents DescriptionName If the option requires a port, specifies the default port for the option. Type: Integer DefaultPort The description of the option. Type: String Description Engine name that this option can be applied to. Type: String EngineName Indicates the major engine version that the option is available for. Type: String MajorEngineVersion The minimum required engine version for the option to be applied. Type: String MinimumRequiredMinorEngineVersion The name of the option. Type: String Name List of all options that are prerequisites for this option. Type: String list OptionsDependedOn Specifies whether the option requires a port. Type: Boolean PortRequired OrderableDBInstanceOption Description Contains a list of available options for a DB Instance This data type is used as a response element in the DescribeOrderableDBInstanceOptions (p. 94) action. Contents DescriptionName A list of availability zones for the orderable DB Instance. Type: AvailabilityZone (p. 159) list AvailabilityZones The DB Instance Class for the orderable DB Instance Type: String DBInstanceClass The engine type of the orderable DB Instance. Type: String Engine API Version 2012-09-17 178 Amazon Relational Database Service API Reference Contents DescriptionName The engine version of the orderable DB Instance. Type: String EngineVersion The license model for the orderable DB Instance. Type: String LicenseModel Indicates whether this orderable DB Instance is multi-AZ capable. Type: Boolean MultiAZCapable Indicates whether this orderable DB Instance can have a read replica. Type: Boolean ReadReplicaCapable Indicates whether this is a VPC orderable DB Instance. Type: Boolean Vpc Parameter Description This data type is used as a request parameter in the ModifyDBParameterGroup (p. 115) and ResetDBParameterGroup (p. 138) actions. This data type is used as a response element in the DescribeEngineDefaultParameters (p. 82) and DescribeDBParameters (p. 69) actions. Contents DescriptionName Specifies the valid range of values for the parameter. Type: String AllowedValues Indicates when to apply parameter updates. Type: String Valid Values: immediate | pending-reboot ApplyMethod Specifies the engine specific parameters type. Type: String ApplyType Specifies the valid data type for the parameter. Type: String DataType Provides a description of the parameter. Type: String Description Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. Type: Boolean IsModifiable API Version 2012-09-17 179 Amazon Relational Database Service API Reference Parameter DescriptionName The earliest engine version to which the parameter can apply. Type: String MinimumEngineVersion Specifies the name of the parameter. Type: String ParameterName Specifies the value of the parameter. Type: String ParameterValue Indicates the source of the parameter value. Type: String Source PendingModifiedValues Description This data type is used as a response element in the ModifyDBInstance (p. 105) action. Contents DescriptionName Contains the new AllocatedStorage size for the DB Instance that will be applied or is in progress. Type: Integer AllocatedStorage Specifies the pending number of days for which automated backups are retained. Type: Integer BackupRetentionPeriod Contains the new DBInstanceClass for the DB Instance that will be applied or is in progress. Type: String DBInstanceClass Indicates the database engine version. Type: String EngineVersion Specifies the new Provisioned IOPS value for the DB Instance that will be applied or is being applied. Type: Integer Iops Contains the pending or in-progress change of the master credentials for the DB Instance. Type: String MasterUserPassword Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment. Type: Boolean MultiAZ Specifies the pending port for the DB Instance. Type: Integer Port API Version 2012-09-17 180 Amazon Relational Database Service API Reference PendingModifiedValues RecurringCharge Description This data type is used as a response element in the DescribeReservedDBInstances (p. 98) and DescribeReservedDBInstancesOfferings (p. 101) actions. Contents DescriptionName The amount of the recurring charge. Type: Double RecurringChargeAmount The frequency of the recurring charge. Type: String RecurringChargeFrequency ReservedDBInstance Description This data type is used as a response element in the DescribeReservedDBInstances (p. 98) and PurchaseReservedDBInstancesOffering (p. 129) actions. Contents DescriptionName The currency code for the reserved DB Instance. Type: String CurrencyCode The DB instance class for the reserved DB Instance. Type: String DBInstanceClass The number of reserved DB Instances. Type: Integer DBInstanceCount The duration of the reservation in seconds. Type: Integer Duration The fixed price charged for this reserved DB Instance. Type: Double FixedPrice Indicates if the reservation applies to Multi-AZ deployments. Type: Boolean MultiAZ The offering type of this reserved DB Instance. Type: String OfferingType API Version 2012-09-17 181 Amazon Relational Database Service API Reference RecurringCharge DescriptionName The description of the reserved DB Instance. Type: String ProductDescription The recurring price charged to run this reserved DB Instance. Type: RecurringCharge (p. 181) list RecurringCharges The unique identifier for the reservation. Type: String ReservedDBInstanceId The offering identifier. Type: String ReservedDBInstancesOfferingId The time the reservation started. Type: DateTime StartTime The state of the reserved DB Instance. Type: String State The hourly price charged for this reserved DB Instance. Type: Double UsagePrice ReservedDBInstancesOffering Description This data type is used as a response element in the DescribeReservedDBInstancesOfferings (p. 101) action. Contents DescriptionName The currency code for the reserved DB Instance offering. Type: String CurrencyCode The DB instance class for the reserved DB Instance. Type: String DBInstanceClass The duration of the offering in seconds. Type: Integer Duration The fixed price charged for this offering. Type: Double FixedPrice Indicates if the offering applies to Multi-AZ deployments. Type: Boolean MultiAZ The offering type. Type: String OfferingType API Version 2012-09-17 182 Amazon Relational Database Service API Reference ReservedDBInstancesOffering DescriptionName The database engine used by the offering. Type: String ProductDescription The recurring price charged to run this reserved DB Instance. Type: RecurringCharge (p. 181) list RecurringCharges The offering identifier. Type: String ReservedDBInstancesOfferingId The hourly price charged for this offering. Type: Double UsagePrice ResetDBParameterGroupResult Description Contains the result of a successful invocation of the ModifyDBParameterGroup (p. 115) or ResetDBParameterGroup (p. 138) action. Contents DescriptionName The name of the DB Parameter Group. Type: String DBParameterGroupName Subnet Description This data type is used as a response element in the DescribeDBSubnetGroups (p. 79) action. Contents DescriptionName Contains Availability Zone information. This data type is used as an element in the following data type: · OrderableDBInstanceOption (p. 178) Type: AvailabilityZone (p. 159) SubnetAvailabilityZone API Version 2012-09-17 183 Amazon Relational Database Service API Reference ResetDBParameterGroupResult DescriptionName Specifies the identifier of the subnet. Type: String SubnetIdentifier Specifies the status of the subnet. Type: String SubnetStatus Tag Description Metadata assigned to a DB Instance consisting of a key-value pair. Contents DescriptionName A key is the required name of the tag.The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:". The string may only contain only the set of Unicode letters, digits, white-space, ©_©, ©.©, ©/©, ©=©, ©+©, ©-© (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). Type: String Key A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:". The string may only contain only the set of Unicode letters, digits, white-space, ©_©, ©.©, ©/©, ©=©, ©+©, ©-© (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). Type: String Value API Version 2012-09-17 184 Amazon Relational Database Service API Reference Tag Common Query Parameters This section lists the request parameters that all actions use. Any action-specific parameters are listed in the topic for the action. RequiredDescriptionParameter Name YesThe action to perform. Default: None Type: String Action ConditionalThe parameters required to authenticate a query request. Contains: AWSAccessKeyID SignatureVersion Timestamp Signature Default: None AuthParams YesThe Access Key ID corresponding to the AWS Secret Access Key you used to sign the request. Default: None Type: String AWSAccessKeyId ConditionalThe date and time at which the request signature expires, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard. Condition: Requests must include either Timestamp or Expires, but not both. Default: None Type: String Expires API Version 2012-09-17 185 Amazon Relational Database Service API Reference RequiredDescriptionParameter Name The temporary security token obtained through a call to AWS Security Token Service. For a list of services that support AWS Security Token Service, go to Using Temporary Security Credentials to Access AWS in Using Temporary Security Credentials. Default: None Type: String SecurityToken YesThe digital signature you created for the request. Refer to the service©s developer documentation for information about how to generate the signature. Default: None Type: String Signature YesThe hash algorithm you used to create the request signature. Default: None Valid Values: HmacSHA256 | HmacSHA1. Type: String SignatureMethod YesThe signature version you use to sign the request. Set this to the value recommended in your product-specific documentation on security. Default: None Type: String SignatureVersion ConditionalThe date and time the request was signed, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard. Condition: Requests must include either Timestamp or Expires, but not both. Default: None Type: String Timestamp YesThe API version to use, in the format YYYY-MM-DD. Default: None Type: String Version API Version 2012-09-17 186 Amazon Relational Database Service API Reference Common Errors This section lists the common errors that all actions return. Any action-specific errors are listed in the topic for the action. HTTP Status Code DescriptionError 400The request signature does not conform to AWS standards. IncompleteSignature 500The request processing has failed due to some unknown error, exception or failure. InternalFailure 400The action or operation requested is invalid.InvalidAction 403The X.509 certificate or AWS Access Key ID provided does not exist in our records. InvalidClientTokenId 400Parameters that must not be used together were used together. InvalidParameterCombination 400A bad or out-of-range value was supplied for the input parameter. InvalidParameterValue 400AWS query string is malformed, does not adhere to AWS standards. InvalidQueryParameter 404The query string is malformed.MalformedQueryString 400The request is missing an action or operation parameter. MissingAction 403Request must contain either a valid (registered) AWS Access Key ID or X.509 certificate. MissingAuthenticationToken 400An input parameter that is mandatory for processing the request is not supplied. MissingParameter API Version 2012-09-17 187 Amazon Relational Database Service API Reference HTTP Status Code DescriptionError 403The AWS Access Key ID needs a subscription for the service. OptInRequired 400Request is past expires date or the request date (either with 15 minute padding), or the request date occurs more than 15 minutes in the future. RequestExpired 503The request has failed due to a temporary failure of the server. ServiceUnavailable 400Request was denied due to request throttling.Throttling API Version 2012-09-17 188 Amazon Relational Database Service API Reference
还剩191页未读

继续阅读

下载pdf到电脑,查找使用更方便

pdf的实际排版效果,会与网站的显示效果略有不同!!

需要 6 金币 [ 分享pdf获得金币 ] 0 人已下载

下载pdf