9373 lines
767 KiB
JSON
9373 lines
767 KiB
JSON
{
|
|
"api_version": "2013-01-10",
|
|
"type": "query",
|
|
"result_wrapped": true,
|
|
"signature_version": "v2",
|
|
"service_full_name": "Amazon Relational Database Service",
|
|
"service_abbreviation": "Amazon RDS",
|
|
"endpoint_prefix": "rds",
|
|
"xmlnamespace": "http://rds.amazonaws.com/doc/2013-01-10/",
|
|
"documentation": " \n <fullname>Amazon Relational Database Service</fullname>\n <p> \n Amazon Relational Database Service (Amazon RDS) is a web service\n that makes it easier to set up, operate, and scale a relational\n database in the cloud. It provides cost-efficient, resizable\n capacity for an industry-standard relational database and manages\n common database administration tasks, freeing up developers to focus\n on what makes their applications and businesses unique.\n </p>\n <p>\n Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle \n database server. This means the code, applications, and tools you\n already use today with your existing MySQL or Oracle databases work with Amazon\n RDS without modification. Amazon RDS automatically backs up your database\n and maintains the database software that powers your DB Instance. Amazon\n RDS is flexible: you can scale your database instance's compute resources\n and storage capacity to meet your application's demand. As with all\n Amazon Web Services, there are no up-front investments, and you pay\n only for the resources you use.\n </p>\n \n <p>\n This is the <i>Amazon RDS API Reference</i>. It contains a comprehensive description \n of all Amazon RDS Query APIs and data types. Note that this API is asynchronous and some\n actions may require polling to determine when an action has been applied. See the parameter description to determine if \n a change is applied immediately or on the next instance reboot or during the maintenance window. To get started with Amazon RDS, \n go to the \n <a href=\"http://docs.amazonwebservices.com/AmazonRDS/latest/GettingStartedGuide/\">Amazon RDS Getting Started Guide</a>. \n For more information on Amazon RDS concepts and usage scenarios, go to the \n <a href=\"http://docs.amazonwebservices.com/AmazonRDS/latest/UserGuide/\">Amazon RDS User Guide</a>.\n </p>\n ",
|
|
"operations": {
|
|
"AddSourceIdentifierToSubscription": {
|
|
"name": "AddSourceIdentifierToSubscription",
|
|
"input": {
|
|
"shape_name": "AddSourceIdentifierToSubscriptionMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubscriptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the RDS event notification subscription you want to add a source identifier to.</p>\n ",
|
|
"required": true
|
|
},
|
|
"SourceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The identifier of the event source to be added. An identifier must begin with a letter and must contain only \n ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.\n </p>\n \n <p>Constraints:</p>\n <ul>\n <li>If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.</li>\n <li>If the source type is a DB security group, a DBSecurityGroupName must be supplied.</li>\n <li>If the source type is a DB parameter group, a DBParameterGroupName must be supplied.</li>\n <li>If the source type is a DB Snapshot, a DBSnapshotIdentifier must be supplied.</li>\n </ul>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": " \n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EventSubscriptionWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"EventSubscription": {
|
|
"shape_name": "EventSubscription",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>Not used.</p> \n "
|
|
},
|
|
"CustomerAwsId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The AWS customer account associated with the RDS event notification subscription.</p>\n "
|
|
},
|
|
"CustSubscriptionId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The RDS event notification subscription Id.</p>\n "
|
|
},
|
|
"SnsTopicArn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The topic ARN of the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The status of the RDS event notification subscription.</p>\n <p>Constraints:</p>\n <p>Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist</p>\n <p>The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.</p>\n "
|
|
},
|
|
"SubscriptionCreationTime": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The time the RDS event notification subscription was created.</p>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The source type for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"SourceIdsList": {
|
|
"shape_name": "SourceIdsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SourceId"
|
|
},
|
|
"documentation": "\n <p>A list of source Ids for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"EventCategoriesList": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>A list of event categories for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Enabled": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.</p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>Contains the results of a successful invocation of the <a>DescribeEventSubscriptions</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "SubscriptionNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The subscription name does not exist.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SourceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The requested source could not be found.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>Adds a source identifier to an existing RDS event notification subscription.</p>\n <examples>\n <queryrequest>https://rds.us-east-1.amazonaws.com/\n ?Action=AddSourceIdentifierToSubscription\n ?SubscriptionName=EventSubscription01\n &SourceIdentifier=dbinstance01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T011410Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature>\n </queryrequest>\n \n <queryresponse>\n<AddSourceIdentifierToSubscriptionResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <AddSourceIdentifierToSubscriptionResult>\n <EventSubscription>\n <Enabled>true</Enabled>\n <CustomerAwsId>012345678901</CustomerAwsId>\n <SourceType>db-instance</SourceType>\n <Status>modifying</Status>\n <SourceIdsList>\n <SourceId>dbinstance01</SourceId>\n </SourceIdsList>\n <SubscriptionCreationTime>2013-01-28 00:29:23.736</SubscriptionCreationTime>\n <EventCategoriesList>\n <EventCategory>creation</EventCategory>\n <EventCategory>deletion</EventCategory>\n </EventCategoriesList>\n <CustSubscriptionId>EventSubscription01</CustSubscriptionId>\n <SnsTopicArn>arn:aws:sns:us-east-1:012345678901:EventSubscription01</SnsTopicArn>\n </EventSubscription>\n </AddSourceIdentifierToSubscriptionResult>\n <ResponseMetadata>\n <RequestId>05d0fd8a-68e8-11e2-8e4d-31f087d822e1</RequestId>\n </ResponseMetadata>\n</AddSourceIdentifierToSubscriptionResponse>\n </queryresponse> \n \n </examples>\n "
|
|
},
|
|
"AddTagsToResource": {
|
|
"name": "AddTagsToResource",
|
|
"input": {
|
|
"shape_name": "AddTagsToResourceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"ResourceName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The DB Instance the tags will be added to.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Tags": {
|
|
"shape_name": "TagList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Tag",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>\n "
|
|
},
|
|
"Value": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Metadata assigned to a DB Instance consisting of a key-value pair.</p>\n ",
|
|
"xmlname": "Tag"
|
|
},
|
|
"documentation": "\n <p>The tags to be assigned to the DB Instance.</p> \n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p></p>\n "
|
|
},
|
|
"output": null,
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSnapshotNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> does not refer to an existing DB Snapshot.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p> 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.</p>\n <p>For an overview on tagging DB Instances, see <a href=\"http://docs.amazonwebservices.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html\">DB Instance Tags.</a></p>\n "
|
|
},
|
|
"AuthorizeDBSecurityGroupIngress": {
|
|
"name": "AuthorizeDBSecurityGroupIngress",
|
|
"input": {
|
|
"shape_name": "AuthorizeDBSecurityGroupIngressMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group to add authorization to.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"CIDRIP": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The IP range to authorize.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Name of the EC2 Security Group to authorize.\n For VPC DB Security Groups, <code>EC2SecurityGroupId</code> must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Id of the EC2 Security Group to authorize.\n For VPC DB Security Groups, <code>EC2SecurityGroupId</code> must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupOwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n AWS Account Number of the owner of the EC2 Security Group\n specified in the EC2SecurityGroupName parameter.\n The AWS Access Key ID is not an acceptable value.\n For VPC DB Security Groups, <code>EC2SecurityGroupId</code> must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSecurityGroupWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroup": {
|
|
"shape_name": "DBSecurityGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"OwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the AWS ID of the owner of a specific DB Security Group.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Security Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroups": {
|
|
"shape_name": "EC2SecurityGroupList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "EC2SecurityGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the EC2 security group. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the EC2 Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the id of the EC2 Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupOwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the <code>EC2SecurityGroupName</code> field.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>AuthorizeDBSecurityGroupIngress</a></li>\n <li><a>DescribeDBSecurityGroups</a></li> \n <li><a>RevokeDBSecurityGroupIngress</a></li> \n </ul>\n ",
|
|
"xmlname": "EC2SecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>EC2SecurityGroup</a> elements.\n </p>\n "
|
|
},
|
|
"IPRanges": {
|
|
"shape_name": "IPRangeList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "IPRange",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the IP range. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n </p>\n "
|
|
},
|
|
"CIDRIP": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the IP range.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSecurityGroups</a> action.\n </p>\n ",
|
|
"xmlname": "IPRange"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>IPRange</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>DescribeDBSecurityGroups</a></li>\n <li><a>AuthorizeDBSecurityGroupIngress</a></li>\n <li><a>CreateDBSecurityGroup</a></li>\n <li><a>RevokeDBSecurityGroupIngress</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSecurityGroups</a> action.</p>\n \n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSecurityGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSecurityGroupName</i> does not refer to an existing DB Security Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBSecurityGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The state of the DB Security Group does not allow deletion.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AuthorizationAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AuthorizationQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Database security group authorization quota has been reached.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Enables ingress to a DBSecurityGroup using one of two forms of authorization. First,\n EC2 or VPC Security Groups can be added to the DBSecurityGroup if the application using the database\n is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your\n database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or\n (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).\n </p>\n <note>\n You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB Instance in another.\n You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB Instance in another.\n </note>\n <p>For an overview of CIDR ranges, go to the \n <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?CIDRIP=192.168.1.1%2F24\n &DBSecurityGroupName=mydbsecuritygroup\n &Version=2013-01-10\n &Action=AuthorizeDBSecurityGroupIngress\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A10%3A50.274Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><AuthorizeDBSecurityGroupIngressResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <AuthorizeDBSecurityGroupIngressResult>\n <DBSecurityGroup>\n <EC2SecurityGroups/>\n <DBSecurityGroupDescription>My new DBSecurityGroup</DBSecurityGroupDescription>\n <IPRanges>\n <IPRange>\n <CIDRIP>192.168.1.1/24</CIDRIP>\n <Status>authorizing</Status>\n </IPRange>\n </IPRanges>\n <OwnerId>621567473609</OwnerId>\n <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>\n <VpcId>vpc-1ab2c3d4</VpcId>\n </DBSecurityGroup>\n </AuthorizeDBSecurityGroupIngressResult>\n <ResponseMetadata>\n <RequestId>d9799197-bf2d-11de-b88d-993294bf1c81</RequestId>\n </ResponseMetadata>\n</AuthorizeDBSecurityGroupIngressResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"CopyDBSnapshot": {
|
|
"name": "CopyDBSnapshot",
|
|
"input": {
|
|
"shape_name": "CopyDBSnapshotMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SourceDBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The identifier for the source DB snapshot.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be the identifier for a valid system snapshot in the \"available\" state.</li>\n </ul>\n <p>Example: <code>rds:mydb-2012-04-02-00-01</code></p>\n ",
|
|
"required": true
|
|
},
|
|
"TargetDBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The identifier for the copied snapshot.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Cannot be null, empty, or blank</li>\n <li>Must contain from 1 to 255 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n <p>Example: <code>my-db-snapshot</code></p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSnapshotWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshot": {
|
|
"shape_name": "DBSnapshot",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier for the DB Snapshot.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the the DBInstanceIdentifier of the DB Instance\n this DB Snapshot was created from.\n </p>\n "
|
|
},
|
|
"SnapshotCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the time (UTC) when the snapshot was taken.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the database engine.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size in gigabytes (GB).\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of this DB Snapshot.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine was\n listening on at the time of the snapshot.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB\n Instance was located in at the time of the DB Snapshot.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the Vpc Id associated with the DB Snapshot.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the time (UTC) when the snapshot was taken.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the version of the database engine.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for the restored DB Instance.\n </p>\n "
|
|
},
|
|
"SnapshotType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the type of the DB Snapshot.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBSnapshot</a></li>\n <li><a>DeleteDBSnapshot</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSnapshots</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSnapshotAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> is already used by an existing snapshot.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSnapshotNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> does not refer to an existing DB Snapshot.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBSnapshotStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The state of the DB Security Snapshot does not allow deletion.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SnapshotQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Snapshots.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=CopyDBSnapshot\n &SourceDBSnapshotIdentifier=rds:simcoprod01-2012-04-02-00-01\n &TargetDBSnapshotIdentifier=mydbsnapshot\n &Version=2013-01-10\n &SignatureVersion=2&SignatureMethod=HmacSHA256\n &Timestamp=2011-12-12T06%3A27%3A42.551Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><CopyDBSnapshotResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CopyDBSnapshotResult>\n <DBSnapshot>\n <Port>3306</Port>\n <Engine>mysql</Engine>\n <Status>available</Status>\n <AvailabilityZone>us-east-1a</AvailabilityZone>\n <LicenseModel>general-public-license</LicenseModel>\n <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <EngineVersion>5.1.50</EngineVersion>\n <DBSnapshotIdentifier>mydbsnapshot</DBSnapshotIdentifier>\n <SnapshotType>manual</SnapshotType>\n <MasterUsername>master</MasterUsername>\n </DBSnapshot>\n </CopyDBSnapshotResult>\n <ResponseMetadata>\n <RequestId>c4181d1d-8505-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</CopyDBSnapshotResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"CreateDBInstance": {
|
|
"name": "CreateDBInstance",
|
|
"input": {
|
|
"shape_name": "CreateDBInstanceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter\n differs according to the database\n engine you use.</p>\n <p><b>MySQL</b></p>\n <p>The name of the database to create when the DB Instance\n is created. If this parameter is not specified,\n no database is created in the DB Instance.\n </p> \n <p>Constraints:</p>\n <ul>\n <li>Must contain 1 to 64 alphanumeric characters</li>\n <li>Cannot be a word reserved by the specified database engine</li>\n </ul>\n <p>Type: String</p>\n \n <p><b>Oracle</b></p>\n <p>\n The Oracle System ID (SID) of the created DB Instance. \n </p>\n \n <p>Default: <code>ORCL</code></p>\n \n <p>Constraints:</p>\n <ul>\n <li>Cannot be longer than 8 characters</li>\n </ul>\n\n <p><b>SQL Server</b></p>\n <p>Not applicable. Must be null.</p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance identifier.\n This parameter is stored as a lowercase string.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).</li>\n <li>First character must be a letter.</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens.</li>\n </ul>\n <p>Example: <code>mydbinstance</code></p>\n ",
|
|
"required": true
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The amount of storage (in gigabytes) to be initially allocated for the\n database instance. \n </p>\n <p><b>MySQL</b></p>\n <p> Constraints: Must be an integer from 5 to 1024.</p>\n <p> Type: Integer</p>\n <p><b>Oracle</b></p>\n <p> Constraints: Must be an integer from 10 to 1024.</p>\n <p><b>SQL Server</b></p>\n <p> Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or \n from 30 to 1024 (Express Edition and Web Edition)</p>\n ",
|
|
"required": true
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The compute and memory capacity of the DB Instance.\n </p>\n <p>\n Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge</code>\n </p>\n \n ",
|
|
"required": true
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the database engine to be used for this instance.\n </p>\n <p>\n Valid Values: <code>MySQL</code> | <code>oracle-se1</code> | <code>oracle-se</code> | <code>oracle-ee</code> | <code>sqlserver-ee</code> | \n <code>sqlserver-se</code> | <code>sqlserver-ex</code> | <code>sqlserver-web</code>\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of master user for the client DB Instance.\n </p>\n <p><b>MySQL</b></p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 16 alphanumeric characters.</li>\n <li>First character must be a letter.</li>\n <li>Cannot be a reserved word for the chosen database engine.</li>\n </ul>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 30 alphanumeric characters.</li>\n <li>First character must be a letter.</li>\n <li>Cannot be a reserved word for the chosen database engine.</li>\n </ul>\n <p><b>SQL Server</b></p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 128 alphanumeric characters.</li>\n <li>First character must be a letter.</li>\n <li>Cannot be a reserved word for the chosen database engine.</li>\n </ul>\n\n \n ",
|
|
"required": true
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The password for the master database user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".\n </p>\n <p>Type: String</p>\n <p><b>MySQL</b></p>\n <p>\n Constraints: Must contain from 8 to 41 alphanumeric characters. \n </p>\n \n <p><b>Oracle</b></p>\n <p>\n Constraints: Must contain from 8 to 30 alphanumeric characters. \n </p>\n <p><b>SQL Server</b></p>\n <p>\n Constraints: Must contain from 8 to 128 alphanumeric characters.\n </p>\n \n ",
|
|
"required": true
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupNameList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "DBSecurityGroupName"
|
|
},
|
|
"documentation": "\n <p>\n A list of DB Security Groups to associate\n with this DB Instance.\n </p>\n <p>\n Default: The default DB Security Group for the database engine.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroupIds": {
|
|
"shape_name": "VpcSecurityGroupIdList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "VpcSecurityGroupId"
|
|
},
|
|
"documentation": "\n <p>\n A list of EC2 VPC Security Groups to associate\n with this DB Instance.\n </p>\n <p>\n Default: The default EC2 VPC Security Group for the DB Subnet group's\n VPC.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The EC2 Availability Zone that the database instance will be created in.\n </p>\n <p>\n Default: A random, system-chosen Availability Zone in the endpoint's region.\n </p>\n <p>\n Example: <code>us-east-1d</code>\n </p>\n <p>\n Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to <code>true</code>. \n The specified Availability Zone must be in the same region as the current endpoint.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n A DB Subnet Group to associate with this DB Instance.\n </p>\n <p>\n If there is no DB Subnet Group, then it is a non-VPC DB instance.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The weekly time range (in UTC) during which system maintenance can occur.\n </p>\n <p>\n Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>\n </p>\n <p>\n Default: A 30-minute window selected at random from an\n 8-hour block of time per region, occurring on a random day of the\n week. The following list shows the time blocks for each region \n from which the default maintenance windows are assigned.\n </p>\n <ul>\n <li>\n<b>US-East (Northern Virginia) Region:</b> 03:00-11:00 UTC</li>\n <li>\n<b>US-West (Northern California) Region:</b> 06:00-14:00 UTC</li>\n <li>\n<b>EU (Ireland) Region:</b> 22:00-06:00 UTC</li>\n <li>\n<b>Asia Pacific (Singapore) Region:</b> 14:00-22:00 UTC</li>\n <li>\n<b>Asia Pacific (Tokyo) Region: </b> 17:00-03:00 UTC</li>\n </ul>\n <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>\n <p>Constraints: Minimum 30-minute window.</p>\n "
|
|
},
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group to associate\n with this DB instance. If this argument is omitted, the default\n DBParameterGroup for the specified engine will be used.\n </p>\n <p>\n Constraints:\n </p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The number of days for which automated backups are retained.\n Setting this parameter to a positive number enables backups.\n Setting this parameter to 0 disables automated backups.\n </p>\n <p>\n Default: 1\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be a value from 0 to 8</li>\n <li>Cannot be set to 0 if the DB Instance is a master instance with read replicas</li>\n </ul>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the <code>BackupRetentionPeriod</code> parameter.\n </p>\n <p>\n Default: A 30-minute window selected at random from an\n 8-hour block of time per region. The following list shows \n the time blocks for each region from which the default \n backup windows are assigned.\n </p>\n <ul>\n <li>\n<b>US-East (Northern Virginia) Region:</b> 03:00-11:00 UTC</li>\n <li>\n<b>US-West (Northern California) Region:</b> 06:00-14:00 UTC</li>\n <li>\n<b>EU (Ireland) Region:</b> 22:00-06:00 UTC</li>\n <li>\n<b>Asia Pacific (Singapore) Region:</b> 14:00-22:00 UTC</li>\n <li>\n<b>Asia Pacific (Tokyo) Region: </b> 17:00-03:00 UTC</li>\n </ul>\n\n <p>\n Constraints: Must be in the format <code>hh24:mi-hh24:mi</code>. \n Times should be Universal Time Coordinated (UTC). \n Must not conflict with the preferred maintenance window. Must be at least 30 minutes.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The port number on which the database accepts connections.\n </p>\n <p><b>MySQL</b></p>\n <p>\n Default: <code>3306</code>\n </p>\n <p>\n Valid Values: <code>1150-65535</code>\n </p>\n <p>Type: Integer </p>\n \n <p><b>Oracle</b></p>\n <p>\n Default: <code>1521</code>\n </p> \n <p>\n Valid Values: <code>1150-65535</code>\n </p>\n <p><b>SQL Server</b></p>\n <p>\n Default: <code>1433</code>\n </p>\n <p>\n Valid Values: <code>1150-65535</code> except for <code>1434</code> and <code>3389</code>.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment. \n You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. \n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The version number of the database engine to use.\n </p>\n <p><b>MySQL</b></p>\n <p>Example: <code>5.1.42</code></p> \n <p>Type: String</p>\n \n <p><b>Oracle</b></p>\n <p>Example: <code>11.2.0.2.v2</code></p>\n <p>Type: String</p>\n \n <p><b>SQL Server</b></p>\n <p>Example: <code>10.50.2789.0.v1</code></p>\n \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor engine upgrades will be applied\n automatically to the DB Instance during the maintenance window.\n </p>\n <p>Default: <code>true</code></p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n <p>\n Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code>\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the\n DB Instance. \n </p>\n <p> Constraints: Must be an integer greater than 1000.</p>\n \n "
|
|
},
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates that the DB Instance should be associated with the specified option group.\n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstance": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n User already has a DB Instance with the given identifier.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InsufficientDBInstanceCapacityFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Specified DB Instance class is not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBParameterGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBParameterGroupName</i> does not refer to an\n existing DB Parameter Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSecurityGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSecurityGroupName</i> does not refer to an existing DB Security Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InstanceQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "StorageQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the\n allowed amount of storage available across all DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSubnetGroupName</i> does not refer to an existing DB Subnet Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Subnets in the DB subnet group should cover at least 2 availability zones unless there's'only 1 available zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidSubnet",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request subnet is valid, or all subnets are not in common Vpc. \n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidVPCNetworkStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n DB Subnet Group does not cover all availability zones after it is created because users' change.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ProvisionedIopsNotAvailableInAZFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Provisioned IOPS not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "OptionGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The specified option group could not be found. \n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Creates a new DB instance.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=CreateDBInstance\n &DBInstanceIdentifier=SimCoProd01\n &Engine=mysql\n &MasterUserPassword=Password01\n &AllocatedStorage=10\n &MasterUsername=master\n &Version=2013-01-10\n &DBInstanceClass=db.m1.large\n &DBSubnetGroupName=dbSubnetgroup01\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T05%3A54%3A53.578Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><CreateDBInstanceResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateDBInstanceResult>\n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <Engine>mysql</Engine>\n <PendingModifiedValues>\n <MasterUserPassword>****</MasterUserPassword>\n </PendingModifiedValues>\n <BackupRetentionPeriod>1</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBSubnetGroup>\n <VpcId>990524496922</VpcId>\n <SubnetGroupStatus>Complete</SubnetGroupStatus>\n <DBSubnetGroupDescription>description</DBSubnetGroupDescription>\n <DBSubnetGroupName>subnet_grp1</DBSubnetGroupName>\n <Subnets>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1c</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1b</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1d</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n </Subnets>\n </DBSubnetGroup> \n <DBInstanceStatus>creating</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </CreateDBInstanceResult>\n <ResponseMetadata>\n <RequestId>2e5d4270-8501-11e0-bd9b-a7b1ece36d51</RequestId>\n </ResponseMetadata>\n</CreateDBInstanceResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"CreateDBInstanceReadReplica": {
|
|
"name": "CreateDBInstanceReadReplica",
|
|
"input": {
|
|
"shape_name": "CreateDBInstanceReadReplicaMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance identifier of the Read Replica.\n This is the unique key that identifies a DB Instance.\n This parameter is stored as a lowercase string.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"SourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The identifier of the DB Instance that will act as the source for the Read Replica.\n Each DB Instance can have up to five Read Replicas.\n </p>\n <p>Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance. </p>\n ",
|
|
"required": true
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The compute and memory capacity of the Read Replica.\n </p>\n <p>\n Valid Values: <code>db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge</code>\n </p>\n <p>Default: Inherits from the source DB Instance.</p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The Amazon EC2 Availability Zone that the Read Replica will be created in.\n </p>\n <p>\n Default: A random, system-chosen Availability Zone in the endpoint's region.\n </p>\n <p>\n Example: <code>us-east-1d</code>\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The port number that the DB Instance uses for connections.\n </p>\n <p>Default: Inherits from the source DB Instance</p>\n <p>Valid Values: <code>1150-65535</code></p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor engine upgrades will be applied automatically\n to the Read Replica during the maintenance window.\n </p>\n <p>Default: Inherits from the source DB Instance</p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The amount of Provisioned IOPS (input/output operations per second) to be initially \n allocated for the DB Instance. \n </p>\n "
|
|
},
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The option group the DB instance will be associated with. If omitted, the default Option Group\n for the engine specified will be used.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstance": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n User already has a DB Instance with the given identifier.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InsufficientDBInstanceCapacityFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Specified DB Instance class is not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBParameterGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBParameterGroupName</i> does not refer to an\n existing DB Parameter Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSecurityGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSecurityGroupName</i> does not refer to an existing DB Security Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InstanceQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "StorageQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the\n allowed amount of storage available across all DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBInstanceStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified DB Instance is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSubnetGroupName</i> does not refer to an existing DB Subnet Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Subnets in the DB subnet group should cover at least 2 availability zones unless there's'only 1 available zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidSubnet",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request subnet is valid, or all subnets are not in common Vpc. \n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidVPCNetworkStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n DB Subnet Group does not cover all availability zones after it is created because users' change.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ProvisionedIopsNotAvailableInAZFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Provisioned IOPS not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "OptionGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The specified option group could not be found. \n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Creates a DB Instance that acts as a Read Replica of a source DB Instance.\n </p>\n <p>\n All Read Replica DB Instances are created as Single-AZ deployments with backups disabled.\n All other DB Instance attributes (including DB Security Groups and DB Parameter Groups)\n are inherited from the source DB Instance, except as specified below.\n </p>\n <important>\n <p>\n The source DB Instance must have backup retention enabled.\n </p>\n </important>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=CreateDBInstanceReadReplica\n &DBInstanceIdentifier=myreadreplica\n &SourceDBInstanceIdentifier=mydbinstance\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-15T23%3A35%3A07.325Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><CreateDBInstanceReadReplicaResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateDBInstanceReadReplicaResult>\n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <Engine>mysql</Engine>\n <PendingModifiedValues/>\n <BackupRetentionPeriod>0</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBInstanceStatus>creating</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <DBInstanceIdentifier>myreadreplica</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <ReadReplicaSourceDBInstanceIdentifier>mydbinstance</ReadReplicaSourceDBInstanceIdentifier>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>23:00-01:00</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sun:05:00-sun:09:00</PreferredMaintenanceWindow>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.small</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </CreateDBInstanceReadReplicaResult>\n <ResponseMetadata>\n <RequestId>3e24c5cd-c6e2-11df-8463-4f0c49644cb7</RequestId>\n </ResponseMetadata>\n</CreateDBInstanceReadReplicaResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"CreateDBParameterGroup": {
|
|
"name": "CreateDBParameterGroup",
|
|
"input": {
|
|
"shape_name": "CreateDBParameterGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group.\n </p>\n <p>\n Constraints:\n </p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n <note>This value is stored as a lower-case string.</note>\n ",
|
|
"required": true
|
|
},
|
|
"DBParameterGroupFamily": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Parameter Group Family name. A DB Parameter Group can be \n associated with one and only one DB Parameter Group Family, and \n can be applied only to a DB Instance running a database engine and engine version \n compatible with that DB Parameter Group Family.\n </p>\n\n ",
|
|
"required": true
|
|
},
|
|
"Description": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description for the DB Parameter Group.\n </p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBParameterGroupWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroup": {
|
|
"shape_name": "DBParameterGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the DB Parameter Group.\n </p>\n "
|
|
},
|
|
"DBParameterGroupFamily": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the DB Parameter Group Family that\n this DB Parameter Group is compatible with.\n </p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the customer-specified description for this DB Parameter Group.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>CreateDBParameterGroup</a> action.\n </p>\n <p>\n This data type is used as a request parameter in the <a>DeleteDBParameterGroup</a> action,\n and as a response element in the <a>DescribeDBParameterGroups</a> action.\n </p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBParameterGroupQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed\n number of DB Parameter Groups.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBParameterGroupAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n A DB Parameter Group with the same name exists.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Creates a new DB Parameter Group.\n </p>\n <p>\n A DB Parameter Group is initially created with the default parameters for the\n database engine used by the DB Instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n <i>ModifyDBParameterGroup</i>. Once you've created a DB Parameter Group, you need to\n associate it with your DB Instance using <i>ModifyDBInstance</i>. When you associate\n a new DB Parameter Group with a running DB Instance, you need to reboot the DB\n Instance for the new DB Parameter Group and associated settings to take effect. \n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=CreateDBParameterGroup\n &DBParameterGroupName=mydbparametergroup3\n &DBParameterGroupFamily=MySQL5.1\n &Version=2013-01-10\n &Description=My%20new%20DBParameterGroup\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-11T18%3A09%3A29.793Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><CreateDBParameterGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateDBParameterGroupResult>\n <DBParameterGroup>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Description>My new DBParameterGroup</Description>\n <DBParameterGroupName>mydbparametergroup3</DBParameterGroupName>\n </DBParameterGroup>\n </CreateDBParameterGroupResult>\n <ResponseMetadata>\n <RequestId>0b447b66-bf36-11de-a88b-7b5b3d23b3a7</RequestId>\n </ResponseMetadata>\n</CreateDBParameterGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"CreateDBSecurityGroup": {
|
|
"name": "CreateDBSecurityGroup",
|
|
"input": {
|
|
"shape_name": "CreateDBSecurityGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name for the DB Security Group.\n This value is stored as a lowercase string.\n </p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".</p>\n \n <p>Example: <code>mysecuritygroup</code></p>\n ",
|
|
"required": true
|
|
},
|
|
"DBSecurityGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description for the DB Security Group.\n </p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSecurityGroupWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroup": {
|
|
"shape_name": "DBSecurityGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"OwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the AWS ID of the owner of a specific DB Security Group.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Security Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroups": {
|
|
"shape_name": "EC2SecurityGroupList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "EC2SecurityGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the EC2 security group. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the EC2 Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the id of the EC2 Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupOwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the <code>EC2SecurityGroupName</code> field.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>AuthorizeDBSecurityGroupIngress</a></li>\n <li><a>DescribeDBSecurityGroups</a></li> \n <li><a>RevokeDBSecurityGroupIngress</a></li> \n </ul>\n ",
|
|
"xmlname": "EC2SecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>EC2SecurityGroup</a> elements.\n </p>\n "
|
|
},
|
|
"IPRanges": {
|
|
"shape_name": "IPRangeList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "IPRange",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the IP range. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n </p>\n "
|
|
},
|
|
"CIDRIP": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the IP range.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSecurityGroups</a> action.\n </p>\n ",
|
|
"xmlname": "IPRange"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>IPRange</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>DescribeDBSecurityGroups</a></li>\n <li><a>AuthorizeDBSecurityGroupIngress</a></li>\n <li><a>CreateDBSecurityGroup</a></li>\n <li><a>RevokeDBSecurityGroupIngress</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSecurityGroups</a> action.</p>\n \n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSecurityGroupAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n A database security group with the name specified in\n <i>DBSecurityGroupName</i> already exists.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSecurityGroupQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Security Groups.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSecurityGroupNotSupportedFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n A DB security group is not allowed for this action.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Creates a new DB Security Group. DB Security Groups control access to a DB Instance.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=CreateDBSecurityGroup\n &DBSecurityGroupName=mydbsecuritygroup\n &DBSecurityGroupDescription=My%20new%20DBSecurityGroup\n &EC2VpcId=vpc-1a2b3c4d\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T18%3A14%3A49.482Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><CreateDBSecurityGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateDBSecurityGroupResult>\n <DBSecurityGroup>\n <EC2SecurityGroups/>\n <DBSecurityGroupDescription>My new DBSecurityGroup</DBSecurityGroupDescription>\n <IPRanges/>\n <OwnerId>565419523791</OwnerId>\n <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>\n <VpcId>vpc-1a2b3c4d</VpcId>\n </DBSecurityGroup>\n </CreateDBSecurityGroupResult>\n <ResponseMetadata>\n <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>\n </ResponseMetadata>\n</CreateDBSecurityGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"CreateDBSnapshot": {
|
|
"name": "CreateDBSnapshot",
|
|
"input": {
|
|
"shape_name": "CreateDBSnapshotMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The identifier for the DB Snapshot.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Cannot be null, empty, or blank</li>\n <li>Must contain from 1 to 255 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n <p>Example: <code>my-snapshot-id</code></p>\n ",
|
|
"required": true
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance identifier. This is the unique key\n that identifies a DB Instance. This parameter isn't case sensitive.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSnapshotWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshot": {
|
|
"shape_name": "DBSnapshot",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier for the DB Snapshot.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the the DBInstanceIdentifier of the DB Instance\n this DB Snapshot was created from.\n </p>\n "
|
|
},
|
|
"SnapshotCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the time (UTC) when the snapshot was taken.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the database engine.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size in gigabytes (GB).\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of this DB Snapshot.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine was\n listening on at the time of the snapshot.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB\n Instance was located in at the time of the DB Snapshot.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the Vpc Id associated with the DB Snapshot.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the time (UTC) when the snapshot was taken.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the version of the database engine.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for the restored DB Instance.\n </p>\n "
|
|
},
|
|
"SnapshotType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the type of the DB Snapshot.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBSnapshot</a></li>\n <li><a>DeleteDBSnapshot</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSnapshots</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSnapshotAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> is already used by an existing snapshot.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBInstanceStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified DB Instance is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SnapshotQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Snapshots.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Creates a DBSnapshot. The source DBInstance must be in \"available\" state.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=CreateDBSnapshot\n &DBInstanceIdentifier=simcoprod01\n &DBSnapshotIdentifier=mydbsnapshot\n &Version=2013-01-10\n &SignatureVersion=2&SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T06%3A27%3A42.551Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><CreateDBSnapshotResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateDBSnapshotResult>\n <DBSnapshot>\n <Port>3306</Port>\n <Engine>mysql</Engine>\n <Status>creating</Status>\n <AvailabilityZone>us-east-1a</AvailabilityZone>\n <LicenseModel>general-public-license</LicenseModel>\n <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <EngineVersion>5.1.50</EngineVersion>\n <DBSnapshotIdentifier>mydbsnapshot</DBSnapshotIdentifier>\n <SnapshotType>manual</SnapshotType>\n <MasterUsername>master</MasterUsername>\n </DBSnapshot>\n </CreateDBSnapshotResult>\n <ResponseMetadata>\n <RequestId>c4181d1d-8505-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</CreateDBSnapshotResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"CreateDBSubnetGroup": {
|
|
"name": "CreateDBSubnetGroup",
|
|
"input": {
|
|
"shape_name": "CreateDBSubnetGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name for the DB Subnet Group.\n This value is stored as a lowercase string.\n </p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".</p>\n \n <p>Example: <code>mySubnetgroup</code></p>\n ",
|
|
"required": true
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description for the DB Subnet Group.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"SubnetIds": {
|
|
"shape_name": "SubnetIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SubnetIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n The EC2 Subnet IDs for the DB Subnet Group.\n </p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSubnetGroupWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBSubnetGroup</a></li>\n <li><a>ModifyDBSubnetGroup</a></li>\n <li><a>DescribeDBSubnetGroups</a></li>\n <li><a>DeleteDBSubnetGroup</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSubnetGroupAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSubnetGroupName</i> is already used by an existing DBSubnetGroup.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Subnet Groups.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of subnets in a DB subnet Groups.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Subnets in the DB subnet group should cover at least 2 availability zones unless there's'only 1 available zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidSubnet",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request subnet is valid, or all subnets are not in common Vpc. \n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=CreateDBSubnetGroup\n &DBSubnetGroupName=mydbsubnetgroup\n &DBSubnetGroupDescription=My%20new%20DBSubnetGroup\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T18%3A14%3A49.482Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><CreateDBSubnetGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateDBSubnetGroupResult>\n <DBSubnetGroup>\n <VpcId>990524496922</VpcId>\n <SubnetGroupStatus>Complete</SubnetGroupStatus>\n <DBSubnetGroupDescription>My new DBSubnetGroup</DBSubnetGroupDescription>\n <DBSubnetGroupName>mydbsubnetgroup</DBSubnetGroupName>\n <Subnets>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1c</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1b</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1d</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n </Subnets>\n </DBSubnetGroup> \n </CreateDBSubnetGroupResult>\n <ResponseMetadata>\n <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>\n </ResponseMetadata>\n </CreateDBSubnetGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"CreateEventSubscription": {
|
|
"name": "CreateEventSubscription",
|
|
"input": {
|
|
"shape_name": "CreateEventSubscriptionMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubscriptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": " \n <p>The name of the subscription. </p>\n <p>Constraints: The name must be less than 255 characters. </p>\n ",
|
|
"required": true
|
|
},
|
|
"SnsTopicArn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create \n a topic and subscribe to it.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, \n you would set this parameter to db-instance. if this value is not specified, all events are returned.\n </p>\n <p>Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot</p>\n "
|
|
},
|
|
"EventCategories": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>\n A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType \n in the <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">Events</a> topic in the Amazon RDS User Guide \n or by using the <b>DescribeEventCategories</b> action.\n </p> \n "
|
|
},
|
|
"SourceIds": {
|
|
"shape_name": "SourceIdsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SourceId"
|
|
},
|
|
"documentation": "\n <p>\n The list of identifiers of the event sources for which events will be returned. If not specified,\n then all sources are included in the response. An identifier must begin with a letter and must contain only \n ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>If SourceIds are supplied, SourceType must also be provided.</li>\n <li>If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.</li>\n <li>If the source type is a DB security group, a DBSecurityGroupName must be supplied.</li>\n <li>If the source type is a DB parameter group, a DBParameterGroupName must be supplied.</li>\n <li>If the source type is a DB Snapshot, a DBSnapshotIdentifier must be supplied.</li>\n </ul>\n "
|
|
},
|
|
"Enabled": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n A Boolean value; set to <b>true</b> to activate the subscription, set to <b>false</b> to create the subscription but not active it.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": " \n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EventSubscriptionWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"EventSubscription": {
|
|
"shape_name": "EventSubscription",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>Not used.</p> \n "
|
|
},
|
|
"CustomerAwsId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The AWS customer account associated with the RDS event notification subscription.</p>\n "
|
|
},
|
|
"CustSubscriptionId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The RDS event notification subscription Id.</p>\n "
|
|
},
|
|
"SnsTopicArn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The topic ARN of the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The status of the RDS event notification subscription.</p>\n <p>Constraints:</p>\n <p>Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist</p>\n <p>The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.</p>\n "
|
|
},
|
|
"SubscriptionCreationTime": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The time the RDS event notification subscription was created.</p>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The source type for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"SourceIdsList": {
|
|
"shape_name": "SourceIdsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SourceId"
|
|
},
|
|
"documentation": "\n <p>A list of source Ids for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"EventCategoriesList": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>A list of event categories for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Enabled": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.</p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>Contains the results of a successful invocation of the <a>DescribeEventSubscriptions</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "EventSubscriptionQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>You have reached the maximum number of event subscriptions.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SubscriptionAlreadyExistFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The supplied subscription name already exists.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SNSInvalidTopicFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>SNS has responded that there is a problem with the SND topic specified.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SNSNoAuthorizationFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>You do not have permission to publish to the SNS topic ARN.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SNSTopicArnNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The SNS topic ARN does not exist.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SubscriptionCategoryNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The supplied category does not exist.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SourceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The requested source could not be found.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>Creates an RDS event notification subscription. This action requires a topic ARN \n (Amazon Resource Name) created by either \n the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in \n Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.</p>\n <p>You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS \n sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) \n for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and \n EventCategories = Availability, Backup.</p> \n <p>If you specify both the SourceType and SourceIds, such as \n SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance \n events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, \n you will receive notice of the events for that source type for all your RDS sources. If you \n do not specify either the SourceType nor the SourceIdentifier, you will be notified of events \n generated from all RDS sources belonging to your customer account.</p>\n <examples>\n <queryrequest>https://rds.us-east-1.amazonaws.com/\n ?Action=CreateEventSubscription\n &SubscriptionName=EventSubscription02\n &Enabled=true\n &SnsTopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A012345678901%3AEventSubscription01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T002941Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature>\n </queryrequest>\n <queryresponse><CreateEventSubscriptionResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateEventSubscriptionResult>\n <EventSubscription>\n <Enabled>true</Enabled>\n <CustomerAwsId>012345678901</CustomerAwsId>\n <Status>creating</Status>\n <SubscriptionCreationTime>Mon Jan 28 00:29:42 UTC 2013</SubscriptionCreationTime>\n <CustSubscriptionId>EventSubscription02</CustSubscriptionId>\n <SnsTopicArn>arn:aws:sns:us-east-1:012345678901:EventSubscription01</SnsTopicArn>\n </EventSubscription>\n </CreateEventSubscriptionResult>\n <ResponseMetadata>\n <RequestId>cf3407aa-68e1-11e2-bd13-a92da73b3119</RequestId>\n </ResponseMetadata>\n</CreateEventSubscriptionResponse>\n </queryresponse>\n \n <queryrequest>https://rds.us-east-1.amazonaws.com/\n ?Action=CreateEventSubscription\n &SubscriptionName=EventSubscription03\n &SourceType=db-instance\n &EventCategories.member.1=creation\n &EventCategories.member.2=deletion\n &SourceIds.member.1=dbinstance01\n &SourceIds.member.2=dbinstance02\n &Enabled=true\n &SnsTopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A012345678901%3AEventSubscription01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T014117Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature>\n </queryrequest>\n <queryresponse><CreateEventSubscriptionResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n<CreateEventSubscriptionResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateEventSubscriptionResult>\n <EventSubscription>\n <Enabled>true</Enabled>\n <CustomerAwsId>012345678901</CustomerAwsId>\n <SourceType>db-instance</SourceType>\n <Status>creating</Status>\n <SourceIdsList>\n <SourceId>dbinstance01</SourceId>\n <SourceId>dbinstance02</SourceId>\n </SourceIdsList>\n <SubscriptionCreationTime>Mon Jan 28 01:41:19 UTC 2013</SubscriptionCreationTime>\n <EventCategoriesList>\n <EventCategory>creation</EventCategory>\n <EventCategory>deletion</EventCategory>\n </EventCategoriesList>\n <CustSubscriptionId>EventSubscription03</CustSubscriptionId>\n <SnsTopicArn>arn:aws:sns:us-east-1:012345678901:EventSubscription01</SnsTopicArn>\n </EventSubscription>\n </CreateEventSubscriptionResult>\n <ResponseMetadata>\n <RequestId>d064b48c-68eb-11e2-ab10-11125abcb784</RequestId>\n </ResponseMetadata>\n</CreateEventSubscriptionResponse>\n\n </queryresponse>\n \n </examples>\n "
|
|
},
|
|
"CreateOptionGroup": {
|
|
"name": "CreateOptionGroup",
|
|
"input": {
|
|
"shape_name": "CreateOptionGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the option group to be created.\n </p>\n <p>\n Constraints:\n </p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul> \n <p>Example: <code>myOptiongroup</code></p>\n \n ",
|
|
"required": true
|
|
},
|
|
"EngineName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the engine that this option group should be associated with.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"MajorEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the major version of the engine that this option group should be associated with.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"OptionGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the option group.\n </p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "OptionGroupWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroup": {
|
|
"shape_name": "OptionGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the option group.\n </p>\n "
|
|
},
|
|
"OptionGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the option group.\n </p>\n "
|
|
},
|
|
"EngineName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Engine name that this option group can be applied to.\n </p>\n "
|
|
},
|
|
"MajorEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the major engine version associated with this option group.\n </p>\n "
|
|
},
|
|
"Options": {
|
|
"shape_name": "OptionsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Option",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option.\n </p>\n "
|
|
},
|
|
"OptionDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the option.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n If required, the port configured for this option to use.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupMemberships": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n If the Option requires access to a port, then this DB Security Group allows access to the port. \n </p>\n "
|
|
},
|
|
"VpcSecurityGroupMemberships": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n If the Option requires access to a port, then this VPC Security Group allows access to the port.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Option details.\n </p>\n",
|
|
"xmlname": "Option"
|
|
},
|
|
"documentation": "\n <p>\n Indicates what options are available in the option group.\n </p>\n "
|
|
},
|
|
"AllowsVpcAndNonVpcInstanceMemberships": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value 'true' indicates the option group \n can be applied to both VPC and non-VPC instances.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n </p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "OptionGroupAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The option group you are trying to create already exists.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "OptionGroupQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The quota of 20 option groups was exceeded for this AWS account.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Creates a new Option Group. \n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=CreateOptionGroup\n &OptionGroupName=myoptiongroup\n &EngineName=oracle-se1\n &MajorEngineVersion=11.2\n &OptionGroupDescription=Test Option Group</queryrequest>\n <queryresponse><CreateOptionGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <CreateOptionGroupResult>\n <OptionGroup>\n <MajorEngineVersion>11.2</MajorEngineVersion>\n <OptionGroupName>myoptiongroup</OptionGroupName>\n <EngineName>oracle-se1</EngineName>\n <OptionGroupDescription>Test Option Group</OptionGroupDescription>\n <Options/>\n </OptionGroup>\n </CreateOptionGroupResult>\n <ResponseMetadata>\n <RequestId>b2416a8a-84c9-11e1-a264-0b23c28bc344</RequestId>\n </ResponseMetadata>\n </CreateOptionGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"DeleteDBInstance": {
|
|
"name": "DeleteDBInstance",
|
|
"input": {
|
|
"shape_name": "DeleteDBInstanceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance identifier for the DB Instance to be deleted.\n This parameter isn't case sensitive.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
},
|
|
"SkipFinalSnapshot": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Determines whether a final DB Snapshot is created before the DB Instance is deleted. \n If <code>true</code> is specified, no DBSnapshot is created. If false is specified, a DB Snapshot \n is created before the DB Instance is deleted.\n </p>\n <note>The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is <code>false</code>.</note>\n <p>Default: <code>false</code></p>\n "
|
|
},
|
|
"FinalDBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot\n is set to <code>false</code>.\n </p>\n <note>\n Specifying this parameter and also setting \n the SkipFinalShapshot parameter to true results in an error.\n </note>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstance": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBInstanceStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified DB Instance is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSnapshotAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> is already used by an existing snapshot.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SnapshotQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Snapshots.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response\n from the web service indicates the request was received correctly. If a final DBSnapshot is requested\n the status of the RDS instance will be \"deleting\" until the DBSnapshot is created. DescribeDBInstance\n is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DeleteDBInstance\n &DBInstanceIdentifier=myrestoreddbinstance\n &SkipFinalSnapshot=true\n &Version=2013-01-10\n &Timestamp=2011-05-23T07%3A19%3A35.947Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DeleteDBInstanceResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DeleteDBInstanceResult>\n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <LatestRestorableTime>2011-05-23T07:15:00Z</LatestRestorableTime>\n <Engine>mysql</Engine>\n <PendingModifiedValues/>\n <BackupRetentionPeriod>1</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBInstanceStatus>deleting</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <Endpoint>\n <Port>3306</Port>\n <Address>myrestoreddbinstance.cu7u2t4uz396.us-east.rds.amazonaws.com</Address>\n </Endpoint>\n <DBInstanceIdentifier>myrestoreddbinstance</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>\n <AvailabilityZone>us-east-1d</AvailabilityZone>\n <InstanceCreateTime>2011-05-23T06:52:48.255Z</InstanceCreateTime>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </DeleteDBInstanceResult>\n <ResponseMetadata>\n <RequestId>03ea4ae8-850d-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</DeleteDBInstanceResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"DeleteDBParameterGroup": {
|
|
"name": "DeleteDBParameterGroup",
|
|
"input": {
|
|
"shape_name": "DeleteDBParameterGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be the name of an existing DB Parameter Group</li>\n <li>You cannot delete a default DB Parameter Group</li>\n <li>Cannot be associated with any DB Instances</li>\n </ul> \n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": null,
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidDBParameterGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The DB Parameter Group cannot be deleted because it is in use.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBParameterGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBParameterGroupName</i> does not refer to an\n existing DB Parameter Group.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with\n any RDS instances to be deleted.\n </p>\n <note>\n The specified DB Parameter Group cannot be associated with any DB Instances.\n </note>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DeleteDBParameterGroup\n &DBParameterGroupName=mydbparametergroup\n &Version=2013-01-10\n &SignatureVersion=2&SignatureMethod=HmacSHA256\n &Timestamp=2011-05-11T18%3A47%3A08.851Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DeleteDBParameterGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ResponseMetadata>\n <RequestId>4dc38be9-bf3b-11de-a88b-7b5b3d23b3a7</RequestId>\n </ResponseMetadata>\n</DeleteDBParameterGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"DeleteDBSecurityGroup": {
|
|
"name": "DeleteDBSecurityGroup",
|
|
"input": {
|
|
"shape_name": "DeleteDBSecurityGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group to delete.\n </p>\n <note>You cannot delete the default DB Security Group.</note>\n <p>\n Constraints:\n </p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": null,
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidDBSecurityGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The state of the DB Security Group does not allow deletion.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSecurityGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSecurityGroupName</i> does not refer to an existing DB Security Group.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Deletes a DB Security Group. \n </p>\n <note>The specified DB Security Group must not be associated with any DB Instances.</note>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DeleteDBSecurityGroup\n &DBSecurityGroupName=mysecuritygroup\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A48%3A21.746Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DeleteDBSecurityGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ResponseMetadata>\n <RequestId>5d013245-4172-11df-8520-e7e1e602a915</RequestId>\n </ResponseMetadata>\n</DeleteDBSecurityGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"DeleteDBSnapshot": {
|
|
"name": "DeleteDBSnapshot",
|
|
"input": {
|
|
"shape_name": "DeleteDBSnapshotMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DBSnapshot identifier.\n </p>\n <p>Constraints: Must be the name of an existing DB Snapshot in the <code>available</code> state.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSnapshotWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshot": {
|
|
"shape_name": "DBSnapshot",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier for the DB Snapshot.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the the DBInstanceIdentifier of the DB Instance\n this DB Snapshot was created from.\n </p>\n "
|
|
},
|
|
"SnapshotCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the time (UTC) when the snapshot was taken.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the database engine.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size in gigabytes (GB).\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of this DB Snapshot.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine was\n listening on at the time of the snapshot.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB\n Instance was located in at the time of the DB Snapshot.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the Vpc Id associated with the DB Snapshot.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the time (UTC) when the snapshot was taken.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the version of the database engine.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for the restored DB Instance.\n </p>\n "
|
|
},
|
|
"SnapshotType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the type of the DB Snapshot.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBSnapshot</a></li>\n <li><a>DeleteDBSnapshot</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSnapshots</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidDBSnapshotStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The state of the DB Security Snapshot does not allow deletion.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSnapshotNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> does not refer to an existing DB Snapshot.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Deletes a DBSnapshot. \n </p>\n <note>The DBSnapshot must be in the <code>available</code> state to be\n deleted.</note>\n <examples>\n <queryrequest>https://rds.amazon.com/\n &DBSnapshotIdentifier=mydbsnapshot\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T06%3A27%3A42.551Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DeleteDBSnapshotResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DeleteDBSnapshotResult>\n <DBSnapshot>\n <Port>3306</Port>\n <SnapshotCreateTime>2011-03-11T07:20:24.082Z</SnapshotCreateTime>\n <Engine>mysql</Engine>\n <Status>deleted</Status>\n <AvailabilityZone>us-east-1d</AvailabilityZone>\n <LicenseModel>general-public-license</LicenseModel>\n <InstanceCreateTime>2010-07-16T00:06:59.107Z</InstanceCreateTime>\n <AllocatedStorage>60</AllocatedStorage>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <EngineVersion>5.1.47</EngineVersion>\n <DBSnapshotIdentifier>mysnapshot2</DBSnapshotIdentifier>\n <SnapshotType>manual</SnapshotType>\n <MasterUsername>master</MasterUsername>\n </DBSnapshot>\n </DeleteDBSnapshotResult>\n <ResponseMetadata>\n <RequestId>627a43a1-8507-11e0-bd9b-a7b1ece36d51</RequestId>\n </ResponseMetadata>\n</DeleteDBSnapshotResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"DeleteDBSubnetGroup": {
|
|
"name": "DeleteDBSubnetGroup",
|
|
"input": {
|
|
"shape_name": "DeleteDBSubnetGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the database subnet group to delete.\n </p>\n <note>You cannot delete the default subnet group.</note>\n <p>\n Constraints:\n </p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": null,
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidDBSubnetGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The DB Subnet Group cannot be deleted because it is in use.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBSubnetStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The DB subnet is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSubnetGroupName</i> does not refer to an existing DB Subnet Group.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Deletes a DB subnet group. \n </p>\n <note>The specified database subnet group must not be associated with any DB instances.</note>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DeleteDBSubnetGroup\n &DBSubnetGroupName=mysubnetgroup\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A48%3A21.746Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DeleteDBSubnetGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ResponseMetadata>\n <RequestId>5d013245-4172-11df-8520-e7e1e602a915</RequestId>\n </ResponseMetadata>\n </DeleteDBSubnetGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"DeleteEventSubscription": {
|
|
"name": "DeleteEventSubscription",
|
|
"input": {
|
|
"shape_name": "DeleteEventSubscriptionMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubscriptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the RDS event notification subscription you want to delete.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EventSubscriptionWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"EventSubscription": {
|
|
"shape_name": "EventSubscription",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>Not used.</p> \n "
|
|
},
|
|
"CustomerAwsId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The AWS customer account associated with the RDS event notification subscription.</p>\n "
|
|
},
|
|
"CustSubscriptionId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The RDS event notification subscription Id.</p>\n "
|
|
},
|
|
"SnsTopicArn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The topic ARN of the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The status of the RDS event notification subscription.</p>\n <p>Constraints:</p>\n <p>Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist</p>\n <p>The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.</p>\n "
|
|
},
|
|
"SubscriptionCreationTime": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The time the RDS event notification subscription was created.</p>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The source type for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"SourceIdsList": {
|
|
"shape_name": "SourceIdsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SourceId"
|
|
},
|
|
"documentation": "\n <p>A list of source Ids for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"EventCategoriesList": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>A list of event categories for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Enabled": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.</p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>Contains the results of a successful invocation of the <a>DescribeEventSubscriptions</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "SubscriptionNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The subscription name does not exist.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidEventSubscriptionStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>This error can occur if someone else is modifying a subscription. You should retry the action.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>Deletes an RDS event notification subscription.</p>\n <examples>\n <queryrequest>https://rds.us-east-1.amazonaws.com/\n ?Action=DeleteEventSubscription\n &SubscriptionName=EventSubscription01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T012739Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature>\n </queryrequest>\n \n <queryresponse>\n<DeleteEventSubscriptionResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DeleteEventSubscriptionResult>\n <EventSubscription>\n <Enabled>true</Enabled>\n <CustomerAwsId>012345678901</CustomerAwsId>\n <SourceType>db-instance</SourceType>\n <Status>deleting</Status>\n <SubscriptionCreationTime>2013-01-28 00:29:23.736</SubscriptionCreationTime>\n <EventCategoriesList>\n <EventCategory>creation</EventCategory>\n <EventCategory>deletion</EventCategory>\n </EventCategoriesList>\n <CustSubscriptionId>EventSubscription01</CustSubscriptionId>\n <SnsTopicArn>arn:aws:sns:us-east-1:012345678901:EventSubscription01</SnsTopicArn>\n </EventSubscription>\n </DeleteEventSubscriptionResult>\n <ResponseMetadata>\n <RequestId>e7cf30ac-68e9-11e2-bd13-a92da73b3119</RequestId>\n </ResponseMetadata>\n</DeleteEventSubscriptionResponse>\n\n </queryresponse> \n </examples>\n "
|
|
},
|
|
"DeleteOptionGroup": {
|
|
"name": "DeleteOptionGroup",
|
|
"input": {
|
|
"shape_name": "DeleteOptionGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group to be deleted.\n </p>\n <note>You cannot delete default Option Groups.</note>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n </p>\n "
|
|
},
|
|
"output": null,
|
|
"errors": [
|
|
{
|
|
"shape_name": "OptionGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The specified option group could not be found. \n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidOptionGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The Option Group is not in the <i>available</i> state.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Deletes an existing Option Group.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DeleteOptionGroup\n &OptionGroupName=myoptiongroup</queryrequest>\n <queryresponse><DeleteOptionGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n </DeleteOptionGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"DescribeDBEngineVersions": {
|
|
"name": "DescribeDBEngineVersions",
|
|
"input": {
|
|
"shape_name": "DescribeDBEngineVersionsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The database engine to return.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The database engine version to return.\n </p>\n <p>Example: <code>5.1.49</code></p>\n "
|
|
},
|
|
"DBParameterGroupFamily": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of a specific DB Parameter Group family to return details for.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is\n included in the response so that the following results can be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"DefaultOnly": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that only the default version of the specified engine\n or engine and major version combination is returned.\n </p>\n "
|
|
},
|
|
"ListSupportedCharacterSets": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n If this parameter is specified, and if the requested engine supports the \n CharacterSetName parameter for CreateDBInstance, the response includes a\n list of supported character sets for each engine version.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBEngineVersionMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"DBEngineVersions": {
|
|
"shape_name": "DBEngineVersionList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBEngineVersion",
|
|
"type": "structure",
|
|
"members": {
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the database engine.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The version number of the database engine.\n </p>\n "
|
|
},
|
|
"DBParameterGroupFamily": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DBParameterGroupFamily for the database engine.\n </p>\n "
|
|
},
|
|
"DBEngineDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the database engine.\n </p>\n "
|
|
},
|
|
"DBEngineVersionDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the database engine version.\n </p>\n "
|
|
},
|
|
"DefaultCharacterSet": {
|
|
"shape_name": "CharacterSet",
|
|
"type": "structure",
|
|
"members": {
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the character set.\n </p>\n "
|
|
},
|
|
"CharacterSetDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the character set.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The default character set for new instances of this engine version,\n if the <code>CharacterSetName</code> parameter of the CreateDBInstance API\n is not specified.\n </p>\n "
|
|
},
|
|
"SupportedCharacterSets": {
|
|
"shape_name": "SupportedCharacterSetsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CharacterSet",
|
|
"type": "structure",
|
|
"members": {
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the character set.\n </p>\n "
|
|
},
|
|
"CharacterSetDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the character set.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the action <a>DescribeDBEngineVersions</a>. \n </p>\n ",
|
|
"xmlname": "CharacterSet"
|
|
},
|
|
"documentation": "\n <p>\n A list of the character sets supported by this engine for the\n <code>CharacterSetName</code> parameter of the CreateDBInstance API. \n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the action <a>DescribeDBEngineVersions</a>.\n </p>\n ",
|
|
"xmlname": "DBEngineVersion"
|
|
},
|
|
"documentation": "\n <p>\n A list of <code>DBEngineVersion</code> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeDBEngineVersions</a> action.\n </p>\n "
|
|
},
|
|
"errors": [],
|
|
"documentation": "\n <p>\n Returns a list of the available DB engines.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeDBEngineVersions\n &MaxRecords=100\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T07%3A34%3A17.435Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeDBEngineVersionsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeDBEngineVersionsResult>\n <DBEngineVersions>\n <DBEngineVersion>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Engine>mysql</Engine>\n <EngineVersion>5.1.42</EngineVersion>\n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Engine>mysql</Engine>\n <DBEngineDescription>Use instead of mysql5.1</DBEngineDescription>\n <EngineVersion>5.1.45</EngineVersion>\n <DBEngineVersionDescription>yaSSL Security Fixes</DBEngineVersionDescription>\n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Engine>mysql</Engine>\n <DBEngineDescription>Use instead of mysql5.1</DBEngineDescription>\n <EngineVersion>5.1.47</EngineVersion>\n <DBEngineVersionDescription>MySQL 5.1.47.R1 with InnoDB Plugin 1.0.8</DBEngineVersionDescription>\n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Engine>mysql</Engine>\n <DBEngineDescription>Use instead of mysql5.1</DBEngineDescription>\n <EngineVersion>5.1.48</EngineVersion>\n <DBEngineVersionDescription>MySQL 5.1.47.R1 with InnoDB Plugin 1.0.8</DBEngineVersionDescription>\n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Engine>mysql</Engine>\n <DBEngineDescription>Use instead of mysql5.1</DBEngineDescription>\n <EngineVersion>5.1.49</EngineVersion>\n <DBEngineVersionDescription>MySQL 5.1.49-R1 with innodb plugin</DBEngineVersionDescription>\n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Engine>mysql</Engine>\n <DBEngineDescription>Use instead of mysql5.1</DBEngineDescription>\n <EngineVersion>5.1.50</EngineVersion>\n <DBEngineVersionDescription>MySQL 5.1.50-R3</DBEngineVersionDescription>\n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>mysql5.5</DBParameterGroupFamily>\n <Engine>mysql</Engine>\n <DBEngineDescription>Use instead of mysql5.1</DBEngineDescription>\n <EngineVersion>5.5.7</EngineVersion>\n <DBEngineVersionDescription>MySQL 5.5.7.R1</DBEngineVersionDescription>\n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-ee-11.2</DBParameterGroupFamily>\n <Engine>oracle-ee</Engine>\n <DBEngineDescription>Oracle Database Server EE</DBEngineDescription>\n <EngineVersion>11.2.0.2</EngineVersion>\n <DBEngineVersionDescription>Oracle EE release</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-ee-11.2</DBParameterGroupFamily>\n <Engine>oracle-ee</Engine>\n <DBEngineDescription>Oracle Database Server EE</DBEngineDescription>\n <EngineVersion>11.2.0.2.v2</EngineVersion>\n <DBEngineVersionDescription>First Oracle Enterprise Edition One - DB Engine Version 11.2.0.2.v2</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-ee-11.2</DBParameterGroupFamily>\n <Engine>oracle-ee</Engine>\n <DBEngineDescription>Oracle Database Server EE</DBEngineDescription>\n <EngineVersion>11.2.0.2.v3</EngineVersion>\n <DBEngineVersionDescription>Oracle EE release</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-se-11.2</DBParameterGroupFamily>\n <Engine>oracle-se</Engine>\n <DBEngineDescription>Oracle Database Server SE</DBEngineDescription>\n <EngineVersion>11.2.0.2</EngineVersion>\n <DBEngineVersionDescription>Oracle SE release</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-se-11.2</DBParameterGroupFamily>\n <Engine>oracle-se</Engine>\n <DBEngineDescription>Oracle Database Server SE</DBEngineDescription>\n <EngineVersion>11.2.0.2.v2</EngineVersion>\n <DBEngineVersionDescription>Oracle SE release</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-se-11.2</DBParameterGroupFamily>\n <Engine>oracle-se</Engine>\n <DBEngineDescription>Oracle Database Server SE</DBEngineDescription>\n <EngineVersion>11.2.0.2.v3</EngineVersion>\n <DBEngineVersionDescription>Oracle SE release</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-se1-11.2</DBParameterGroupFamily>\n <Engine>oracle-se1</Engine>\n <DBEngineDescription>Oracle Database Server SE1</DBEngineDescription>\n <EngineVersion>11.2.0.2</EngineVersion>\n <DBEngineVersionDescription>Oracle SE1 release</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-se1-11.2</DBParameterGroupFamily>\n <Engine>oracle-se1</Engine>\n <DBEngineDescription>Oracle Database Server SE1</DBEngineDescription>\n <EngineVersion>11.2.0.2.v2</EngineVersion>\n <DBEngineVersionDescription>Oracle SE1 release</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n <DBEngineVersion>\n <DBParameterGroupFamily>oracle-se1-11.2</DBParameterGroupFamily>\n <Engine>oracle-se1</Engine>\n <DBEngineDescription>Oracle Database Server SE1</DBEngineDescription>\n <EngineVersion>11.2.0.2.v3</EngineVersion>\n <DBEngineVersionDescription>Oracle SE1 release</DBEngineVersionDescription>\n <CharacterSet>\n <CharacterSetName>AL32UTF8</CharacterSetName>\n <CharacterSetDescription>Unicode 5.0 UTF-8 Universal character set</CharacterSetDescription>\n </CharacterSet> \n </DBEngineVersion>\n </DBEngineVersions>\n </DescribeDBEngineVersionsResult>\n <ResponseMetadata>\n <RequestId>1162dc55-850f-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</DescribeDBEngineVersionsResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBEngineVersions",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeDBInstances": {
|
|
"name": "DescribeDBInstances",
|
|
"input": {
|
|
"shape_name": "DescribeDBInstancesMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The user-supplied instance identifier.\n If this parameter is specified, information from only the\n specific DB Instance is returned.\n This parameter isn't case sensitive.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n \n \n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code> .\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code> .\n </p>\n "
|
|
},
|
|
"DBInstances": {
|
|
"shape_name": "DBInstanceList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n ",
|
|
"xmlname": "DBInstance"
|
|
},
|
|
"documentation": "\n <p>\n A list of <a>DBInstance</a> instances.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeDBInstances</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Returns information about provisioned RDS instances. This API supports pagination.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeDBInstances\n &Version=2013-01-10\n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T06%3A54%3A55.116Z\n &AWSAccessKeyId=< Your AWS Access ID Key >\n &Signature= < Your Signature ></queryrequest>\n <queryresponse><DescribeDBInstancesResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeDBInstancesResult>\n <DBInstances> \n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <LatestRestorableTime>2011-05-23T06:50:00Z</LatestRestorableTime>\n <Engine>mysql</Engine>\n <PendingModifiedValues/>\n <BackupRetentionPeriod>1</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBInstanceStatus>available</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <Endpoint>\n <Port>3306</Port>\n <Address>simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com</Address>\n </Endpoint>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>\n <AvailabilityZone>us-east-1a</AvailabilityZone>\n <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </DescribeDBInstancesResult>\n <ResponseMetadata>\n <RequestId>9135fff3-8509-11e0-bd9b-a7b1ece36d51</RequestId>\n </ResponseMetadata>\n</DescribeDBInstancesResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBInstances",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeDBParameterGroups": {
|
|
"name": "DescribeDBParameterGroups",
|
|
"input": {
|
|
"shape_name": "DescribeDBParameterGroupsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of a specific DB Parameter Group to return details for.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBParameterGroupsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the DB Parameter Group.\n </p>\n "
|
|
},
|
|
"DBParameterGroupFamily": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the DB Parameter Group Family that\n this DB Parameter Group is compatible with.\n </p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the customer-specified description for this DB Parameter Group.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>CreateDBParameterGroup</a> action.\n </p>\n <p>\n This data type is used as a request parameter in the <a>DeleteDBParameterGroup</a> action,\n and as a response element in the <a>DescribeDBParameterGroups</a> action.\n </p>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n A list of <a>DBParameterGroup</a> instances.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeDBParameterGroups</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBParameterGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBParameterGroupName</i> does not refer to an\n existing DB Parameter Group.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DBParameterGroup.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeDBParameterGroups\n &DBParameterGroupName=myparamsgroup\n &MaxRecords=100\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A54%3A32.899Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeDBParameterGroupsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeDBParameterGroupsResult>\n <DBParameterGroups>\n <DBParameterGroup>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Description>Default parameter group for mysql5.1</Description>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n <DBParameterGroup>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Description>My DB Param Group</Description>\n <DBParameterGroupName>testdbparamgroup</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n </DescribeDBParameterGroupsResult>\n <ResponseMetadata>\n <RequestId>cb8d9bb4-a02a-11df-bd60-c955b7d6e8e0</RequestId>\n </ResponseMetadata>\n</DescribeDBParameterGroupsResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBParameterGroups",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeDBParameters": {
|
|
"name": "DescribeDBParameters",
|
|
"input": {
|
|
"shape_name": "DescribeDBParametersMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of a specific DB Parameter Group to return details for.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
},
|
|
"Source": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The parameter types to return.\n </p>\n <p>Default: All parameter types returned</p>\n \n <p>Valid Values: <code>user | system | engine-default</code></p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p> \n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBParameterGroupDetails",
|
|
"type": "structure",
|
|
"members": {
|
|
"Parameters": {
|
|
"shape_name": "ParametersList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Parameter",
|
|
"type": "structure",
|
|
"members": {
|
|
"ParameterName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the parameter.\n </p>\n "
|
|
},
|
|
"ParameterValue": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the value of the parameter.\n </p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides a description of the parameter.\n </p>\n "
|
|
},
|
|
"Source": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the source of the parameter value.\n </p>\n "
|
|
},
|
|
"ApplyType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the engine specific parameters type.\n </p>\n "
|
|
},
|
|
"DataType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the valid data type for the parameter.\n </p>\n "
|
|
},
|
|
"AllowedValues": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the valid range of values for the parameter.\n </p>\n "
|
|
},
|
|
"IsModifiable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n </p>\n "
|
|
},
|
|
"MinimumEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The earliest engine version to which the parameter can apply.\n </p>\n "
|
|
},
|
|
"ApplyMethod": {
|
|
"shape_name": "ApplyMethod",
|
|
"type": "string",
|
|
"enum": [
|
|
"immediate",
|
|
"pending-reboot"
|
|
],
|
|
"documentation": "\n <p>\n Indicates when to apply parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a request parameter in the\n <a>ModifyDBParameterGroup</a> and <a>ResetDBParameterGroup</a> actions.\n </p>\n <p>This data type is used as a response element in the \n <a>DescribeEngineDefaultParameters</a> and <a>DescribeDBParameters</a> actions.</p>\n ",
|
|
"xmlname": "Parameter"
|
|
},
|
|
"documentation": "\n <p>\n A list of <a>Parameter</a> instances.\n </p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeDBParameters</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBParameterGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBParameterGroupName</i> does not refer to an\n existing DB Parameter Group.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Returns the detailed parameter list for a particular DBParameterGroup.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeDBParameters\n &DBParameterGroupName=mydbparametergroup\n &Source=system\n &MaxRecords=100\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-11T19%3A31%3A42.262Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeDBParametersResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeDBParametersResult>\n <Parameters>\n <Parameter>\n <ParameterValue>/rdsdbbin/mysql</ParameterValue>\n <DataType>string</DataType>\n <Source>system</Source>\n <IsModifiable>false</IsModifiable>\n <Description>The MySQL installation base directory.</Description>\n <ApplyType>static</ApplyType>\n <ParameterName>basedir</ParameterName>\n </Parameter>\n <Parameter>\n <ParameterValue>32768</ParameterValue>\n <DataType>integer</DataType>\n <Source>system</Source>\n <IsModifiable>true</IsModifiable>\n <Description>The size of the cache to hold the SQL statements for the binary log during a transaction.</Description>\n <ApplyType>dynamic</ApplyType>\n <AllowedValues>4096-9223372036854775807</AllowedValues>\n <ParameterName>binlog_cache_size</ParameterName>\n </Parameter>\n </Parameters>\n </DescribeDBParametersResult>\n <ResponseMetadata>\n <RequestId>8743f2cf-bf41-11de-8c8e-49155882c409</RequestId>\n </ResponseMetadata>\n</DescribeDBParametersResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "Parameters",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeDBSecurityGroups": {
|
|
"name": "DescribeDBSecurityGroups",
|
|
"input": {
|
|
"shape_name": "DescribeDBSecurityGroupsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group to return details for.\n </p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSecurityGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroups",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"OwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the AWS ID of the owner of a specific DB Security Group.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Security Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroups": {
|
|
"shape_name": "EC2SecurityGroupList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "EC2SecurityGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the EC2 security group. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the EC2 Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the id of the EC2 Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupOwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the <code>EC2SecurityGroupName</code> field.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>AuthorizeDBSecurityGroupIngress</a></li>\n <li><a>DescribeDBSecurityGroups</a></li> \n <li><a>RevokeDBSecurityGroupIngress</a></li> \n </ul>\n ",
|
|
"xmlname": "EC2SecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>EC2SecurityGroup</a> elements.\n </p>\n "
|
|
},
|
|
"IPRanges": {
|
|
"shape_name": "IPRangeList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "IPRange",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the IP range. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n </p>\n "
|
|
},
|
|
"CIDRIP": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the IP range.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSecurityGroups</a> action.\n </p>\n ",
|
|
"xmlname": "IPRange"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>IPRange</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>DescribeDBSecurityGroups</a></li>\n <li><a>AuthorizeDBSecurityGroupIngress</a></li>\n <li><a>CreateDBSecurityGroup</a></li>\n <li><a>RevokeDBSecurityGroupIngress</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSecurityGroups</a> action.</p>\n \n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n A list of <a>DBSecurityGroup</a> instances.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeDBSecurityGroups</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSecurityGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSecurityGroupName</i> does not refer to an existing DB Security Group.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DBSecurityGroup.\n </p>\n <p>For an overview of CIDR ranges, go to the \n <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>.\n </p>\n \n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeDBSecurityGroups\n &Version=2013-01-10\n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T19%3A40%3A19.926Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeDBSecurityGroupsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeDBSecurityGroupsResult>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <EC2SecurityGroups>\n <EC2SecurityGroup>\n <Status>authorized</Status>\n <EC2SecurityGroupName>myec2securitygroup</EC2SecurityGroupName>\n <EC2SecurityGroupOwnerId>054794666394</EC2SecurityGroupOwnerId>\n </EC2SecurityGroup>\n </EC2SecurityGroups>\n <DBSecurityGroupDescription>default</DBSecurityGroupDescription>\n <IPRanges>\n <IPRange>\n <CIDRIP>127.0.0.1/30</CIDRIP>\n <Status>authorized</Status>\n </IPRange>\n </IPRanges>\n <OwnerId>621567473609</OwnerId>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n <VpcId>vpc-1ab2c3d4</VpcId>\n </DBSecurityGroup>\n <DBSecurityGroup>\n <EC2SecurityGroups/>\n <DBSecurityGroupDescription>My new DBSecurityGroup</DBSecurityGroupDescription>\n <IPRanges>\n <IPRange>\n <CIDRIP>192.168.1.1/24</CIDRIP>\n <Status>authorized</Status>\n </IPRange>\n </IPRanges>\n <OwnerId>621567473609</OwnerId>\n <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>\n <VpcId>vpc-1ab2c3d5</VpcId>\n </DBSecurityGroup>\n <DBSecurityGroup>\n <EC2SecurityGroups/>\n <DBSecurityGroupDescription>My new DBSecurityGroup</DBSecurityGroupDescription>\n <IPRanges/>\n <OwnerId>621567473609</OwnerId>\n <DBSecurityGroupName>mydbsecuritygroup4</DBSecurityGroupName>\n <VpcId>vpc-1ab2c3d6</VpcId>\n </DBSecurityGroup>\n </DBSecurityGroups>\n </DescribeDBSecurityGroupsResult>\n <ResponseMetadata>\n <RequestId>bbdad154-bf42-11de-86a4-97241dfaadff</RequestId>\n </ResponseMetadata>\n</DescribeDBSecurityGroupsResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBSecurityGroups",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeDBSnapshots": {
|
|
"name": "DescribeDBSnapshots",
|
|
"input": {
|
|
"shape_name": "DescribeDBSnapshotsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier.\n This parameter isn't case sensitive.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n "
|
|
},
|
|
"DBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. \n This value is stored as a lowercase string.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n <li>If this is the identifier of an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</li>\n </ul>\n "
|
|
},
|
|
"SnapshotType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional snapshot type for which snapshots will be returned.\n If not specified, the returned results will include snapshots of all types.\n </p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSnapshotMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"DBSnapshots": {
|
|
"shape_name": "DBSnapshotList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSnapshot",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier for the DB Snapshot.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the the DBInstanceIdentifier of the DB Instance\n this DB Snapshot was created from.\n </p>\n "
|
|
},
|
|
"SnapshotCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the time (UTC) when the snapshot was taken.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the database engine.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size in gigabytes (GB).\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of this DB Snapshot.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine was\n listening on at the time of the snapshot.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB\n Instance was located in at the time of the DB Snapshot.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the Vpc Id associated with the DB Snapshot.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the time (UTC) when the snapshot was taken.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the version of the database engine.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for the restored DB Instance.\n </p>\n "
|
|
},
|
|
"SnapshotType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the type of the DB Snapshot.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBSnapshot</a></li>\n <li><a>DeleteDBSnapshot</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSnapshots</a> action.</p>\n ",
|
|
"xmlname": "DBSnapshot"
|
|
},
|
|
"documentation": "\n <p>\n A list of <a>DBSnapshot</a> instances.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeDBSnapshots</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSnapshotNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> does not refer to an existing DB Snapshot.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Returns information about DBSnapshots. This API supports pagination.\n </p>\n <examples>\n <queryrequest>https://rds.amazon.com/\n ?Action=DescribeDBSnapshots\n &MaxRecords=100\n &Version=2013-01-10\n &Timestamp=2011-05-23T06%3A27%3A42.551Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeDBSnapshotsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeDBSnapshotsResult>\n <DBSnapshots>\n <DBSnapshot>\n <Port>3306</Port>\n <SnapshotCreateTime>2011-05-23T06:29:03.483Z</SnapshotCreateTime>\n <Engine>mysql</Engine>\n <Status>available</Status>\n <AvailabilityZone>us-east-1a</AvailabilityZone>\n <LicenseModel>general-public-license</LicenseModel>\n <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <EngineVersion>5.1.50</EngineVersion>\n <DBSnapshotIdentifier>mydbsnapshot</DBSnapshotIdentifier>\n <SnapshotType>manual</SnapshotType>\n <MasterUsername>master</MasterUsername>\n </DBSnapshot>\n <DBSnapshot>\n <Port>3306</Port>\n <SnapshotCreateTime>2011-03-11T07:20:24.082Z</SnapshotCreateTime>\n <Engine>mysql</Engine>\n <Status>available</Status>\n <AvailabilityZone>us-east-1a</AvailabilityZone>\n <LicenseModel>general-public-license</LicenseModel>\n <InstanceCreateTime>2010-08-04T23:27:36.420Z</InstanceCreateTime>\n <AllocatedStorage>50</AllocatedStorage>\n <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>\n <EngineVersion>5.1.49</EngineVersion>\n <DBSnapshotIdentifier>mysnapshot1</DBSnapshotIdentifier>\n <SnapshotType>manual</SnapshotType>\n <MasterUsername>sa</MasterUsername>\n </DBSnapshot>\n <DBSnapshot>\n <Port>3306</Port>\n <SnapshotCreateTime>2012-04-02T00:01:24.082Z</SnapshotCreateTime>\n <Engine>mysql</Engine>\n <Status>available</Status>\n <AvailabilityZone>us-east-1d</AvailabilityZone>\n <LicenseModel>general-public-license</LicenseModel>\n <InstanceCreateTime>2010-07-16T00:06:59.107Z</InstanceCreateTime>\n <AllocatedStorage>60</AllocatedStorage>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <EngineVersion>5.1.47</EngineVersion>\n <DBSnapshotIdentifier>rds:simcoprod01-2012-04-02-00-01</DBSnapshotIdentifier>\n <SnapshotType>automated</SnapshotType>\n <MasterUsername>master</MasterUsername>\n </DBSnapshot>\n </DBSnapshots>\n </DescribeDBSnapshotsResult>\n <ResponseMetadata>\n <RequestId>c4191173-8506-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</DescribeDBSnapshotsResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBSnapshots",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeDBSubnetGroups": {
|
|
"name": "DescribeDBSubnetGroups",
|
|
"input": {
|
|
"shape_name": "DescribeDBSubnetGroupsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Subnet Group to return details for.\n </p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSubnetGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"DBSubnetGroups": {
|
|
"shape_name": "DBSubnetGroups",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBSubnetGroup</a></li>\n <li><a>ModifyDBSubnetGroup</a></li>\n <li><a>DescribeDBSubnetGroups</a></li>\n <li><a>DeleteDBSubnetGroup</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.</p>\n ",
|
|
"xmlname": "DBSubnetGroup"
|
|
},
|
|
"documentation": "\n <p>\n A list of <a>DBSubnetGroup</a> instances.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeDBSubnetGroups</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSubnetGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSubnetGroupName</i> does not refer to an existing DB Subnet Group.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified,\n the list will contain only the descriptions of the specified DBSubnetGroup.\n </p>\n <p>For an overview of CIDR ranges, go to the \n <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>.\n </p>\n \n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeDBSubnetGroups\n &Version=2013-01-10\n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T19%3A40%3A19.926Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeDBSubnetGroupsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeDBSubnetGroupsResult>\n <DBSubnetGroups>\n <DBSubnetGroup>\n <VpcId>990524496922</VpcId>\n <SubnetGroupStatus>Complete</SubnetGroupStatus>\n <DBSubnetGroupDescription>description</DBSubnetGroupDescription>\n <DBSubnetGroupName>subnet_grp1</DBSubnetGroupName>\n <Subnets>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1c</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1b</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1d</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n </Subnets>\n </DBSubnetGroup>\n <DBSubnetGroup>\n <VpcId>990524496922</VpcId>\n <SubnetGroupStatus>Complete</SubnetGroupStatus>\n <DBSubnetGroupDescription>description</DBSubnetGroupDescription>\n <DBSubnetGroupName>subnet_grp2</DBSubnetGroupName>\n <Subnets>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1c</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1b</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1d</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n </Subnets>\n </DBSubnetGroup>\n </DBSubnetGroups>\n </DescribeDBSubnetGroupsResult>\n <ResponseMetadata>\n <RequestId>31d0faee-229b-11e1-81f1-df3a2a803dad</RequestId>\n </ResponseMetadata>\n </DescribeDBSubnetGroupsResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBSubnetGroups",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeEngineDefaultParameters": {
|
|
"name": "DescribeEngineDefaultParameters",
|
|
"input": {
|
|
"shape_name": "DescribeEngineDefaultParametersMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupFamily": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group Family.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EngineDefaultsWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"EngineDefaults": {
|
|
"shape_name": "EngineDefaults",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupFamily": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Parameter Group Family which the\n engine default parameters apply to.\n </p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous \n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code> .\n </p>\n "
|
|
},
|
|
"Parameters": {
|
|
"shape_name": "ParametersList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Parameter",
|
|
"type": "structure",
|
|
"members": {
|
|
"ParameterName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the parameter.\n </p>\n "
|
|
},
|
|
"ParameterValue": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the value of the parameter.\n </p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides a description of the parameter.\n </p>\n "
|
|
},
|
|
"Source": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the source of the parameter value.\n </p>\n "
|
|
},
|
|
"ApplyType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the engine specific parameters type.\n </p>\n "
|
|
},
|
|
"DataType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the valid data type for the parameter.\n </p>\n "
|
|
},
|
|
"AllowedValues": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the valid range of values for the parameter.\n </p>\n "
|
|
},
|
|
"IsModifiable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n </p>\n "
|
|
},
|
|
"MinimumEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The earliest engine version to which the parameter can apply.\n </p>\n "
|
|
},
|
|
"ApplyMethod": {
|
|
"shape_name": "ApplyMethod",
|
|
"type": "string",
|
|
"enum": [
|
|
"immediate",
|
|
"pending-reboot"
|
|
],
|
|
"documentation": "\n <p>\n Indicates when to apply parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a request parameter in the\n <a>ModifyDBParameterGroup</a> and <a>ResetDBParameterGroup</a> actions.\n </p>\n <p>This data type is used as a response element in the \n <a>DescribeEngineDefaultParameters</a> and <a>DescribeDBParameters</a> actions.</p>\n ",
|
|
"xmlname": "Parameter"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of engine default parameters.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeEngineDefaultParameters</a> action.\n </p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [],
|
|
"documentation": "\n <p>\n Returns the default engine and system parameter information for the specified database engine.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeEngineDefaultParameters\n &DBParameterGroupFamily=mysql5.1\n &Version=2013-01-10 \n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T19%3A10%3A03.510Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeEngineDefaultParametersResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeEngineDefaultParametersResult>\n <EngineDefaults>\n <Marker>bG93ZXJfY2FzZV90YWJsZV9uYW1lcw==</Marker>\n <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>\n <Parameters>\n <Parameter>\n <DataType>boolean</DataType>\n <Source>engine-default</Source>\n <IsModifiable>false</IsModifiable>\n <Description>Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded</Description>\n <ApplyType>static</ApplyType>\n <AllowedValues>0,1</AllowedValues>\n <ParameterName>allow-suspicious-udfs</ParameterName>\n </Parameter>\n <Parameter>\n <DataType>integer</DataType>\n <Source>engine-default</Source>\n <IsModifiable>true</IsModifiable>\n <Description>Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns</Description>\n <ApplyType>dynamic</ApplyType>\n <AllowedValues>1-65535</AllowedValues>\n <ParameterName>auto_increment_increment</ParameterName>\n </Parameter>\n <Parameter>\n <DataType>integer</DataType>\n <Source>engine-default</Source>\n <IsModifiable>true</IsModifiable>\n <Description>Determines the starting point for the AUTO_INCREMENT column value</Description>\n <ApplyType>dynamic</ApplyType>\n <AllowedValues>1-65535</AllowedValues>\n <ParameterName>auto_increment_offset</ParameterName>\n </Parameter> \n </EngineDefaults>\n </DescribeEngineDefaultParametersResult>\n <ResponseMetadata>\n <RequestId>6c1341eb-a124-11df-bf5c-973b09643c5d</RequestId>\n </ResponseMetadata>\n</DescribeEngineDefaultParametersResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "EngineDefaults",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeEventCategories": {
|
|
"name": "DescribeEventCategories",
|
|
"input": {
|
|
"shape_name": "DescribeEventCategoriesMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The type of source that will be generating the events.\n </p>\n <p>Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EventCategoriesMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"EventCategoriesMapList": {
|
|
"shape_name": "EventCategoriesMapList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "EventCategoriesMap",
|
|
"type": "structure",
|
|
"members": {
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The source type that the returned categories belong to</p>\n "
|
|
},
|
|
"EventCategories": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>The event categories for the specified source type</p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": " \n <p>Contains the results of a successful invocation of the <a>DescribeEventCategories</a> action.</p>\n ",
|
|
"xmlname": "EventCategoriesMap"
|
|
},
|
|
"documentation": "\n <p>A list of EventCategoriesMap data types.</p>\n "
|
|
}
|
|
},
|
|
"documentation": " \n <p>Data returned from the <b>DescribeEventCategories</b> action.</p>\n "
|
|
},
|
|
"errors": [],
|
|
"documentation": "\n <p>Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can see a list of the event categories and source types \n in the <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">\n Events</a> topic in the Amazon RDS User Guide.</p> \n <examples>\n <queryrequest>https://rds.us-east-1.amazonaws.com/\n ?Action=DescribeEventSubscriptions\n &MaxRecords=100\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T004543Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature>\n </queryrequest>\n <queryresponse><DescribeEventSubscriptionsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeEventSubscriptionsResult>\n <EventSubscriptionsList>\n <EventSubscription>\n <Enabled>true</Enabled>\n <CustomerAwsId>012345678901</CustomerAwsId>\n <Status>active</Status>\n <SubscriptionCreationTime>2013-01-28 00:29:23.736</SubscriptionCreationTime>\n <CustSubscriptionId>EventSubscription01</CustSubscriptionId>\n <SnsTopicArn>arn:aws:sns:us-east-1:012345678901:EventSubscription01</SnsTopicArn>\n </EventSubscription>\n <EventSubscription>\n <Enabled>true</Enabled>\n <CustomerAwsId>012345678901</CustomerAwsId>\n <Status>active</Status>\n <SubscriptionCreationTime>2013-01-28 00:29:42.851</SubscriptionCreationTime>\n <CustSubscriptionId>EventSubscription02</CustSubscriptionId>\n <SnsTopicArn>arn:aws:sns:us-east-1:012345678901:EventSubscription01</SnsTopicArn>\n </EventSubscription>\n </EventSubscriptionsList>\n </DescribeEventSubscriptionsResult>\n <ResponseMetadata>\n <RequestId>0ce48079-68e4-11e2-91fe-5daa8e68c7d4</RequestId>\n </ResponseMetadata>\n</DescribeEventSubscriptionsResponse>\n </queryresponse>\n \n </examples>\n "
|
|
},
|
|
"DescribeEventSubscriptions": {
|
|
"name": "DescribeEventSubscriptions",
|
|
"input": {
|
|
"shape_name": "DescribeEventSubscriptionsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubscriptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the RDS event notification subscription you want to describe.</p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code> .\n </p>\n \n \n "
|
|
}
|
|
},
|
|
"documentation": " \n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EventSubscriptionsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"EventSubscriptionsList": {
|
|
"shape_name": "EventSubscriptionsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "EventSubscription",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>Not used.</p> \n "
|
|
},
|
|
"CustomerAwsId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The AWS customer account associated with the RDS event notification subscription.</p>\n "
|
|
},
|
|
"CustSubscriptionId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The RDS event notification subscription Id.</p>\n "
|
|
},
|
|
"SnsTopicArn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The topic ARN of the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The status of the RDS event notification subscription.</p>\n <p>Constraints:</p>\n <p>Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist</p>\n <p>The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.</p>\n "
|
|
},
|
|
"SubscriptionCreationTime": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The time the RDS event notification subscription was created.</p>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The source type for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"SourceIdsList": {
|
|
"shape_name": "SourceIdsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SourceId"
|
|
},
|
|
"documentation": "\n <p>A list of source Ids for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"EventCategoriesList": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>A list of event categories for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Enabled": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.</p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>Contains the results of a successful invocation of the <a>DescribeEventSubscriptions</a> action.</p>\n ",
|
|
"xmlname": "EventSubscription"
|
|
},
|
|
"documentation": "\n <p>A list of EventSubscriptions data types.</p>\n "
|
|
}
|
|
},
|
|
"documentation": " \n <p>Data returned by the <b>DescribeEventSubscriptions</b> action.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "SubscriptionNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The subscription name does not exist.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>Lists all the subscription descriptions for a customer account. The description for a subscription includes\n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.\n </p>\n <p>If you specify a SubscriptionName, lists the description for that subscription.</p>\n <examples>\n <queryrequest>https://rds.us-east-1.amazonaws.com/\n ?Action=DescribeEventCategories\n &SourceType=db-instance\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T013452Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature>\n </queryrequest>\n <queryresponse>\n <DescribeEventCategoriesResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeEventCategoriesResult>\n <EventCategoriesMapList>\n <EventCategoriesMap>\n <SourceType>db-instance</SourceType>\n <EventCategories>\n <EventCategory>failover</EventCategory>\n <EventCategory>low storage</EventCategory>\n <EventCategory>maintenance</EventCategory>\n <EventCategory>recovery</EventCategory>\n <EventCategory>restoration</EventCategory>\n <EventCategory>deletion</EventCategory>\n <EventCategory>configuration change</EventCategory>\n <EventCategory>failover</EventCategory>\n <EventCategory>availability</EventCategory>\n <EventCategory>creation</EventCategory>\n <EventCategory>backup</EventCategory>\n <EventCategory>notification</EventCategory>\n </EventCategories>\n </EventCategoriesMap>\n </EventCategoriesMapList>\n </DescribeEventCategoriesResult>\n <ResponseMetadata>\n <RequestId>ea3bf54b-68ea-11e2-bd13-a92da73b3119</RequestId>\n </ResponseMetadata>\n</DescribeEventCategoriesResponse>\n </queryresponse>\n </examples>\n "
|
|
},
|
|
"DescribeEvents": {
|
|
"name": "DescribeEvents",
|
|
"input": {
|
|
"shape_name": "DescribeEventsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SourceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The identifier of the event source for which events\n will be returned. If not specified,\n then all sources are included in the response.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>If SourceIdentifier is supplied, SourceType must also be provided.</li>\n <li>If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.</li>\n <li>If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.</li>\n <li>If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.</li>\n <li>If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens.</li>\n </ul>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "SourceType",
|
|
"type": "string",
|
|
"enum": [
|
|
"db-instance",
|
|
"db-parameter-group",
|
|
"db-security-group",
|
|
"db-snapshot"
|
|
],
|
|
"documentation": "\n <p>\n The event source to retrieve events for.\n If no value is specified, all events are returned.\n </p>\n "
|
|
},
|
|
"StartTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a>\n </p>\n <p>Example: 2009-07-08T18:00Z</p>\n "
|
|
},
|
|
"EndTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a>\n </p>\n <p>Example: 2009-07-08T18:00Z</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The number of minutes to retrieve events for.\n </p>\n <p>Default: 60</p>\n "
|
|
},
|
|
"EventCategories": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>\n A list of event categories that trigger notifications for a event notification subscription.\n </p>\n \n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EventsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by <code>MaxRecords</code> .\n </p>\n "
|
|
},
|
|
"Events": {
|
|
"shape_name": "EventList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Event",
|
|
"type": "structure",
|
|
"members": {
|
|
"SourceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the identifier for the source of the event.\n </p>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "SourceType",
|
|
"type": "string",
|
|
"enum": [
|
|
"db-instance",
|
|
"db-parameter-group",
|
|
"db-security-group",
|
|
"db-snapshot"
|
|
],
|
|
"documentation": "\n <p>\n Specifies the source type for this event.\n </p>\n "
|
|
},
|
|
"Message": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the text of this event.\n </p>\n "
|
|
},
|
|
"EventCategories": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>\n Specifies the category for the event.\n </p>\n "
|
|
},
|
|
"Date": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the date and time of the event.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeEvents</a> action.\n </p>\n ",
|
|
"xmlname": "Event"
|
|
},
|
|
"documentation": "\n <p>\n A list of <a>Event</a> instances.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeEvents</a> action.\n </p>\n "
|
|
},
|
|
"errors": [],
|
|
"documentation": "\n <p>\n Returns events related to DB instances, DB security groups, DB Snapshots, and DB parameter\n groups for the past 14 days. Events specific to a particular DB Iinstance, DB security group,\n DB Snapshot, or DB parameter group can be obtained by providing the source identifier as a parameter.\n By default, the past hour of events are returned.\n </p>\n <p>You can see a list of event categories and source types \n in the <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">Events\n </a> topic in the Amazon RDS User Guide.</p> \n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeEvents\n &Duration=1440\n &MaxRecords=100\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T20%3A00%3A44.420Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeEventsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeEventsResult>\n <Events>\n <Event>\n <Message>Applied change to security group</Message>\n <SourceType>db-security-group</SourceType>\n <Date>2010-08-11T17:12:52.860Z</Date>\n <SourceIdentifier>mydbsecuritygroup</SourceIdentifier>\n </Event>\n <Event>\n <Message>Database instance created</Message>\n <SourceType>db-instance</SourceType>\n <Date>2010-08-11T18:10:15.269Z</Date>\n <SourceIdentifier>mydbinstance3</SourceIdentifier>\n </Event>\n <Event>\n <Message>Backing up database instance</Message>\n <SourceType>db-instance</SourceType>\n <Date>2010-08-11T18:10:34.690Z</Date>\n <SourceIdentifier>mydbinstance3</SourceIdentifier>\n </Event>\n <Event>\n <Message>Backing up DB Instance</Message>\n <SourceType>db-instance</SourceType>\n <Date>2010-08-11T18:25:52.263Z</Date>\n <SourceIdentifier>mynewdbinstance</SourceIdentifier>\n </Event>\n <Event>\n <Message>Creating user snapshot</Message>\n <SourceType>db-snapshot</SourceType>\n <Date>2010-08-11T18:25:52.263Z</Date>\n <SourceIdentifier>mynewdbsnapshot3</SourceIdentifier>\n </Event>\n </Events>\n </DescribeEventsResult>\n <ResponseMetadata>\n <RequestId>95b948cd-bf45-11de-86a4-97241dfaadff</RequestId>\n </ResponseMetadata>\n</DescribeEventsResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "Events",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeOptionGroupOptions": {
|
|
"name": "DescribeOptionGroupOptions",
|
|
"input": {
|
|
"shape_name": "DescribeOptionGroupOptionsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"EngineName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Options available for the given DB engine name to be described.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"MajorEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If specified, filters the results to include only options for the specified major engine version.\n </p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n \n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "OptionGroupOptionsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupOptions": {
|
|
"shape_name": "OptionGroupOptionsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "OptionGroupOption",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option.\n </p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the option.\n </p>\n "
|
|
},
|
|
"EngineName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Engine name that this option can be applied to.\n </p>\n "
|
|
},
|
|
"MajorEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the major engine version that the option is available for.\n </p>\n "
|
|
},
|
|
"MinimumRequiredMinorEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The minimum required engine version for the option to be applied.\n </p>\n "
|
|
},
|
|
"PortRequired": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies whether the option requires a port.\n </p>\n "
|
|
},
|
|
"DefaultPort": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n If the option requires a port, specifies the default port for the option.\n </p>\n "
|
|
},
|
|
"OptionsDependedOn": {
|
|
"shape_name": "OptionsDependedOn",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "OptionName"
|
|
},
|
|
"documentation": "\n <p>\n List of all options that are prerequisites for this option.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Available option.\n </p>\n ",
|
|
"xmlname": "OptionGroupOption"
|
|
},
|
|
"documentation": "\n <p>\n List of available options.\n </p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n </p>\n "
|
|
},
|
|
"errors": [],
|
|
"documentation": "\n <p>\n Describes all available options. \n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeOptionGroupOptions\n &EngineName=oracle-se1\n &MajorEngineVersion=11.2</queryrequest>\n <queryresponse><DescribeOptionGroupOptionsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeOptionGroupOptionsResult>\n <OptionGroupOptions>\n <OptionGroupOption>\n <MajorEngineVersion>11.2</MajorEngineVersion>\n <PortRequired>true</PortRequired>\n <OptionsDependedOn/>\n <Description>Oracle Enterprise Manager</Description>\n <DefaultPort>1158</DefaultPort>\n <Name>OEM</Name>\n <EngineName>oracle-se1</EngineName>\n <MinimumRequiredMinorEngineVersion>0.2.v3</MinimumRequiredMinorEngineVersion>\n </OptionGroupOption>\n </OptionGroupOptions>\n </DescribeOptionGroupOptionsResult>\n <ResponseMetadata>\n <RequestId>d9c8f6a1-84c7-11e1-a264-0b23c28bc344</RequestId>\n </ResponseMetadata>\n </DescribeOptionGroupOptionsResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "OptionGroupOptions",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeOptionGroups": {
|
|
"name": "DescribeOptionGroups",
|
|
"input": {
|
|
"shape_name": "DescribeOptionGroupsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.\n </p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n \n "
|
|
},
|
|
"EngineName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Filters the list of option groups to only include groups associated with a specific database engine.\n </p>\n "
|
|
},
|
|
"MajorEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "OptionGroups",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupsList": {
|
|
"shape_name": "OptionGroupsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "OptionGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the option group.\n </p>\n "
|
|
},
|
|
"OptionGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the option group.\n </p>\n "
|
|
},
|
|
"EngineName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Engine name that this option group can be applied to.\n </p>\n "
|
|
},
|
|
"MajorEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the major engine version associated with this option group.\n </p>\n "
|
|
},
|
|
"Options": {
|
|
"shape_name": "OptionsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Option",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option.\n </p>\n "
|
|
},
|
|
"OptionDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the option.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n If required, the port configured for this option to use.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupMemberships": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n If the Option requires access to a port, then this DB Security Group allows access to the port. \n </p>\n "
|
|
},
|
|
"VpcSecurityGroupMemberships": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n If the Option requires access to a port, then this VPC Security Group allows access to the port.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Option details.\n </p>\n",
|
|
"xmlname": "Option"
|
|
},
|
|
"documentation": "\n <p>\n Indicates what options are available in the option group.\n </p>\n "
|
|
},
|
|
"AllowsVpcAndNonVpcInstanceMemberships": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value 'true' indicates the option group \n can be applied to both VPC and non-VPC instances.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n </p>\n ",
|
|
"xmlname": "OptionGroup"
|
|
},
|
|
"documentation": "\n <p>\n List of option groups.\n </p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n List of option groups.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "OptionGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The specified option group could not be found. \n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Describes the available option groups.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeOptionGroups\n &OptionGroupName=myoptiongroup\n &MaxRecords=100</queryrequest>\n <queryresponse><DescribeOptionGroupsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeOptionGroupsResult>\n <OptionGroupsList>\n <OptionGroup>\n <MajorEngineVersion>11.2</MajorEngineVersion>\n <OptionGroupName>myoptiongroup</OptionGroupName>\n <EngineName>oracle-se1</EngineName>\n <OptionGroupDescription>Test option group</OptionGroupDescription>\n <Options/>\n </OptionGroup>\n </OptionGroupsList>\n </DescribeOptionGroupsResult>\n <ResponseMetadata>\n <RequestId>6088823d-84c8-11e1-a264-0b23c28bc344</RequestId>\n </ResponseMetadata>\n </DescribeOptionGroupsResponse></queryresponse>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeOptionGroups\n &MaxRecords=100</queryrequest>\n <queryresponse><DescribeOptionGroupsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeOptionGroupsResult>\n <OptionGroupsList>\n <OptionGroup>\n <MajorEngineVersion>11.2</MajorEngineVersion>\n <OptionGroupName>myoptiongroup</OptionGroupName>\n <EngineName>oracle-se1</EngineName>\n <OptionGroupDescription>Test option group</OptionGroupDescription>\n <Options/>\n </OptionGroup>\n <OptionGroup>\n <MajorEngineVersion>11.2</MajorEngineVersion>\n <OptionGroupName>default:oracle-se1-11-2</OptionGroupName>\n <EngineName>oracle-se1</EngineName>\n <OptionGroupDescription>Default Option Group.</OptionGroupDescription>\n <Options/>\n </OptionGroup>\n </OptionGroupsList>\n </DescribeOptionGroupsResult>\n <ResponseMetadata>\n <RequestId>e4b234d9-84d5-11e1-87a6-71059839a52b</RequestId>\n </ResponseMetadata>\n </DescribeOptionGroupsResponse></queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "OptionGroupsList",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeOrderableDBInstanceOptions": {
|
|
"name": "DescribeOrderableDBInstanceOptions",
|
|
"input": {
|
|
"shape_name": "DescribeOrderableDBInstanceOptionsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p> The name of the engine to retrieve DB Instance options for. </p>\n ",
|
|
"required": true
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p> The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p> The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class. </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p> The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. </p>\n "
|
|
},
|
|
"Vpc": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p> The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings. </p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more records exist than the specified <code>MaxRecords</code> value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code> .\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "OrderableDBInstanceOptionsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"OrderableDBInstanceOptions": {
|
|
"shape_name": "OrderableDBInstanceOptionsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "OrderableDBInstanceOption",
|
|
"type": "structure",
|
|
"members": {
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The engine type of the orderable DB Instance.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The engine version of the orderable DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance Class for the orderable DB Instance \n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The license model for the orderable DB Instance. \n </p>\n "
|
|
},
|
|
"AvailabilityZones": {
|
|
"shape_name": "AvailabilityZoneList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n ",
|
|
"xmlname": "AvailabilityZone"
|
|
},
|
|
"documentation": "\n <p>\n A list of availability zones for the orderable DB Instance. \n </p>\n "
|
|
},
|
|
"MultiAZCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether this orderable DB Instance is multi-AZ capable. \n </p>\n "
|
|
},
|
|
"ReadReplicaCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether this orderable DB Instance can have a read replica.\n </p>\n "
|
|
},
|
|
"Vpc": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether this is a VPC orderable DB Instance.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains a list of available options for a DB Instance \n </p>\n <p>\n This data type is used as a response element in the <a>DescribeOrderableDBInstanceOptions</a> action.\n </p>\n ",
|
|
"xmlname": "OrderableDBInstanceOption"
|
|
},
|
|
"documentation": "\n <p>An <a>OrderableDBInstanceOption</a> structure containing information about orderable options for the DB Instance.</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n \n up to the value specified by <code>MaxRecords</code> .\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeOrderableDBInstanceOptions</a> action. \n </p>\n "
|
|
},
|
|
"errors": [],
|
|
"documentation": "\n <p> Returns a list of orderable DB Instance options for the specified engine. </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeOrderableDBInstanceOptions\n &Engine=mysql\n &MaxRecords=100\n &Version=2013-01-10\n &Timestamp=2011-05-23T07%3A49%3A17.749Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeOrderableDBInstanceOptionsResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeOrderableDBInstanceOptionsResult>\n <!-- NOTE: Example truncated for space -->\n <OrderableDBInstanceOptions>\n <OrderableDBInstanceOption>\n <MultiAZCapable>true</MultiAZCapable>\n <Engine>mysql</Engine>\n <LicenseModel>general-public-license</LicenseModel>\n <ReadReplicaCapable>true</ReadReplicaCapable>\n <EngineVersion>5.1.45</EngineVersion>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <AvailabilityZones>\n <AvailabilityZone>\n <Name>us-east-1a</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1b</Name>\n <ProvisionedIopsCapable>no</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1d</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n </AvailabilityZones>\n </OrderableDBInstanceOption>\n <OrderableDBInstanceOption>\n <MultiAZCapable>true</MultiAZCapable>\n <Engine>mysql</Engine>\n <LicenseModel>general-public-license</LicenseModel>\n <ReadReplicaCapable>true</ReadReplicaCapable>\n <EngineVersion>5.1.45</EngineVersion>\n <DBInstanceClass>db.m1.small</DBInstanceClass>\n <AvailabilityZones>\n <AvailabilityZone>\n <Name>us-east-1a</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1b</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1d</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n </AvailabilityZones>\n </OrderableDBInstanceOption>\n <OrderableDBInstanceOption>\n <MultiAZCapable>true</MultiAZCapable>\n <Engine>mysql</Engine>\n <LicenseModel>general-public-license</LicenseModel>\n <ReadReplicaCapable>true</ReadReplicaCapable>\n <EngineVersion>5.1.45</EngineVersion>\n <DBInstanceClass>db.m1.xlarge</DBInstanceClass>\n <AvailabilityZones>\n <AvailabilityZone>\n <Name>us-east-1a</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1b</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1d</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n </AvailabilityZones>\n </OrderableDBInstanceOption>\n <OrderableDBInstanceOption>\n <MultiAZCapable>true</MultiAZCapable>\n <Engine>mysql</Engine>\n <LicenseModel>general-public-license</LicenseModel>\n <ReadReplicaCapable>true</ReadReplicaCapable>\n <EngineVersion>5.1.45</EngineVersion>\n <DBInstanceClass>db.m2.2xlarge</DBInstanceClass>\n <AvailabilityZones>\n <AvailabilityZone>\n <Name>us-east-1a</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1b</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1d</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n </AvailabilityZones>\n </OrderableDBInstanceOption>\n <OrderableDBInstanceOption>\n <MultiAZCapable>true</MultiAZCapable>\n <Engine>mysql</Engine>\n <LicenseModel>general-public-license</LicenseModel>\n <ReadReplicaCapable>true</ReadReplicaCapable>\n <EngineVersion>5.1.45</EngineVersion>\n <DBInstanceClass>db.m2.4xlarge</DBInstanceClass>\n <AvailabilityZones>\n <AvailabilityZone>\n <Name>us-east-1a</Name>\n <ProvisionedIopsCapable>yes</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1b</Name>\n <ProvisionedIopsCapable>no</ProvisionedIopsCapable>\n </AvailabilityZone>\n <AvailabilityZone>\n <Name>us-east-1d</Name>\n <ProvisionedIopsCapable>no</ProvisionedIopsCapable>\n </AvailabilityZone>\n </AvailabilityZones>\n </OrderableDBInstanceOption>\n </OrderableDBInstanceOptions>\n </DescribeOrderableDBInstanceOptionsResult>\n <ResponseMetadata>\n <RequestId>2a0406d7-8511-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</DescribeOrderableDBInstanceOptionsResponse>\n</queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "OrderableDBInstanceOptions",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeReservedDBInstances": {
|
|
"name": "DescribeReservedDBInstances",
|
|
"input": {
|
|
"shape_name": "DescribeReservedDBInstancesMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"ReservedDBInstanceId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The reserved DB Instance identifier filter value.\n Specify this parameter to show only the reservation\n that matches the specified reservation ID.\n </p>\n "
|
|
},
|
|
"ReservedDBInstancesOfferingId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The offering identifier filter value.\n Specify this parameter to show only purchased reservations\n matching the specified offering identifier.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance class filter value.\n Specify this parameter to show only those reservations\n matching the specified DB Instances class.\n </p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The duration filter value, specified in years or seconds.\n Specify this parameter to show only reservations for this duration.\n </p>\n <p>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></p>\n "
|
|
},
|
|
"ProductDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The product description filter value.\n Specify this parameter to show only those reservations\n matching the specified product description.\n </p>\n "
|
|
},
|
|
"OfferingType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The offering type filter value.\n Specify this parameter to show only the available\n offerings matching the specified offering type.\n </p>\n <p>Valid Values: <code>\"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\" </code></p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n The Multi-AZ filter value. Specify this parameter to show only\n those reservations matching the specified Multi-AZ parameter.\n </p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is\n included in the response so that the following results can be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p>"
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n \n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ReservedDBInstanceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"ReservedDBInstances": {
|
|
"shape_name": "ReservedDBInstanceList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ReservedDBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"ReservedDBInstanceId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The unique identifier for the reservation.\n </p>\n "
|
|
},
|
|
"ReservedDBInstancesOfferingId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The offering identifier.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB instance class for the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"StartTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n The time the reservation started.\n </p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The duration of the reservation in seconds.\n </p>\n "
|
|
},
|
|
"FixedPrice": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The fixed price charged for this reserved DB Instance.\n </p>\n "
|
|
},
|
|
"UsagePrice": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The hourly price charged for this reserved DB Instance.\n </p>\n "
|
|
},
|
|
"CurrencyCode": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The currency code for the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceCount": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The number of reserved DB Instances.\n </p>\n "
|
|
},
|
|
"ProductDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"OfferingType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": " \n <p>\n The offering type of this reserved DB Instance. \n </p> \n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates if the reservation applies to Multi-AZ deployments.\n </p>\n "
|
|
},
|
|
"State": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The state of the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"RecurringCharges": {
|
|
"shape_name": "RecurringChargeList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "RecurringCharge",
|
|
"type": "structure",
|
|
"members": {
|
|
"RecurringChargeAmount": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The amount of the recurring charge.\n </p>\n "
|
|
},
|
|
"RecurringChargeFrequency": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The frequency of the recurring charge.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n This data type is used as a response element in the \n <a>DescribeReservedDBInstances</a> and <a>DescribeReservedDBInstancesOfferings</a> actions.\n </p>\n ",
|
|
"xmlname": "RecurringCharge"
|
|
},
|
|
"documentation": " \n <p>\n The recurring price charged to run this reserved DB Instance. \n </p> \n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n This data type is used as a response element in the \n <a>DescribeReservedDBInstances</a> and \n <a>PurchaseReservedDBInstancesOffering</a> actions.\n </p>\n ",
|
|
"xmlname": "ReservedDBInstance"
|
|
},
|
|
"documentation": "\n <p>\n A list of of reserved DB Instances.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeReservedDBInstances</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ReservedDBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified reserved DB Instance not found.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Returns information about reserved DB Instances for this account,\n or about a specified reserved DB Instance.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeReservedDBInstances\n &ReservedDBInstanceId=customerSpecifiedID\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2012-12-18T18%3A31%3A36.118Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeReservedDBInstancesResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <DescribeReservedDBInstancesResult>\n <ReservedDBInstances>\n <ReservedDBInstance>\n <OfferingType>Medium Utilization</OfferingType>\n <CurrencyCode>USD</CurrencyCode>\n <RecurringCharges/>\n <ProductDescription>mysql</ProductDescription>\n <ReservedDBInstancesOfferingId>649fd0c8-cf6d-47a0-bfa6-060f8e75e95f</ReservedDBInstancesOfferingId>\n <MultiAZ>false</MultiAZ>\n <State>active</State>\n <ReservedDBInstanceId>myreservationid</ReservedDBInstanceId>\n <DBInstanceCount>1</DBInstanceCount>\n <StartTime>2010-12-15T00:25:14.131Z</StartTime>\n <Duration>31536000</Duration>\n <FixedPrice>227.5</FixedPrice>\n <UsagePrice>0.046</UsagePrice>\n <DBInstanceClass>db.m1.small</DBInstanceClass>\n </ReservedDBInstance> \n </DescribeReservedDBInstancesResult>\n <ResponseMetadata>\n <RequestId>c695119b-2961-11e1-bd06-6fe008f046c3</RequestId>\n </ResponseMetadata>\n</DescribeReservedDBInstancesResponse>\n</queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "ReservedDBInstances",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"DescribeReservedDBInstancesOfferings": {
|
|
"name": "DescribeReservedDBInstancesOfferings",
|
|
"input": {
|
|
"shape_name": "DescribeReservedDBInstancesOfferingsMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"ReservedDBInstancesOfferingId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The offering identifier filter value.\n Specify this parameter to show only the available offering\n that matches the specified reservation identifier.\n </p>\n <p>Example: <code>438012d3-4052-4cc7-b2e3-8d3372e0e706</code></p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance class filter value.\n Specify this parameter to show only the available offerings\n matching the specified DB Instance class.\n </p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Duration filter value, specified in years or seconds.\n Specify this parameter to show only reservations for this duration.\n </p>\n <p>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></p>\n "
|
|
},
|
|
"ProductDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Product description filter value.\n Specify this parameter to show only the available\n offerings matching the specified product description.\n </p>\n "
|
|
},
|
|
"OfferingType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The offering type filter value.\n Specify this parameter to show only the available\n offerings matching the specified offering type.\n </p>\n <p>Valid Values: <code>\"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\" </code></p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n The Multi-AZ filter value.\n Specify this parameter to show only the available\n offerings matching the specified Multi-AZ parameter.\n </p>\n "
|
|
},
|
|
"MaxRecords": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The maximum number of records to include in the response.\n If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is\n included in the response so that the following results can be retrieved.\n </p>\n <p>Default: 100</p>\n <p>Constraints: minimum 20, maximum 100</p> "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n \n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ReservedDBInstancesOfferingMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by <code>MaxRecords</code>.\n </p>\n "
|
|
},
|
|
"ReservedDBInstancesOfferings": {
|
|
"shape_name": "ReservedDBInstancesOfferingList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ReservedDBInstancesOffering",
|
|
"type": "structure",
|
|
"members": {
|
|
"ReservedDBInstancesOfferingId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The offering identifier.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB instance class for the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The duration of the offering in seconds.\n </p>\n "
|
|
},
|
|
"FixedPrice": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The fixed price charged for this offering.\n </p>\n "
|
|
},
|
|
"UsagePrice": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The hourly price charged for this offering.\n </p>\n "
|
|
},
|
|
"CurrencyCode": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The currency code for the reserved DB Instance offering.\n </p>\n "
|
|
},
|
|
"ProductDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The database engine used by the offering.\n </p>\n "
|
|
},
|
|
"OfferingType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": " \n <p>\n The offering type. \n </p> \n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates if the offering applies to Multi-AZ deployments.\n </p>\n "
|
|
},
|
|
"RecurringCharges": {
|
|
"shape_name": "RecurringChargeList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "RecurringCharge",
|
|
"type": "structure",
|
|
"members": {
|
|
"RecurringChargeAmount": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The amount of the recurring charge.\n </p>\n "
|
|
},
|
|
"RecurringChargeFrequency": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The frequency of the recurring charge.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n This data type is used as a response element in the \n <a>DescribeReservedDBInstances</a> and <a>DescribeReservedDBInstancesOfferings</a> actions.\n </p>\n ",
|
|
"xmlname": "RecurringCharge"
|
|
},
|
|
"documentation": " \n <p>\n The recurring price charged to run this reserved DB Instance. \n </p> \n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeReservedDBInstancesOfferings</a> action.\n </p>\n\n ",
|
|
"xmlname": "ReservedDBInstancesOffering"
|
|
},
|
|
"documentation": "\n <p>\n A list of reserved DB Instance offerings.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the <a>DescribeReservedDBInstancesOfferings</a> action. \n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ReservedDBInstancesOfferingNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Specified offering does not exist.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Lists available reserved DB Instance offerings.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=DescribeReservedDBInstancesOfferings\n &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-12-18T18%3A31%3A36.118Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><DescribeReservedDBInstancesOfferingsResponse xmlns=\"http://rds.amazonaws.com/do\nc/2012-04-02/\">\n <DescribeReservedDBInstancesOfferingsResult>\n <ReservedDBInstancesOfferings>\n <ReservedDBInstancesOffering>\n <Duration>31536000</Duration>\n <OfferingType>Heavy Utilization</OfferingType>\n <CurrencyCode>USD</CurrencyCode>\n <RecurringCharges> \n <RecurringCharge>\n <RecurringChargeFrequency>Hourly</RecurringChargeFrequency>\n <RecurringChargeAmount>0.123</RecurringChargeAmount>\n </RecurringCharge>\n </RecurringCharges>\n <FixedPrice>162.0</FixedPrice>\n <ProductDescription>mysql</ProductDescription>\n <UsagePrice>0.0</UsagePrice>\n <MultiAZ>false</MultiAZ>\n <ReservedDBInstancesOfferingId>SampleOfferingId</ReservedDBInstancesOfferingId>\n <DBInstanceClass>db.m1.small</DBInstanceClass>\n </ReservedDBInstancesOffering>\n </ReservedDBInstancesOfferings>\n </DescribeReservedDBInstancesOfferingsResult>\n <ResponseMetadata>\n <RequestId>521b420a-2961-11e1-bd06-6fe008f046c3</RequestId>\n </ResponseMetadata>\n</DescribeReservedDBInstancesOfferingsResponse>\n\n</queryresponse>\n </examples>\n ",
|
|
"pagination": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "ReservedDBInstancesOfferings",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"ListTagsForResource": {
|
|
"name": "ListTagsForResource",
|
|
"input": {
|
|
"shape_name": "ListTagsForResourceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"ResourceName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The DB Instance with tags to be listed.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "TagListMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"TagList": {
|
|
"shape_name": "TagList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Tag",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>\n "
|
|
},
|
|
"Value": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Metadata assigned to a DB Instance consisting of a key-value pair.</p>\n ",
|
|
"xmlname": "Tag"
|
|
},
|
|
"documentation": "\n <p>List of tags returned by the ListTagsForResource operation.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p></p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSnapshotNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> does not refer to an existing DB Snapshot.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p> Lists all tags on a DB Instance.</p>\n <p>For an overview on tagging DB Instances, see <a href=\"http://docs.amazonwebservices.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html\">DB Instance Tags.</a></p>\n "
|
|
},
|
|
"ModifyDBInstance": {
|
|
"name": "ModifyDBInstance",
|
|
"input": {
|
|
"shape_name": "ModifyDBInstanceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance identifier.\n This value is stored as a lowercase string. \n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be the identifier for an existing DB Instance</li>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n \n ",
|
|
"required": true
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The new storage capacity of the RDS instance.\n Changing this parameter does not result in an outage and\n the change is applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is set\n to <code>true</code> for this request.\n </p>\n <p><b>MySQL</b></p>\n <p>Default: Uses existing setting</p>\n <p>Valid Values: 5-1024</p>\n <p>Constraints: Value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.</p>\n <p>Type: Integer</p>\n <p><b>Oracle</b></p>\n <p>Default: Uses existing setting</p>\n <p>Valid Values: 10-1024</p>\n <p>Constraints: Value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.</p> \n <p><b>SQL Server</b></p>\n <p>Cannot be modified.</p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular \n DB engine, use the <a>DescribeOrderableDBInstanceOptions</a> action.\n </p>\n <p>\n Passing a value for this parameter causes an outage during the change and\n is applied during the next maintenance window,\n unless the <code>ApplyImmediately</code> parameter is specified\n as <code>true</code> for this request.\n </p>\n <p>Default: Uses existing setting</p>\n <p>Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge</code></p>\n \n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupNameList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "DBSecurityGroupName"
|
|
},
|
|
"documentation": "\n <p>\n A list of DB Security Groups to authorize on this DB Instance.\n Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n "
|
|
},
|
|
"VpcSecurityGroupIds": {
|
|
"shape_name": "VpcSecurityGroupIdList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "VpcSecurityGroupId"
|
|
},
|
|
"documentation": "\n <p>\n A list of EC2 VPC Security Groups to authorize on this DB Instance.\n This change is asynchronously applied as soon as possible.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n "
|
|
},
|
|
"ApplyImmediately": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies whether or not the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n <code>PreferredMaintenanceWindow</code> setting for the DB Instance.\n </p>\n <p>\n If this parameter is passed as <code>false</code>, changes to the\n DB Instance are applied on the next call to\n <a>RebootDBInstance</a>,\n the next maintenance reboot, or the next failure reboot,\n whichever occurs first. See each parameter to determine when a change is applied.\n </p>\n <p>Default: <code>false</code></p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The new password for the DB Instance master user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".</p>\n <p>\n Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the <code>MasterUserPassword</code> element exists in the\n <code>PendingModifiedValues</code> element of the operation response.\n </p>\n <p>Default: Uses existing setting</p>\n <p>Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 \n alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).</p>\n <note>\n Amazon RDS API actions never return the password, so this action provides a way to \n regain access to a master instance user if the password is lost.\n </note>\n "
|
|
},
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group to apply to this DB Instance. \n Changing this parameter does not result in an outage and the change \n is applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is set\n to <code>true</code> for this request.\n </p>\n <p>Default: Uses existing setting</p>\n <p>Constraints: The DB Parameter Group must be in the same DB \n Parameter Group family as this DB Instance.</p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The number of days to retain automated backups.\n Setting this parameter to a positive number enables backups.\n Setting this parameter to 0 disables automated backups.\n </p>\n <p>Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. \n These changes are applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is set\n to <code>true</code> for this request. If you change the parameter from one non-zero value to another \n non-zero value, the change is asynchronously applied as soon as possible.</p>\n \n <p>Default: Uses existing setting</p>\n <p>Constraints:</p>\n <ul>\n <li>Must be a value from 0 to 8</li>\n <li>Cannot be set to 0 if the DB Instance is a master instance \n with read replicas or if the DB Instance is a read replica</li>\n </ul>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the <code>BackupRetentionPeriod</code>. \n Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be in the format hh24:mi-hh24:mi</li>\n <li>Times should be Universal Time Coordinated (UTC)</li>\n <li>Must not conflict with the preferred maintenance window</li>\n <li>Must be at least 30 minutes</li>\n </ul>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The weekly time range (in UTC) during which system maintenance can occur,\n which may result in an outage. Changing this parameter does not result in an outage, except in the following situation,\n and the change is asynchronously applied as soon as possible.\n If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this\n parameter will cause a reboot of the DB Instance.\n If moving this window to the current time,\n there must be at least 30 minutes between the current time and\n end of the window to ensure pending changes are applied.\n </p>\n <p>Default: Uses existing setting</p>\n <p>Format: ddd:hh24:mi-ddd:hh24:mi</p>\n <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p>\n <p>Constraints: Must be at least 30 minutes</p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment. \n Changing this parameter does not result in an outage and the change \n is applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is set\n to <code>true</code> for this request.\n </p>\n <p>Constraints: Cannot be specified if the DB Instance is a read replica.</p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is set\n to <code>true</code> for this request.\n </p>\n <p>\n For major version upgrades, if a nondefault DB Parameter Group is currently in use,\n a new DB Parameter Group in the DB Parameter Group Family\n for the new engine version must be specified.\n The new DB Parameter Group can be the default for that DB Parameter Group Family.\n </p>\n <p>Example: <code>5.1.42</code></p>\n "
|
|
},
|
|
"AllowMajorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that major version upgrades are allowed. \n Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.\n </p>\n <p>Constraints: This parameter must be set to true when \n specifying a value for the EngineVersion parameter that is \n a different major version than the DB Instance's current version.</p>\n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version upgrades will be applied automatically\n to the DB Instance during the maintenance window. \n Changing this parameter does not result in an outage except in the following case \n and the change is asynchronously applied as soon as possible.\n An outage will result if this parameter is set to <code>true</code> during the maintenance window, \n and a newer minor version is available, and RDS has enabled auto patching for that engine version.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The new Provisioned IOPS (I/O operations per second) value for the RDS instance. \n Changing this parameter does not result in an outage and\n the change is applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is set\n to <code>true</code> for this request.\n </p>\n <p>Default: Uses existing setting</p>\n <p>Constraints: Value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.</p>\n <p>Type: Integer</p>\n "
|
|
},
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates that the DB Instance should be associated with the specified option group. \n Changing this parameter does not result in an outage except in the following case and the change \n is applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is set\n to <code>true</code> for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n </p>\n "
|
|
},
|
|
"NewDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The new DB Instance identifier for the DB Instance when renaming a DB\n Instance.\n This value is stored as a lowercase string. \n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstance": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidDBInstanceStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified DB Instance is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBSecurityGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The state of the DB Security Group does not allow deletion.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBInstanceAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n User already has a DB Instance with the given identifier.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSecurityGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSecurityGroupName</i> does not refer to an existing DB Security Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBParameterGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBParameterGroupName</i> does not refer to an\n existing DB Parameter Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InsufficientDBInstanceCapacityFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Specified DB Instance class is not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "StorageQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the\n allowed amount of storage available across all DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidVPCNetworkStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n DB Subnet Group does not cover all availability zones after it is created because users' change.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ProvisionedIopsNotAvailableInAZFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Provisioned IOPS not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "OptionGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The specified option group could not be found. \n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBUpgradeDependencyFailureFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Modify settings for a DB Instance. You can change one\n or more database configuration parameters by specifying these parameters and the new values in the\n request.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=ModifyDBInstance\n &DBInstanceIdentifier=simcoprod01\n &AllocatedStorage=50\n &Version=2013-01-10\n &ApplyImmediately=false\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T08%3A02%3A09.574Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><ModifyDBInstanceResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ModifyDBInstanceResult>\n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <LatestRestorableTime>2011-05-23T08:00:00Z</LatestRestorableTime>\n <Engine>mysql</Engine>\n <PendingModifiedValues>\n <AllocatedStorage>50</AllocatedStorage>\n </PendingModifiedValues>\n <BackupRetentionPeriod>1</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBInstanceStatus>available</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <Endpoint>\n <Port>3306</Port>\n <Address>simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com</Address>\n </Endpoint>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>\n <AvailabilityZone>us-east-1a</AvailabilityZone>\n <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </ModifyDBInstanceResult>\n <ResponseMetadata>\n <RequestId>f61a020f-8512-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</ModifyDBInstanceResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"ModifyDBParameterGroup": {
|
|
"name": "ModifyDBParameterGroup",
|
|
"input": {
|
|
"shape_name": "ModifyDBParameterGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be the name of an existing DB Parameter Group</li>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
},
|
|
"Parameters": {
|
|
"shape_name": "ParametersList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Parameter",
|
|
"type": "structure",
|
|
"members": {
|
|
"ParameterName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the parameter.\n </p>\n "
|
|
},
|
|
"ParameterValue": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the value of the parameter.\n </p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides a description of the parameter.\n </p>\n "
|
|
},
|
|
"Source": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the source of the parameter value.\n </p>\n "
|
|
},
|
|
"ApplyType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the engine specific parameters type.\n </p>\n "
|
|
},
|
|
"DataType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the valid data type for the parameter.\n </p>\n "
|
|
},
|
|
"AllowedValues": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the valid range of values for the parameter.\n </p>\n "
|
|
},
|
|
"IsModifiable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n </p>\n "
|
|
},
|
|
"MinimumEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The earliest engine version to which the parameter can apply.\n </p>\n "
|
|
},
|
|
"ApplyMethod": {
|
|
"shape_name": "ApplyMethod",
|
|
"type": "string",
|
|
"enum": [
|
|
"immediate",
|
|
"pending-reboot"
|
|
],
|
|
"documentation": "\n <p>\n Indicates when to apply parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a request parameter in the\n <a>ModifyDBParameterGroup</a> and <a>ResetDBParameterGroup</a> actions.\n </p>\n <p>This data type is used as a response element in the \n <a>DescribeEngineDefaultParameters</a> and <a>DescribeDBParameters</a> actions.</p>\n ",
|
|
"xmlname": "Parameter"
|
|
},
|
|
"documentation": "\n <p>\n An array of parameter names, values, and the apply method\n for the parameter update. At least one parameter name,\n value, and apply method must be supplied; subsequent arguments are optional.\n A maximum of 20 parameters may be modified in a single request.\n </p>\n <p>Valid Values (for the application method): <code>immediate | pending-reboot</code></p>\n <note>You can use the immediate value with dynamic parameters only. \n You can use the pending-reboot value for both dynamic and static parameters, \n and changes are applied when DB Instance reboots. </note>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBParameterGroupNameMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the \n <a>ModifyDBParameterGroup</a> or <a>ResetDBParameterGroup</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBParameterGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBParameterGroupName</i> does not refer to an\n existing DB Parameter Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBParameterGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The DB Parameter Group cannot be deleted because it is in use.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Modifies the parameters of a DBParameterGroup. To modify more than one parameter\n submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.\n </p>\n <note>\n <p>\n The <code>apply-immediate</code> method can be used only for\n dynamic parameters; the <code>pending-reboot</code> method can be used\n with MySQL and Oracle DB Instances for either dynamic or static parameters. For \n Microsoft SQL Server DB Instances, the <code>pending-reboot</code> method can \n be used only for static parameters. \n </p>\n </note>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=ModifyDBParameterGroup\n &DBParameterGroupName=mydbparametergroup\n &Parameters.member.1.ParameterName=max_user_connections\n &Parameters.member.1.ParameterValue=24\n &Parameters.member.1.ApplyMethod=pending-reboot\n &Parameters.member.2.ParameterName=max_allowed_packet\n &Parameters.member.2.ParameterValue=1024\n &Parameters.member.2.ApplyMethod=immediate\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-11T21%3A25%3A00.686Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><ModifyDBParameterGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ModifyDBParameterGroupResult>\n <DBParameterGroupName>mydbparametergroup</DBParameterGroupName>\n </ModifyDBParameterGroupResult>\n <ResponseMetadata>\n <RequestId>5ba91f97-bf51-11de-bf60-ef2e377db6f3</RequestId>\n </ResponseMetadata>\n</ModifyDBParameterGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"ModifyDBSubnetGroup": {
|
|
"name": "ModifyDBSubnetGroup",
|
|
"input": {
|
|
"shape_name": "ModifyDBSubnetGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name for the DB Subnet Group.\n This value is stored as a lowercase string.\n </p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".</p>\n \n <p>Example: <code>mySubnetgroup</code></p>\n ",
|
|
"required": true
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description for the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetIds": {
|
|
"shape_name": "SubnetIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SubnetIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n The EC2 Subnet IDs for the DB Subnet Group.\n </p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSubnetGroupWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBSubnetGroup</a></li>\n <li><a>ModifyDBSubnetGroup</a></li>\n <li><a>DescribeDBSubnetGroups</a></li>\n <li><a>DeleteDBSubnetGroup</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSubnetGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSubnetGroupName</i> does not refer to an existing DB Subnet Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of subnets in a DB subnet Groups.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SubnetAlreadyInUse",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The DB subnet is already in use in the availability zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Subnets in the DB subnet group should cover at least 2 availability zones unless there's'only 1 available zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidSubnet",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request subnet is valid, or all subnets are not in common Vpc. \n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=ModifyDBSubnetGroup\n &DBSubnetGroupName=mydbsubnetgroup\n &DBSubnetGroupDescription=My%20modified%20DBSubnetGroup\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T18%3A14%3A49.482Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><ModifyDBSubnetGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ModifyDBSubnetGroupResult>\n <DBSubnetGroup>\n <VpcId>990524496922</VpcId>\n <SubnetGroupStatus>Complete</SubnetGroupStatus>\n <DBSubnetGroupDescription>My modified DBSubnetGroup</DBSubnetGroupDescription>\n <DBSubnetGroupName>mydbsubnetgroup</DBSubnetGroupName>\n <Subnets>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1c</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1b</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1d</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n </Subnets>\n </DBSubnetGroup> \n </ModifyDBSubnetGroupResult>\n <ResponseMetadata>\n <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>\n </ResponseMetadata>\n </ModifyDBSubnetGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"ModifyEventSubscription": {
|
|
"name": "ModifyEventSubscription",
|
|
"input": {
|
|
"shape_name": "ModifyEventSubscriptionMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubscriptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the RDS event notification subscription.</p>\n ",
|
|
"required": true
|
|
},
|
|
"SnsTopicArn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create \n a topic and subscribe to it.\n </p>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, \n you would set this parameter to db-instance. if this value is not specified, all events are returned.\n </p>\n <p>Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot</p>\n "
|
|
},
|
|
"EventCategories": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>\n A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType \n in the <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">Events</a> topic in the Amazon RDS User Guide \n or by using the <b>DescribeEventCategories</b> action.\n </p> \n "
|
|
},
|
|
"Enabled": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n A Boolean value; set to <b>true</b> to activate the subscription.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": " \n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EventSubscriptionWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"EventSubscription": {
|
|
"shape_name": "EventSubscription",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>Not used.</p> \n "
|
|
},
|
|
"CustomerAwsId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The AWS customer account associated with the RDS event notification subscription.</p>\n "
|
|
},
|
|
"CustSubscriptionId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The RDS event notification subscription Id.</p>\n "
|
|
},
|
|
"SnsTopicArn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The topic ARN of the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The status of the RDS event notification subscription.</p>\n <p>Constraints:</p>\n <p>Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist</p>\n <p>The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.</p>\n "
|
|
},
|
|
"SubscriptionCreationTime": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The time the RDS event notification subscription was created.</p>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The source type for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"SourceIdsList": {
|
|
"shape_name": "SourceIdsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SourceId"
|
|
},
|
|
"documentation": "\n <p>A list of source Ids for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"EventCategoriesList": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>A list of event categories for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Enabled": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.</p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>Contains the results of a successful invocation of the <a>DescribeEventSubscriptions</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "EventSubscriptionQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>You have reached the maximum number of event subscriptions.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SubscriptionNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The subscription name does not exist.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SNSInvalidTopicFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>SNS has responded that there is a problem with the SND topic specified.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SNSNoAuthorizationFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>You do not have permission to publish to the SNS topic ARN.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SNSTopicArnNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The SNS topic ARN does not exist.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SubscriptionCategoryNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The supplied category does not exist.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change \n source identifiers for a subscription, use the <a>AddSourceIdentifierToSubscription</a> and <a>RemoveSourceIdentifierFromSubscription</a> calls.</p>\n <p>You can see a list of the event categories for a given SourceType \n in the <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">Events</a> topic in the Amazon RDS User Guide \n or by using the <b>DescribeEventCategories</b> action.</p> \n <examples>\n <queryrequest>https://rds.us-east-1.amazonaws.com/\n ?Action=ModifyEventSubscription\n &SubscriptionName=EventSubscription01\n &EventCategories.member.1=creation\n &EventCategories.member.2=deletion\n &SourceType=db-instance\n &Enabled=true\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T005359Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature>\n </queryrequest>\n \n <queryresponse>\n <ModifyEventSubscriptionResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ModifyEventSubscriptionResult>\n <EventSubscription>\n <Enabled>true</Enabled>\n <CustomerAwsId>012345678901</CustomerAwsId>\n <SourceType>db-instance</SourceType>\n <Status>modifying</Status>\n <SubscriptionCreationTime>2013-01-28 00:29:23.736</SubscriptionCreationTime>\n <EventCategoriesList>\n <EventCategory>creation</EventCategory>\n <EventCategory>deletion</EventCategory>\n </EventCategoriesList>\n <CustSubscriptionId>EventSubscription01</CustSubscriptionId>\n <SnsTopicArn>arn:aws:sns:us-east-1:012345678901:EventSubscription01</SnsTopicArn>\n </EventSubscription>\n </ModifyEventSubscriptionResult>\n <ResponseMetadata>\n <RequestId>34907d48-68e5-11e2-98ef-2b071ac20a57</RequestId>\n </ResponseMetadata>\n </ModifyEventSubscriptionResponse>\n </queryresponse> \n </examples>\n "
|
|
},
|
|
"ModifyOptionGroup": {
|
|
"name": "ModifyOptionGroup",
|
|
"input": {
|
|
"shape_name": "ModifyOptionGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group to be modified.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"OptionsToInclude": {
|
|
"shape_name": "OptionConfigurationList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "OptionConfiguration",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The configuration of options to include in a group. \n </p>\n ",
|
|
"required": true
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The optional port for the option.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupMemberships": {
|
|
"shape_name": "DBSecurityGroupNameList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "DBSecurityGroupName"
|
|
},
|
|
"documentation": "\n <p>\n A list of DBSecurityGroupMemebrship name strings used for this option. \n </p>\n "
|
|
},
|
|
"VpcSecurityGroupMemberships": {
|
|
"shape_name": "VpcSecurityGroupIdList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "VpcSecurityGroupId"
|
|
},
|
|
"documentation": "\n <p>\n A list of VpcSecurityGroupMemebrship name strings used for this option. \n </p>\n "
|
|
}
|
|
},
|
|
"documentation": " \n <p>\n A list of all available options\n </p>\n ",
|
|
"xmlname": "OptionConfiguration"
|
|
},
|
|
"documentation": "\n <p>\n Options in this list are added to the Option Group or, if already present,\n the specified configuration is used to update the existing configuration.\n </p>\n "
|
|
},
|
|
"OptionsToRemove": {
|
|
"shape_name": "OptionNamesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>\n Options in this list are removed from the Option Group.\n </p>\n "
|
|
},
|
|
"ApplyImmediately": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether the changes should be applied immediately,\n or during the next maintenance window for each instance associated with the Option Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "OptionGroupWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroup": {
|
|
"shape_name": "OptionGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the option group.\n </p>\n "
|
|
},
|
|
"OptionGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the option group.\n </p>\n "
|
|
},
|
|
"EngineName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Engine name that this option group can be applied to.\n </p>\n "
|
|
},
|
|
"MajorEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the major engine version associated with this option group.\n </p>\n "
|
|
},
|
|
"Options": {
|
|
"shape_name": "OptionsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Option",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option.\n </p>\n "
|
|
},
|
|
"OptionDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the option.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n If required, the port configured for this option to use.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupMemberships": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n If the Option requires access to a port, then this DB Security Group allows access to the port. \n </p>\n "
|
|
},
|
|
"VpcSecurityGroupMemberships": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n If the Option requires access to a port, then this VPC Security Group allows access to the port.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Option details.\n </p>\n",
|
|
"xmlname": "Option"
|
|
},
|
|
"documentation": "\n <p>\n Indicates what options are available in the option group.\n </p>\n "
|
|
},
|
|
"AllowsVpcAndNonVpcInstanceMemberships": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value 'true' indicates the option group \n can be applied to both VPC and non-VPC instances.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n </p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidOptionGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The Option Group is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "OptionGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The specified option group could not be found. \n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Modifies an existing Option Group. \n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=ModifyOptionGroup\n &OptionGroupName=myoptiongroup\n &OptionsToInclude=OEM\n &DBSecurityGroupMemberships=default\n &ApplyImmediately=true</queryrequest>\n <queryresponse><ModifyOptionGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ModifyOptionGroupResult>\n <OptionGroup>\n <OptionGroupName>myoptiongroup</OptionGroupName>\n <OptionGroupDescription>Test Option Group</OptionGroupDescription>\n <EngineName>oracle-se1</EngineName>\n <MajorEngineVersion>11.2</MajorEngineVersion>\n <Options>\n <Option>\n <OptionName>OEM</OptionName>\n <OptionDescription>Oracle Enterprise Manager</OptionDescription>\n <Port>1158</Port>\n <DBSecurityGroupMembership>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n <Status>ACTIVE</Status>\n </DBSecurityGroupMembership>\n </Option>\n </Options>\n </OptionGroup>\n </ModifyOptionGroupResult>\n <ResponseMetadata>\n <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>\n </ResponseMetadata>\n </ModifyOptionGroupResponse></queryresponse>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=ModifyOptionGroup\n &OptionGroupName=myoptiongroup\n &OptionsToRemove=OEM\n &ApplyImmediately=true</queryrequest>\n <queryresponse><ModifyOptionGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ModifyOptionGroupResult>\n <OptionGroup>\n <OptionGroupName>myoptiongroup</OptionGroupName>\n <OptionGroupDescription>Test Option Group</OptionGroupDescription>\n <EngineName>oracle-se1</EngineName>\n <MajorEngineVersion>11.2</MajorEngineVersion>\n <Options/>\n </OptionGroup>\n </ModifyOptionGroupResult>\n <ResponseMetadata>\n <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>\n </ResponseMetadata>\n </ModifyOptionGroupResponse></queryresponse> \n </examples>\n "
|
|
},
|
|
"PromoteReadReplica": {
|
|
"name": "PromoteReadReplica",
|
|
"input": {
|
|
"shape_name": "PromoteReadReplicaMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance identifier.\n This value is stored as a lowercase string.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be the identifier for an existing Read Replica DB Instance</li>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n <p>Example: <copy>mydbinstance</copy></p>\n ",
|
|
"required": true
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The number of days to retain automated backups.\n Setting this parameter to a positive number enables backups.\n Setting this parameter to 0 disables automated backups.\n </p>\n <p>\n Default: 1\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be a value from 0 to 8</li>\n </ul>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the <code>BackupRetentionPeriod</code> parameter.\n </p>\n <p>\n Default: A 30-minute window selected at random from an\n 8-hour block of time per region. The following list shows \n the time blocks for each region from which the default \n backup windows are assigned.\n </p>\n <ul>\n <li>\n<b>US-East (Northern Virginia) Region:</b> 03:00-11:00 UTC</li>\n <li>\n<b>US-West (Northern California) Region:</b> 06:00-14:00 UTC</li>\n <li>\n<b>EU (Ireland) Region:</b> 22:00-06:00 UTC</li>\n <li>\n<b>Asia Pacific (Singapore) Region:</b> 14:00-22:00 UTC</li>\n <li>\n<b>Asia Pacific (Tokyo) Region: </b> 17:00-03:00 UTC</li>\n </ul>\n\n <p>\n Constraints: Must be in the format <code>hh24:mi-hh24:mi</code>. \n Times should be Universal Time Coordinated (UTC). \n Must not conflict with the preferred maintenance window. Must be at least 30 minutes.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstance": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidDBInstanceStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified DB Instance is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Promotes a Read Replica DB Instance to a standalone DB Instance.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=PromoteReadReplica\n &DBInstanceIdentifier=simcoprod01\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2012-08-23T08%3A02%3A09.574Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><PromoteReadReplicaResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <PromoteReadReplicaResult>\n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <LatestRestorableTime>2011-05-23T08:00:00Z</LatestRestorableTime>\n <Engine>mysql</Engine>\n <PendingModifiedValues>\n <AllocatedStorage>50</AllocatedStorage>\n </PendingModifiedValues>\n <BackupRetentionPeriod>1</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBInstanceStatus>available</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <Endpoint>\n <Port>3306</Port>\n <Address>simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com</Address>\n </Endpoint>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>\n <AvailabilityZone>us-east-1a</AvailabilityZone>\n <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </PromoteReadReplicaResult>\n <ResponseMetadata>\n <RequestId>f61a020f-8512-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</PromoteReadReplicaResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"PurchaseReservedDBInstancesOffering": {
|
|
"name": "PurchaseReservedDBInstancesOffering",
|
|
"input": {
|
|
"shape_name": "PurchaseReservedDBInstancesOfferingMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"ReservedDBInstancesOfferingId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The ID of the Reserved DB Instance offering to purchase.\n </p>\n <p>Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706</p>\n ",
|
|
"required": true
|
|
},
|
|
"ReservedDBInstanceId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Customer-specified identifier to track this reservation.\n </p>\n <p>Example: myreservationID</p>\n "
|
|
},
|
|
"DBInstanceCount": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The number of instances to reserve.\n </p>\n <p>Default: <code>1</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n \n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ReservedDBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"ReservedDBInstance": {
|
|
"shape_name": "ReservedDBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"ReservedDBInstanceId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The unique identifier for the reservation.\n </p>\n "
|
|
},
|
|
"ReservedDBInstancesOfferingId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The offering identifier.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB instance class for the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"StartTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n The time the reservation started.\n </p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The duration of the reservation in seconds.\n </p>\n "
|
|
},
|
|
"FixedPrice": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The fixed price charged for this reserved DB Instance.\n </p>\n "
|
|
},
|
|
"UsagePrice": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The hourly price charged for this reserved DB Instance.\n </p>\n "
|
|
},
|
|
"CurrencyCode": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The currency code for the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceCount": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The number of reserved DB Instances.\n </p>\n "
|
|
},
|
|
"ProductDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The description of the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"OfferingType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": " \n <p>\n The offering type of this reserved DB Instance. \n </p> \n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates if the reservation applies to Multi-AZ deployments.\n </p>\n "
|
|
},
|
|
"State": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The state of the reserved DB Instance.\n </p>\n "
|
|
},
|
|
"RecurringCharges": {
|
|
"shape_name": "RecurringChargeList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "RecurringCharge",
|
|
"type": "structure",
|
|
"members": {
|
|
"RecurringChargeAmount": {
|
|
"shape_name": "Double",
|
|
"type": "double",
|
|
"documentation": "\n <p>\n The amount of the recurring charge.\n </p>\n "
|
|
},
|
|
"RecurringChargeFrequency": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The frequency of the recurring charge.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n This data type is used as a response element in the \n <a>DescribeReservedDBInstances</a> and <a>DescribeReservedDBInstancesOfferings</a> actions.\n </p>\n ",
|
|
"xmlname": "RecurringCharge"
|
|
},
|
|
"documentation": " \n <p>\n The recurring price charged to run this reserved DB Instance. \n </p> \n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n This data type is used as a response element in the \n <a>DescribeReservedDBInstances</a> and \n <a>PurchaseReservedDBInstancesOffering</a> actions.\n </p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ReservedDBInstancesOfferingNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Specified offering does not exist.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ReservedDBInstanceAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n User already has a reservation with the given identifier.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ReservedDBInstanceQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would exceed the user's DB Instance quota.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Purchases a reserved DB Instance offering.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=PurchaseReservedDBInstancesOffering\n &ReservedDBInstanceId=myreservationID\n &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706\n &DBInstanceCount=1\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-10T18%3A31%3A36.118Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><PurchaseReservedDBInstancesOfferingResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <PurchaseReservedDBInstancesOfferingResult>\n <ReservedDBInstance>\n <OfferingType>Medium Utilization</OfferingType>\n <CurrencyCode>USD</CurrencyCode>\n <RecurringCharges/>\n <ProductDescription>mysql</ProductDescription>\n <ReservedDBInstancesOfferingId> 438012d3-4052-4cc7-b2e3-8d3372e0e706</ReservedDBInstancesOfferingId>\n <MultiAZ>true</MultiAZ>\n <State>payment-pending</State>\n <ReservedDBInstanceId>myreservationID</ReservedDBInstanceId>\n <DBInstanceCount>10</DBInstanceCount>\n <StartTime>2011-12-18T23:24:56.577Z</StartTime>\n <Duration>31536000</Duration>\n <FixedPrice>123.0</FixedPrice>\n <UsagePrice>0.123</UsagePrice>\n <DBInstanceClass>db.m1.small</DBInstanceClass>\n </ReservedDBInstance>\n </PurchaseReservedDBInstancesOfferingResult>\n <ResponseMetadata>\n <RequestId>7f099901-29cf-11e1-bd06-6fe008f046c3</RequestId>\n </ResponseMetadata>\n</PurchaseReservedDBInstancesOfferingResponse>\n</queryresponse>\n </examples>\n "
|
|
},
|
|
"RebootDBInstance": {
|
|
"name": "RebootDBInstance",
|
|
"input": {
|
|
"shape_name": "RebootDBInstanceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Instance identifier.\n This parameter is stored as a lowercase string.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
},
|
|
"ForceFailover": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n When <code>true</code>, the reboot will be conducted through a MultiAZ failover.\n </p>\n <p>Constraint: You cannot specify <code>true</code> if the instance is not configured for MultiAZ.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstance": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidDBInstanceStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified DB Instance is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Reboots a previously provisioned RDS instance. This API results in the\n application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the\n RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS\n instance during which the RDS instance status is set to rebooting. If the RDS instance is configured \n for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event \n is created when the reboot is completed.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=RebootDBInstance\n &DBInstanceIdentifier=simcoprod01\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T06%3A10%3A31.216Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><RebootDBInstanceResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <RebootDBInstanceResult>\n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <LatestRestorableTime>2011-05-23T06:07:38.831Z</LatestRestorableTime>\n <Engine>mysql</Engine>\n <PendingModifiedValues/>\n <BackupRetentionPeriod>1</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBInstanceStatus>rebooting</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <Endpoint>\n <Port>3306</Port>\n <Address>simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com</Address>\n </Endpoint>\n <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>\n <AvailabilityZone>us-east-1a</AvailabilityZone>\n <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </RebootDBInstanceResult>\n <ResponseMetadata>\n <RequestId>5d5df758-8503-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</RebootDBInstanceResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"RemoveSourceIdentifierFromSubscription": {
|
|
"name": "RemoveSourceIdentifierFromSubscription",
|
|
"input": {
|
|
"shape_name": "RemoveSourceIdentifierFromSubscriptionMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubscriptionName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the RDS event notification subscription you want to remove a source identifier from.</p>\n ",
|
|
"required": true
|
|
},
|
|
"SourceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The source identifier to be removed from the subscription, such as the <b>DB instance identifier</b> \n for a DB instance or the name of a security group.\n </p>\n\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": " \n <p></p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "EventSubscriptionWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"EventSubscription": {
|
|
"shape_name": "EventSubscription",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>Not used.</p> \n "
|
|
},
|
|
"CustomerAwsId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The AWS customer account associated with the RDS event notification subscription.</p>\n "
|
|
},
|
|
"CustSubscriptionId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The RDS event notification subscription Id.</p>\n "
|
|
},
|
|
"SnsTopicArn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The topic ARN of the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The status of the RDS event notification subscription.</p>\n <p>Constraints:</p>\n <p>Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist</p>\n <p>The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.</p>\n "
|
|
},
|
|
"SubscriptionCreationTime": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The time the RDS event notification subscription was created.</p>\n "
|
|
},
|
|
"SourceType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The source type for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"SourceIdsList": {
|
|
"shape_name": "SourceIdsList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "SourceId"
|
|
},
|
|
"documentation": "\n <p>A list of source Ids for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"EventCategoriesList": {
|
|
"shape_name": "EventCategoriesList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "EventCategory"
|
|
},
|
|
"documentation": "\n <p>A list of event categories for the RDS event notification subscription.</p>\n "
|
|
},
|
|
"Enabled": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.</p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>Contains the results of a successful invocation of the <a>DescribeEventSubscriptions</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "SubscriptionNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The subscription name does not exist.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "SourceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The requested source could not be found.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>Removes a source identifier from an existing RDS event notification subscription.</p>\n <examples>\n <queryrequest>https://rds.us-east-1.amazonaws.com/\n ?Action=RemoveSourceIdentifierFromSubscription\n &SubscriptionName=EventSubscription01\n &SourceIdentifier=dbinstance01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T012415Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature>\n </queryrequest>\n \n <queryresponse>\n<RemoveSourceIdentifierFromSubscriptionResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <RemoveSourceIdentifierFromSubscriptionResult>\n <EventSubscription>\n <Enabled>true</Enabled>\n <CustomerAwsId>012345678901</CustomerAwsId>\n <SourceType>db-instance</SourceType>\n <Status>modifying</Status>\n <SubscriptionCreationTime>2013-01-28 00:29:23.736</SubscriptionCreationTime>\n <EventCategoriesList>\n <EventCategory>creation</EventCategory>\n <EventCategory>deletion</EventCategory>\n </EventCategoriesList>\n <CustSubscriptionId>EventSubscription01</CustSubscriptionId>\n <SnsTopicArn>arn:aws:sns:us-east-1:012345678901:EventSubscription01</SnsTopicArn>\n </EventSubscription>\n </RemoveSourceIdentifierFromSubscriptionResult>\n <ResponseMetadata>\n <RequestId>6f0b82bf-68e9-11e2-b97b-43c6362ec60d</RequestId>\n </ResponseMetadata>\n</RemoveSourceIdentifierFromSubscriptionResponse>\n </queryresponse> \n \n </examples>\n "
|
|
},
|
|
"RemoveTagsFromResource": {
|
|
"name": "RemoveTagsFromResource",
|
|
"input": {
|
|
"shape_name": "RemoveTagsFromResourceMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"ResourceName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The DB Instance the tags will be removed from.</p>\n ",
|
|
"required": true
|
|
},
|
|
"TagKeys": {
|
|
"shape_name": "KeyList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>The tag key (name) of the tag to be removed.</p> \n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p></p>\n "
|
|
},
|
|
"output": null,
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSnapshotNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> does not refer to an existing DB Snapshot.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p> Removes metadata tags from a DB Instance.</p>\n <p>For an overview on tagging DB Instances, see <a href=\"http://docs.amazonwebservices.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html\">DB Instance Tags.</a></p>\n "
|
|
},
|
|
"ResetDBParameterGroup": {
|
|
"name": "ResetDBParameterGroup",
|
|
"input": {
|
|
"shape_name": "ResetDBParameterGroupMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
},
|
|
"ResetAllParameters": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies whether (<code>true</code>) or not (<code>false</code>) to reset all parameters\n in the DB Parameter Group to default values.\n </p>\n <p>Default: <code>true</code></p>\n "
|
|
},
|
|
"Parameters": {
|
|
"shape_name": "ParametersList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Parameter",
|
|
"type": "structure",
|
|
"members": {
|
|
"ParameterName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the parameter.\n </p>\n "
|
|
},
|
|
"ParameterValue": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the value of the parameter.\n </p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides a description of the parameter.\n </p>\n "
|
|
},
|
|
"Source": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the source of the parameter value.\n </p>\n "
|
|
},
|
|
"ApplyType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the engine specific parameters type.\n </p>\n "
|
|
},
|
|
"DataType": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the valid data type for the parameter.\n </p>\n "
|
|
},
|
|
"AllowedValues": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the valid range of values for the parameter.\n </p>\n "
|
|
},
|
|
"IsModifiable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n </p>\n "
|
|
},
|
|
"MinimumEngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The earliest engine version to which the parameter can apply.\n </p>\n "
|
|
},
|
|
"ApplyMethod": {
|
|
"shape_name": "ApplyMethod",
|
|
"type": "string",
|
|
"enum": [
|
|
"immediate",
|
|
"pending-reboot"
|
|
],
|
|
"documentation": "\n <p>\n Indicates when to apply parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a request parameter in the\n <a>ModifyDBParameterGroup</a> and <a>ResetDBParameterGroup</a> actions.\n </p>\n <p>This data type is used as a response element in the \n <a>DescribeEngineDefaultParameters</a> and <a>DescribeDBParameters</a> actions.</p>\n ",
|
|
"xmlname": "Parameter"
|
|
},
|
|
"documentation": "\n <p>\n An array of parameter names, values, and the apply method\n for the parameter update. At least one parameter name,\n value, and apply method must be supplied; subsequent arguments are optional.\n A maximum of 20 parameters may be modified in a single request.\n </p> \n <p><b>MySQL</b></p>\n <p>Valid Values (for Apply method): <code>immediate</code> | <code>pending-reboot</code></p>\n <p>You can use the immediate value with dynamic parameters only. You can use \n the <code>pending-reboot</code> value for both dynamic and static parameters, and changes \n are applied when DB Instance reboots.</p>\n <p><b>Oracle</b></p>\n <p>Valid Values (for Apply method): <code>pending-reboot</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBParameterGroupNameMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Parameter Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the \n <a>ModifyDBParameterGroup</a> or <a>ResetDBParameterGroup</a> action.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidDBParameterGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The DB Parameter Group cannot be deleted because it is in use.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBParameterGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBParameterGroupName</i> does not refer to an\n existing DB Parameter Group.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Modifies the parameters of a DBParameterGroup to the engine/system default value. To\n reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the\n entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters parameters.\n When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=ResetDBParameterGroup\n &DBParameterGroupName=mydbparametergroup\n &Parameters.member.1.ParameterName=max_user_connections\n &Parameters.member.1.ApplyMethod=pending-reboot\n &Parameters.member.2.ParameterName=max_allowed_packet\n &Parameters.member.2.ApplyMethod=immediate\n &ResetAllParameters=false\n &Version=2013-01-10\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><ResetDBParameterGroupResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <ResetDBParameterGroupResult>\n <DBParameterGroupName>mydbparametergroup</DBParameterGroupName>\n </ResetDBParameterGroupResult>\n <ResponseMetadata>\n <RequestId>071e758f-bf57-11de-9f9f-53d6aee22de9</RequestId>\n </ResponseMetadata>\n</ResetDBParameterGroupResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"RestoreDBInstanceFromDBSnapshot": {
|
|
"name": "RestoreDBInstanceFromDBSnapshot",
|
|
"input": {
|
|
"shape_name": "RestoreDBInstanceFromDBSnapshotMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The identifier for the DB Snapshot to restore from.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul> \n ",
|
|
"required": true
|
|
},
|
|
"DBSnapshotIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Name of the DB Instance to create from the DB Snapshot.\n This parameter isn't case sensitive.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 255 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n <p>Example: <code>my-snapshot-id</code></p>\n ",
|
|
"required": true
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The compute and memory capacity of the Amazon RDS DB instance.\n </p>\n <p>Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge</code></p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The port number on which the database accepts connections.\n </p>\n <p>Default: The same port as the original DB Instance</p>\n <p>Constraints: Value must be <code>1150-65535</code></p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The EC2 Availability Zone that the database instance will be created in.\n </p>\n <p>Default: A random, system-chosen Availability Zone.</p>\n <p>Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>.</p>\n <p>Example: <code>us-east-1a</code></p>\n "
|
|
},
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB Subnet Group name to use for the new instance.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n <p>Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>.</p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version upgrades will be applied\n automatically to the DB Instance during the maintenance window.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for the restored DB Instance.\n </p>\n <p>\n Default: Same as source.\n </p>\n <p>\n Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code>\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The database name for the restored DB Instance.\n </p>\n <note>\n <p>This parameter doesn't apply to the MySQL engine.</p>\n </note>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The database engine to use for the new instance.\n </p>\n <p>Default: The same as source</p>\n <p>Constraint: Must be compatible with the engine of the source</p>\n <p>Example: <code>oracle-ee</code></p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the\n DB Instance. \n </p>\n <p> Constraints: Must be an integer greater than 1000.</p>\n \n "
|
|
},
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstance": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n User already has a DB Instance with the given identifier.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSnapshotNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSnapshotIdentifier</i> does not refer to an existing DB Snapshot.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InstanceQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InsufficientDBInstanceCapacityFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Specified DB Instance class is not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBSnapshotStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The state of the DB Security Snapshot does not allow deletion.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "StorageQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the\n allowed amount of storage available across all DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidVPCNetworkStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n DB Subnet Group does not cover all availability zones after it is created because users' change.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidRestoreFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Cannot restore from vpc backup to non-vpc DB instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSubnetGroupName</i> does not refer to an existing DB Subnet Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Subnets in the DB subnet group should cover at least 2 availability zones unless there's'only 1 available zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidSubnet",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request subnet is valid, or all subnets are not in common Vpc. \n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ProvisionedIopsNotAvailableInAZFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Provisioned IOPS not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "OptionGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The specified option group could not be found. \n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Creates a new DB Instance from a DB snapshot. The target database is created\n from the source database restore point with the same configuration as the original source database,\n except that the new RDS instance is created with the default security group.\n </p>\n <examples>\n <queryrequest>https://rds.amazon.com/\n ?Action=RestoreDBInstanceFromDBSnapshot\n &DBSnapshotIdentifier=mydbsnapshot\n &DBInstanceIdentifier=myrestoreddbinstance\n &Version=2013-01-10\n &Timestamp=2011-05-23T06%3A47%3A11.071Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><RestoreDBInstanceFromDBSnapshotResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <RestoreDBInstanceFromDBSnapshotResult>\n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <Engine>mysql</Engine>\n <PendingModifiedValues/>\n <BackupRetentionPeriod>1</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBInstanceStatus>creating</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <DBInstanceIdentifier>myrestoreddbinstance</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </RestoreDBInstanceFromDBSnapshotResult>\n <ResponseMetadata>\n <RequestId>7ca622e8-8508-11e0-bd9b-a7b1ece36d51</RequestId>\n </ResponseMetadata>\n</RestoreDBInstanceFromDBSnapshotResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"RestoreDBInstanceToPointInTime": {
|
|
"name": "RestoreDBInstanceToPointInTime",
|
|
"input": {
|
|
"shape_name": "RestoreDBInstanceToPointInTimeMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"SourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The identifier of the source DB Instance from which to restore.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must be the identifier of an existing database instance</li>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
},
|
|
"TargetDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the new database instance to be created.\n </p>\n <p>Constraints:</p>\n <ul>\n <li>Must contain from 1 to 63 alphanumeric characters or hyphens</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n ",
|
|
"required": true
|
|
},
|
|
"RestoreTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n The date and time to restore from.\n </p>\n <p>Valid Values: Value must be a UTC time</p>\n <p>Constraints:</p>\n <ul>\n <li>Must be before the latest restorable time for the DB Instance</li>\n <li>Cannot be specified if UseLatestRestorableTime parameter is true</li>\n </ul>\n <p>Example: <code>2009-09-07T23:45:00Z</code></p>\n "
|
|
},
|
|
"UseLatestRestorableTime": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies whether (<code>true</code>) or not (<code>false</code>) the\n DB Instance is restored from the latest backup time.\n </p>\n <p>Default: <code>false</code></p>\n <p>Constraints: Cannot be specified if RestoreTime parameter is provided.</p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The compute and memory capacity of the Amazon RDS DB instance.\n </p>\n <p>Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge</code></p>\n <p>Default: The same DBInstanceClass as the original DB Instance.</p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The port number on which the database accepts connections.\n </p>\n <p>Constraints: Value must be <code>1150-65535</code></p>\n <p>Default: The same port as the original DB Instance.</p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The EC2 Availability Zone that the database instance will be created in.\n </p>\n <p>Default: A random, system-chosen Availability Zone.</p>\n <p>Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.</p>\n <p>Example: <code>us-east-1a</code></p>\n "
|
|
},
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The DB subnet group name to use for the new instance.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n <p>Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>.</p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for the restored DB Instance.\n </p>\n <p>\n Default: Same as source.\n </p>\n <p>\n Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code>\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The database name for the restored DB Instance.\n </p>\n <note>\n <p>This parameter is not used for the MySQL engine.</p>\n </note>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The database engine to use for the new instance.\n </p>\n <p>Default: The same as source</p>\n <p>Constraint: Must be compatible with the engine of the source</p>\n <p>Example: <code>oracle-ee</code></p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the\n DB Instance. \n </p>\n <p> Constraints: Must be an integer greater than 1000.</p>\n \n "
|
|
},
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBInstanceWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstance": {
|
|
"shape_name": "DBInstance",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the name of the compute and memory\n capacity class of the DB Instance.\n </p>\n "
|
|
},
|
|
"Engine": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the name of the database engine to be used for this DB Instance.\n </p>\n "
|
|
},
|
|
"DBInstanceStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the current state of this database.\n </p>\n "
|
|
},
|
|
"MasterUsername": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the master username for the DB Instance.\n </p>\n "
|
|
},
|
|
"DBName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The meaning of this parameter differs according to the database engine you use.</p>\n <p><b>MySQL</b></p>\n <p>\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB Instance was created. This same name is returned for\n the life of the DB Instance.\n </p>\n <p>Type: String</p>\n <p><b>Oracle</b></p>\n <p>\n Contains the Oracle System ID (SID) of the created DB Instance. \n </p>\n "
|
|
},
|
|
"Endpoint": {
|
|
"shape_name": "Endpoint",
|
|
"type": "structure",
|
|
"members": {
|
|
"Address": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the DNS address of the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the port that the database engine is listening on.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the connection endpoint.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the allocated storage size specified in gigabytes.\n </p>\n "
|
|
},
|
|
"InstanceCreateTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Provides the date and time the DB Instance was created.\n </p>\n "
|
|
},
|
|
"PreferredBackupWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the <code>BackupRetentionPeriod</code>.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "Integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the number of days for which automatic DB Snapshots are retained.\n </p>\n "
|
|
},
|
|
"DBSecurityGroups": {
|
|
"shape_name": "DBSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n <li><a>RestoreDBInstanceToPointInTime</a></li>\n </ul>\n ",
|
|
"xmlname": "DBSecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of DB Security Group elements containing only\n <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.\n </p>\n "
|
|
},
|
|
"VpcSecurityGroups": {
|
|
"shape_name": "VpcSecurityGroupMembershipList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VpcSecurityGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"VpcSecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The name of the VPC security group.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the VPC Security Group.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>This data type is used as a response element for queries on VPC security group membership.</p>\n ",
|
|
"xmlname": "VpcSecurityGroupMembership"
|
|
},
|
|
"documentation": "\n <p>\n Provides List of VPC security group elements \n that the DB Instance belongs to. \n </p>\n "
|
|
},
|
|
"DBParameterGroups": {
|
|
"shape_name": "DBParameterGroupStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DBParameterGroupStatus",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBParameterGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DP Parameter Group.\n </p>\n "
|
|
},
|
|
"ParameterApplyStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of parameter updates.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The status of the DB Parameter Group.\n </p>\n <p>This data type is used as a response element in the following actions:</p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>CreateDBInstanceReadReplica</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n <li><a>RebootDBInstance</a></li>\n <li><a>RestoreDBInstanceFromDBSnapshot</a></li>\n </ul>\n ",
|
|
"xmlname": "DBParameterGroup"
|
|
},
|
|
"documentation": "\n <p>\n Provides the list of DB Parameter Groups applied to this DB Instance.\n </p>\n "
|
|
},
|
|
"AvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the Availability Zone the DB Instance is located in.\n </p>\n "
|
|
},
|
|
"DBSubnetGroup": {
|
|
"shape_name": "DBSubnetGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSubnetGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"DBSubnetGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"SubnetGroupStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the DB Subnet Group.\n </p>\n "
|
|
},
|
|
"Subnets": {
|
|
"shape_name": "SubnetList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Subnet",
|
|
"type": "structure",
|
|
"members": {
|
|
"SubnetIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the identifier of the subnet.\n </p>\n "
|
|
},
|
|
"SubnetAvailabilityZone": {
|
|
"shape_name": "AvailabilityZone",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the availability zone.\n </p>\n "
|
|
},
|
|
"ProvisionedIopsCapable": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n True indicates the availability zone is capable of provisioned IOPs.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains Availability Zone information. \n </p>\n <p>\n This data type is used as an element in the following data type:\n <ul>\n <li><a>OrderableDBInstanceOption</a></li>\n </ul>\n \n </p>\n "
|
|
},
|
|
"SubnetStatus": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the subnet.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action.\n </p>\n ",
|
|
"xmlname": "Subnet"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>Subnet</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.\n </p>\n "
|
|
},
|
|
"PreferredMaintenanceWindow": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n </p>\n "
|
|
},
|
|
"PendingModifiedValues": {
|
|
"shape_name": "PendingModifiedValues",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBInstanceClass": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceClass</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"AllocatedStorage": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Contains the new <code>AllocatedStorage</code> size for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
},
|
|
"MasterUserPassword": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the pending or in-progress change of the master credentials for the DB Instance.\n </p>\n "
|
|
},
|
|
"Port": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending port for the DB Instance.\n </p>\n "
|
|
},
|
|
"BackupRetentionPeriod": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the pending number of days for which automated backups are retained.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "BooleanOptional",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version. \n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the new Provisioned IOPS value for the DB Instance\n that will be applied or is being applied.\n </p>\n "
|
|
},
|
|
"DBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the new <code>DBInstanceIdentifier</code> for the DB Instance\n that will be applied or is in progress.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies that changes to the DB Instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n </p>\n "
|
|
},
|
|
"LatestRestorableTime": {
|
|
"shape_name": "TStamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n <p>\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n </p>\n "
|
|
},
|
|
"MultiAZ": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Specifies if the DB Instance is a Multi-AZ deployment.\n </p>\n "
|
|
},
|
|
"EngineVersion": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Indicates the database engine version.\n </p> \n "
|
|
},
|
|
"AutoMinorVersionUpgrade": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>\n Indicates that minor version patches are applied automatically.\n </p>\n "
|
|
},
|
|
"ReadReplicaSourceDBInstanceIdentifier": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.\n </p>\n "
|
|
},
|
|
"ReadReplicaDBInstanceIdentifiers": {
|
|
"shape_name": "ReadReplicaDBInstanceIdentifierList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null,
|
|
"xmlname": "ReadReplicaDBInstanceIdentifier"
|
|
},
|
|
"documentation": "\n <p>\n Contains one or more identifiers of the Read Replicas associated with this DB Instance.\n </p>\n "
|
|
},
|
|
"LicenseModel": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n License model information for this DB Instance.\n </p>\n "
|
|
},
|
|
"Iops": {
|
|
"shape_name": "IntegerOptional",
|
|
"type": "integer",
|
|
"documentation": "\n <p>\n Specifies the Provisioned IOPS (I/O operations per second) value.\n </p>\n "
|
|
},
|
|
"OptionGroupMembership": {
|
|
"shape_name": "OptionGroupMembership",
|
|
"type": "structure",
|
|
"members": {
|
|
"OptionGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the option group that the instance belongs to.\n </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n Specifies the name and status of the option group that this instance belongs to. \n </p>\n "
|
|
},
|
|
"CharacterSetName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the character set that this instance is associated with. \n </p>\n "
|
|
},
|
|
"SecondaryAvailabilityZone": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n </p>\n "
|
|
},
|
|
"PubliclyAccessible": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>CreateDBInstance</a></li>\n <li><a>DeleteDBInstance</a></li>\n <li><a>ModifyDBInstance</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>\n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBInstanceAlreadyExistsFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n User already has a DB Instance with the given identifier.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBInstanceNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBInstanceIdentifier</i> does not refer to an existing DB Instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InstanceQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the allowed number of DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InsufficientDBInstanceCapacityFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Specified DB Instance class is not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBInstanceStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The specified DB Instance is not in the <i>available</i> state.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "PointInTimeRestoreNotEnabledFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>SourceDBInstanceIdentifier</i>\n refers to a DB Instance with\n <i>BackupRetentionPeriod</i> equal to 0.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "StorageQuotaExceededFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request would result in user exceeding the\n allowed amount of storage available across all DB Instances.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidVPCNetworkStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n DB Subnet Group does not cover all availability zones after it is created because users' change.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidRestoreFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Cannot restore from vpc backup to non-vpc DB instance.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSubnetGroupName</i> does not refer to an existing DB Subnet Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Subnets in the DB subnet group should cover at least 2 availability zones unless there's'only 1 available zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidSubnet",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Request subnet is valid, or all subnets are not in common Vpc. \n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ProvisionedIopsNotAvailableInAZFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Provisioned IOPS not available in the specified Availability Zone.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "OptionGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": " \n <p>\n The specified option group could not be found. \n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in\n time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created\n from the source database with the same configuration as the original database except that the DB instance\n is created with the default DB security group.\n </p>\n <examples>\n <queryrequest>https://rds.amazon.com/\n ?Action=RestoreDBInstanceToPointInTime\n &TargetDBInstanceIdentifier=restored-db\n &SourceDBInstanceIdentifier=simcoprod01\n &UseLatestRestorableTime=true\n &Version=2013-01-10\n &Timestamp=2011-05-23T07%3A06%3A02.313Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><RestoreDBInstanceToPointInTimeResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <RestoreDBInstanceToPointInTimeResult>\n <DBInstance>\n <ReadReplicaDBInstanceIdentifiers/>\n <Engine>mysql</Engine>\n <PendingModifiedValues/>\n <BackupRetentionPeriod>1</BackupRetentionPeriod>\n <MultiAZ>false</MultiAZ>\n <LicenseModel>general-public-license</LicenseModel>\n <DBInstanceStatus>creating</DBInstanceStatus>\n <EngineVersion>5.1.50</EngineVersion>\n <DBInstanceIdentifier>restored-db</DBInstanceIdentifier>\n <DBParameterGroups>\n <DBParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>\n </DBParameterGroup>\n </DBParameterGroups>\n <DBSecurityGroups>\n <DBSecurityGroup>\n <Status>active</Status>\n <DBSecurityGroupName>default</DBSecurityGroupName>\n </DBSecurityGroup>\n </DBSecurityGroups>\n <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>\n <AllocatedStorage>10</AllocatedStorage>\n <DBInstanceClass>db.m1.large</DBInstanceClass>\n <MasterUsername>master</MasterUsername>\n </DBInstance>\n </RestoreDBInstanceToPointInTimeResult>\n <ResponseMetadata>\n <RequestId>1ef546bc-850b-11e0-90aa-eb648410240d</RequestId>\n </ResponseMetadata>\n</RestoreDBInstanceToPointInTimeResponse></queryresponse>\n </examples>\n "
|
|
},
|
|
"RevokeDBSecurityGroupIngress": {
|
|
"name": "RevokeDBSecurityGroupIngress",
|
|
"input": {
|
|
"shape_name": "RevokeDBSecurityGroupIngressMessage",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the DB Security Group to revoke ingress from.\n </p>\n ",
|
|
"required": true
|
|
},
|
|
"CIDRIP": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The IP range to revoke access from. \n Must be a valid CIDR range. If <code>CIDRIP</code> is specified, \n <code>EC2SecurityGroupName</code>, <code>EC2SecurityGroupId</code> and <code>EC2SecurityGroupOwnerId</code>\n cannot be provided.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The name of the EC2 Security Group to revoke access from.\n For VPC DB Security Groups, <code>EC2SecurityGroupId</code> must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The id of the EC2 Security Group to revoke access from.\n For VPC DB Security Groups, <code>EC2SecurityGroupId</code> must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupOwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n The AWS Account Number of the owner of the EC2 security group\n specified in the <code>EC2SecurityGroupName</code> parameter.\n The AWS Access Key ID is not an acceptable value.\n For VPC DB Security Groups, <code>EC2SecurityGroupId</code> must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n\n </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DBSecurityGroupWrapper",
|
|
"type": "structure",
|
|
"members": {
|
|
"DBSecurityGroup": {
|
|
"shape_name": "DBSecurityGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"OwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the AWS ID of the owner of a specific DB Security Group.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the DB Security Group.\n </p>\n "
|
|
},
|
|
"DBSecurityGroupDescription": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the description of the DB Security Group.\n </p>\n "
|
|
},
|
|
"VpcId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the VpcId of the DB Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroups": {
|
|
"shape_name": "EC2SecurityGroupList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "EC2SecurityGroup",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Provides the status of the EC2 security group. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupName": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the name of the EC2 Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the id of the EC2 Security Group.\n </p>\n "
|
|
},
|
|
"EC2SecurityGroupOwnerId": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the <code>EC2SecurityGroupName</code> field.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the following actions:\n </p>\n <ul>\n <li><a>AuthorizeDBSecurityGroupIngress</a></li>\n <li><a>DescribeDBSecurityGroups</a></li> \n <li><a>RevokeDBSecurityGroupIngress</a></li> \n </ul>\n ",
|
|
"xmlname": "EC2SecurityGroup"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>EC2SecurityGroup</a> elements.\n </p>\n "
|
|
},
|
|
"IPRanges": {
|
|
"shape_name": "IPRangeList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "IPRange",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the status of the IP range. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n </p>\n "
|
|
},
|
|
"CIDRIP": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>\n Specifies the IP range.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeDBSecurityGroups</a> action.\n </p>\n ",
|
|
"xmlname": "IPRange"
|
|
},
|
|
"documentation": "\n <p>\n Contains a list of <a>IPRange</a> elements.\n </p>\n "
|
|
}
|
|
},
|
|
"wrapper": true,
|
|
"documentation": "\n <p>\n Contains the result of a successful invocation of the following actions:\n </p>\n <ul>\n <li><a>DescribeDBSecurityGroups</a></li>\n <li><a>AuthorizeDBSecurityGroupIngress</a></li>\n <li><a>CreateDBSecurityGroup</a></li>\n <li><a>RevokeDBSecurityGroupIngress</a></li>\n </ul>\n <p>This data type is used as a response element in the <a>DescribeDBSecurityGroups</a> action.</p>\n \n "
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "DBSecurityGroupNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n <i>DBSecurityGroupName</i> does not refer to an existing DB Security Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AuthorizationNotFoundFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n Specified CIDRIP or EC2 security group is not authorized\n for the specified DB Security Group.\n </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InvalidDBSecurityGroupStateFault",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>\n The state of the DB Security Group does not allow deletion.\n </p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security\n Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId\n and either EC2SecurityGroupName or EC2SecurityGroupId).\n </p>\n <examples>\n <queryrequest>https://rds.amazonaws.com/\n ?Action=RevokeDBSecurityGroupIngress\n &DBSecurityGroupName=mydbsecuritygroup\n &CIDRIP=192.168.1.1%2F24\n &Version=2013-01-10\n &SignatureVersion=2&SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T22%3A32%3A12.515Z\n &AWSAccessKeyId=<AWS Access Key ID>\n &Signature=<Signature></queryrequest>\n <queryresponse><RevokeDBSecurityGroupIngressResponse xmlns=\"http://rds.amazonaws.com/doc/2013-01-10/\">\n <RevokeDBSecurityGroupIngressResult>\n <DBSecurityGroup>\n <EC2SecurityGroups/>\n <DBSecurityGroupDescription>My new DBSecurityGroup</DBSecurityGroupDescription>\n <IPRanges>\n <IPRange>\n <CIDRIP>192.168.1.1/24</CIDRIP>\n <Status>revoking</Status>\n </IPRange>\n </IPRanges>\n <OwnerId>621567473609</OwnerId>\n <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>\n <VpcId>vpc-1ab2c3d4</VpcId>\n </DBSecurityGroup>\n </RevokeDBSecurityGroupIngressResult>\n <ResponseMetadata>\n <RequestId>beecb8ac-bf5a-11de-9f9f-53d6aee22de9</RequestId>\n </ResponseMetadata>\n</RevokeDBSecurityGroupIngressResponse></queryresponse>\n </examples>\n "
|
|
}
|
|
},
|
|
"metadata": {
|
|
"regions": {
|
|
"us-east-1": "https://rds.amazonaws.com/",
|
|
"ap-northeast-1": null,
|
|
"sa-east-1": null,
|
|
"ap-southeast-1": null,
|
|
"ap-southeast-2": null,
|
|
"us-west-2": null,
|
|
"us-west-1": null,
|
|
"eu-west-1": null,
|
|
"us-gov-west-1": null
|
|
},
|
|
"protocols": [
|
|
"https"
|
|
]
|
|
},
|
|
"pagination": {
|
|
"DescribeDBEngineVersions": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBEngineVersions",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeDBInstances": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBInstances",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeDBParameterGroups": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBParameterGroups",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeDBParameters": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "Parameters",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeDBSecurityGroups": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBSecurityGroups",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeDBSnapshots": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBSnapshots",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeDBSubnetGroups": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "DBSubnetGroups",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeEngineDefaultParameters": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "EngineDefaults",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeEvents": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "Events",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeOptionGroupOptions": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "OptionGroupOptions",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeOptionGroups": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "OptionGroupsList",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeOrderableDBInstanceOptions": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "OrderableDBInstanceOptions",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeReservedDBInstances": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "ReservedDBInstances",
|
|
"py_input_token": "marker"
|
|
},
|
|
"DescribeReservedDBInstancesOfferings": {
|
|
"limit_key": "MaxRecords",
|
|
"input_token": "Marker",
|
|
"output_token": "Marker",
|
|
"result_key": "ReservedDBInstancesOfferings",
|
|
"py_input_token": "marker"
|
|
}
|
|
},
|
|
"retry": {
|
|
"__default__": {
|
|
"max_attempts": 5,
|
|
"delay": {
|
|
"type": "exponential",
|
|
"base": "rand",
|
|
"growth_factor": 2
|
|
},
|
|
"policies": {
|
|
"general_socket_errors": {
|
|
"applies_when": {
|
|
"socket_errors": [
|
|
"GENERAL_CONNECTION_ERROR"
|
|
]
|
|
}
|
|
},
|
|
"general_server_error": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 500
|
|
}
|
|
}
|
|
},
|
|
"service_unavailable": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 503
|
|
}
|
|
}
|
|
},
|
|
"limit_exceeded": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 509
|
|
}
|
|
}
|
|
},
|
|
"throttling": {
|
|
"applies_when": {
|
|
"response": {
|
|
"service_error_code": "Throttling",
|
|
"http_status_code": 400
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |