models.rds-2014-10-31-intermediate.json Maven / Gradle / Ivy
{
"customizationConfig" : {
"additionalShapeConstructors" : {
"AuthorizeDBSecurityGroupIngressRequest" : {
"constructorForms" : [ [ "DBSecurityGroupName" ] ]
},
"CreateDBInstanceReadReplicaRequest" : {
"constructorForms" : [ [ "DBInstanceIdentifier", "SourceDBInstanceIdentifier" ] ]
},
"CreateDBInstanceRequest" : {
"constructorForms" : [ [ "DBInstanceIdentifier", "AllocatedStorage", "DBInstanceClass", "Engine", "MasterUsername", "MasterUserPassword" ] ]
},
"CreateDBParameterGroupRequest" : {
"constructorForms" : [ [ "DBParameterGroupName", "DBParameterGroupFamily", "Description" ] ]
},
"CreateDBSecurityGroupRequest" : {
"constructorForms" : [ [ "DBSecurityGroupName", "DBSecurityGroupDescription" ] ]
},
"CreateDBSnapshotRequest" : {
"constructorForms" : [ [ "DBSnapshotIdentifier", "DBInstanceIdentifier" ] ]
},
"DeleteDBInstanceRequest" : {
"constructorForms" : [ [ "DBInstanceIdentifier" ] ]
},
"DeleteDBParameterGroupRequest" : {
"constructorForms" : [ [ "DBParameterGroupName" ] ]
},
"DeleteDBSecurityGroupRequest" : {
"constructorForms" : [ [ "DBSecurityGroupName" ] ]
},
"DeleteDBSnapshotRequest" : {
"constructorForms" : [ [ "DBSnapshotIdentifier" ] ]
},
"DescribeDBParametersRequest" : {
"constructorForms" : [ [ "DBParameterGroupName" ] ]
},
"DescribeEngineDefaultParametersRequest" : {
"constructorForms" : [ [ "DBParameterGroupFamily" ] ]
},
"ModifyDBInstanceRequest" : {
"constructorForms" : [ [ "DBInstanceIdentifier" ] ]
},
"ModifyDBParameterGroupRequest" : {
"constructorForms" : [ [ "DBParameterGroupName", "Parameters" ] ]
},
"PurchaseReservedDBInstancesOfferingRequest" : {
"constructorForms" : [ [ "ReservedDBInstancesOfferingId" ] ]
},
"RebootDBInstanceRequest" : {
"constructorForms" : [ [ "DBInstanceIdentifier" ] ]
},
"ResetDBParameterGroupRequest" : {
"constructorForms" : [ [ "DBParameterGroupName" ] ]
},
"RestoreDBInstanceFromDBSnapshotRequest" : {
"constructorForms" : [ [ "DBInstanceIdentifier", "DBSnapshotIdentifier" ] ]
},
"RestoreDBInstanceToPointInTimeRequest" : {
"constructorForms" : [ [ "SourceDBInstanceIdentifier", "TargetDBInstanceIdentifier" ] ]
},
"RevokeDBSecurityGroupIngressRequest" : {
"constructorForms" : [ [ "DBSecurityGroupName" ] ]
}
},
"authPolicyActions" : {
"actionPrefix" : null,
"fileNamePrefix" : "RDS",
"skip" : false
},
"calculateCRC32FromCompressedData" : false,
"convenienceTypeOverloads" : [ ],
"customClientConfigFactory" : null,
"customCodeTemplates" : null,
"customErrorCodeFieldName" : null,
"customExceptionUnmarshallerImpl" : null,
"customFileHeader" : null,
"customResponseMetadataClassName" : null,
"customServiceMetadata" : null,
"customServiceNameForRequest" : null,
"customSignerProvider" : null,
"operationModifiers" : null,
"operationsWithResponseStreamContentLengthValidation" : null,
"renameShapes" : null,
"requestMetrics" : null,
"requiredParamValidationEnabled" : false,
"sdkModeledExceptionBaseClassName" : null,
"sendEmptyAutoConstructedListAsEmptyList" : null,
"sendExplicitlyEmptyListsForQuery" : false,
"serviceClientHoldInputStream" : false,
"shapeModifiers" : null,
"shapeSubstitutions" : null,
"simpleMethods" : {
"DescribeAccountAttributes" : {
"methodForms" : [ [ ] ]
},
"DescribeCertificates" : {
"methodForms" : [ [ ] ]
},
"DescribeDBClusterParameterGroups" : {
"methodForms" : [ [ ] ]
},
"DescribeDBClusterSnapshots" : {
"methodForms" : [ [ ] ]
},
"DescribeDBClusters" : {
"methodForms" : [ [ ] ]
},
"DescribeDBEngineVersions" : {
"methodForms" : [ [ ] ]
},
"DescribeDBInstances" : {
"methodForms" : [ [ ] ]
},
"DescribeDBParameterGroups" : {
"methodForms" : [ [ ] ]
},
"DescribeDBSecurityGroups" : {
"methodForms" : [ [ ] ]
},
"DescribeDBSnapshotAttributes" : {
"methodForms" : [ [ ] ]
},
"DescribeDBSnapshots" : {
"methodForms" : [ [ ] ]
},
"DescribeDBSubnetGroups" : {
"methodForms" : [ [ ] ]
},
"DescribeEventCategories" : {
"methodForms" : [ [ ] ]
},
"DescribeEventSubscriptions" : {
"methodForms" : [ [ ] ]
},
"DescribeEvents" : {
"methodForms" : [ [ ] ]
},
"DescribeOptionGroups" : {
"methodForms" : [ [ ] ]
},
"DescribePendingMaintenanceActions" : {
"methodForms" : [ [ ] ]
},
"DescribeReservedDBInstances" : {
"methodForms" : [ [ ] ]
},
"DescribeReservedDBInstancesOfferings" : {
"methodForms" : [ [ ] ]
},
"FailoverDBCluster" : {
"methodForms" : [ [ ] ]
}
},
"skipInterfaceAdditions" : false,
"skipSmokeTests" : false,
"useAutoConstructList" : true,
"useAutoConstructMap" : true
},
"metadata" : {
"apiVersion" : "2014-10-31",
"asyncClient" : "AmazonRDSAsyncClient",
"asyncClientBuilderClassName" : "AmazonRDSAsyncClientBuilder",
"asyncInterface" : "AmazonRDSAsync",
"cborProtocol" : false,
"checksumFormat" : null,
"contentType" : null,
"cucumberModuleInjectorClassName" : "AmazonRDSModuleInjector",
"defaultEndpoint" : "rds.amazonaws.com",
"defaultEndpointWithoutHttpProtocol" : "rds.amazonaws.com",
"documentation" : "Amazon Relational Database Service
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
-
For the alphabetical list of API actions, see API Actions.
-
For the alphabetical list of data types, see Data Types.
-
For a list of common query parameters, see Common Parameters.
-
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
-
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
-
For more information about how to use the Query API, see Using the Query API.
",
"endpointPrefix" : "rds",
"hasApiWithStreamInput" : false,
"ionProtocol" : false,
"jsonProtocol" : false,
"jsonVersion" : null,
"packageName" : "com.amazonaws.services.rds",
"packagePath" : "com/amazonaws/services/rds",
"protocol" : "query",
"protocolDefaultExceptionUmarshallerImpl" : "StandardErrorUnmarshaller",
"serviceAbbreviation" : "Amazon RDS",
"serviceFullName" : "Amazon Relational Database Service",
"serviceName" : "Amazon RDS",
"signingName" : "rds",
"smokeTestsPackageName" : "com.amazonaws.services.rds.smoketests",
"syncClient" : "AmazonRDSClient",
"syncClientBuilderClassName" : "AmazonRDSClientBuilder",
"syncInterface" : "AmazonRDS",
"unmarshallerClassSuffix" : "StaxUnmarshaller",
"unmarshallerContextClassName" : "StaxUnmarshallerContext",
"xmlProtocol" : true
},
"operations" : {
"AddSourceIdentifierToSubscription" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EventSubscription",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a source identifier to an existing RDS event notification subscription.
",
"exceptions" : [ {
"exceptionName" : "SubscriptionNotFoundException",
"documentation" : "The subscription name does not exist.
"
}, {
"exceptionName" : "SourceNotFoundException",
"documentation" : "The requested source could not be found.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AddSourceIdentifierToSubscriptionRequest",
"variableName" : "addSourceIdentifierToSubscriptionRequest",
"variableType" : "AddSourceIdentifierToSubscriptionRequest",
"documentation" : "",
"simpleType" : "AddSourceIdentifierToSubscriptionRequest",
"variableSetterType" : "AddSourceIdentifierToSubscriptionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "addSourceIdentifierToSubscription",
"operationName" : "AddSourceIdentifierToSubscription",
"returnType" : {
"returnType" : "EventSubscription",
"documentation" : "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
"
},
"syncReturnType" : "EventSubscription"
},
"AddTagsToResource" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AddTagsToResourceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
}, {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AddTagsToResourceRequest",
"variableName" : "addTagsToResourceRequest",
"variableType" : "AddTagsToResourceRequest",
"documentation" : "",
"simpleType" : "AddTagsToResourceRequest",
"variableSetterType" : "AddTagsToResourceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "addTagsToResource",
"operationName" : "AddTagsToResource",
"returnType" : {
"returnType" : "AddTagsToResourceResult",
"documentation" : null
},
"syncReturnType" : "AddTagsToResourceResult"
},
"ApplyPendingMaintenanceAction" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ResourcePendingMaintenanceActions",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Applies a pending maintenance action to a resource (for example, to a DB instance).
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The specified resource ID was not found.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ApplyPendingMaintenanceActionRequest",
"variableName" : "applyPendingMaintenanceActionRequest",
"variableType" : "ApplyPendingMaintenanceActionRequest",
"documentation" : "",
"simpleType" : "ApplyPendingMaintenanceActionRequest",
"variableSetterType" : "ApplyPendingMaintenanceActionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "applyPendingMaintenanceAction",
"operationName" : "ApplyPendingMaintenanceAction",
"returnType" : {
"returnType" : "ResourcePendingMaintenanceActions",
"documentation" : "Describes the pending maintenance actions for a resource.
"
},
"syncReturnType" : "ResourcePendingMaintenanceActions"
},
"AuthorizeDBSecurityGroupIngress" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSecurityGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
",
"exceptions" : [ {
"exceptionName" : "DBSecurityGroupNotFoundException",
"documentation" : " DBSecurityGroupName does not refer to an existing DB security group.
"
}, {
"exceptionName" : "InvalidDBSecurityGroupStateException",
"documentation" : "The state of the DB security group does not allow deletion.
"
}, {
"exceptionName" : "AuthorizationAlreadyExistsException",
"documentation" : "The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
"
}, {
"exceptionName" : "AuthorizationQuotaExceededException",
"documentation" : "DB security group authorization quota has been reached.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AuthorizeDBSecurityGroupIngressRequest",
"variableName" : "authorizeDBSecurityGroupIngressRequest",
"variableType" : "AuthorizeDBSecurityGroupIngressRequest",
"documentation" : "",
"simpleType" : "AuthorizeDBSecurityGroupIngressRequest",
"variableSetterType" : "AuthorizeDBSecurityGroupIngressRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "authorizeDBSecurityGroupIngress",
"operationName" : "AuthorizeDBSecurityGroupIngress",
"returnType" : {
"returnType" : "DBSecurityGroup",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
This data type is used as a response element in the DescribeDBSecurityGroups action.
"
},
"syncReturnType" : "DBSecurityGroup"
},
"CopyDBClusterParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBClusterParameterGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Copies the specified DB cluster parameter group.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
}, {
"exceptionName" : "DBParameterGroupQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB parameter groups.
"
}, {
"exceptionName" : "DBParameterGroupAlreadyExistsException",
"documentation" : "A DB parameter group with the same name exists.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CopyDBClusterParameterGroupRequest",
"variableName" : "copyDBClusterParameterGroupRequest",
"variableType" : "CopyDBClusterParameterGroupRequest",
"documentation" : "",
"simpleType" : "CopyDBClusterParameterGroupRequest",
"variableSetterType" : "CopyDBClusterParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "copyDBClusterParameterGroup",
"operationName" : "CopyDBClusterParameterGroup",
"returnType" : {
"returnType" : "DBClusterParameterGroup",
"documentation" : "Contains the result of a successful invocation of the CreateDBClusterParameterGroup or CopyDBClusterParameterGroup action.
This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.
"
},
"syncReturnType" : "DBClusterParameterGroup"
},
"CopyDBClusterSnapshot" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBClusterSnapshot",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterSnapshotAlreadyExistsException",
"documentation" : "User already has a DB cluster snapshot with the given identifier.
"
}, {
"exceptionName" : "DBClusterSnapshotNotFoundException",
"documentation" : " DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
}, {
"exceptionName" : "InvalidDBClusterSnapshotStateException",
"documentation" : "The supplied value is not a valid DB cluster snapshot state.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CopyDBClusterSnapshotRequest",
"variableName" : "copyDBClusterSnapshotRequest",
"variableType" : "CopyDBClusterSnapshotRequest",
"documentation" : "",
"simpleType" : "CopyDBClusterSnapshotRequest",
"variableSetterType" : "CopyDBClusterSnapshotRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "copyDBClusterSnapshot",
"operationName" : "CopyDBClusterSnapshot",
"returnType" : {
"returnType" : "DBClusterSnapshot",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBClusterSnapshots action.
"
},
"syncReturnType" : "DBClusterSnapshot"
},
"CopyDBParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBParameterGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Copies the specified DB parameter group.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
}, {
"exceptionName" : "DBParameterGroupAlreadyExistsException",
"documentation" : "A DB parameter group with the same name exists.
"
}, {
"exceptionName" : "DBParameterGroupQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB parameter groups.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CopyDBParameterGroupRequest",
"variableName" : "copyDBParameterGroupRequest",
"variableType" : "CopyDBParameterGroupRequest",
"documentation" : "",
"simpleType" : "CopyDBParameterGroupRequest",
"variableSetterType" : "CopyDBParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "copyDBParameterGroup",
"operationName" : "CopyDBParameterGroup",
"returnType" : {
"returnType" : "DBParameterGroup",
"documentation" : "Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
"
},
"syncReturnType" : "DBParameterGroup"
},
"CopyDBSnapshot" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSnapshot",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.
If you are copying from a shared manual DB snapshot, the SourceDBSnapshotIdentifier must be the ARN of the shared DB snapshot.
",
"exceptions" : [ {
"exceptionName" : "DBSnapshotAlreadyExistsException",
"documentation" : " DBSnapshotIdentifier is already used by an existing snapshot.
"
}, {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
}, {
"exceptionName" : "InvalidDBSnapshotStateException",
"documentation" : "The state of the DB snapshot does not allow deletion.
"
}, {
"exceptionName" : "SnapshotQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB snapshots.
"
}, {
"exceptionName" : "KMSKeyNotAccessibleException",
"documentation" : "Error accessing KMS key.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CopyDBSnapshotRequest",
"variableName" : "copyDBSnapshotRequest",
"variableType" : "CopyDBSnapshotRequest",
"documentation" : "",
"simpleType" : "CopyDBSnapshotRequest",
"variableSetterType" : "CopyDBSnapshotRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "copyDBSnapshot",
"operationName" : "CopyDBSnapshot",
"returnType" : {
"returnType" : "DBSnapshot",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
"
},
"syncReturnType" : "DBSnapshot"
},
"CopyOptionGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "OptionGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Copies the specified option group.
",
"exceptions" : [ {
"exceptionName" : "OptionGroupAlreadyExistsException",
"documentation" : "The option group you are trying to create already exists.
"
}, {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
}, {
"exceptionName" : "OptionGroupQuotaExceededException",
"documentation" : "The quota of 20 option groups was exceeded for this AWS account.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CopyOptionGroupRequest",
"variableName" : "copyOptionGroupRequest",
"variableType" : "CopyOptionGroupRequest",
"documentation" : "",
"simpleType" : "CopyOptionGroupRequest",
"variableSetterType" : "CopyOptionGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "copyOptionGroup",
"operationName" : "CopyOptionGroup",
"returnType" : {
"returnType" : "OptionGroup",
"documentation" : ""
},
"syncReturnType" : "OptionGroup"
},
"CreateDBCluster" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBCluster",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterAlreadyExistsException",
"documentation" : "User already has a DB cluster with the given identifier.
"
}, {
"exceptionName" : "InsufficientStorageClusterCapacityException",
"documentation" : "There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
"
}, {
"exceptionName" : "DBClusterQuotaExceededException",
"documentation" : "User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
}, {
"exceptionName" : "InvalidDBSubnetGroupStateException",
"documentation" : "The DB subnet group cannot be deleted because it is in use.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
}, {
"exceptionName" : "DBClusterParameterGroupNotFoundException",
"documentation" : " DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
"
}, {
"exceptionName" : "KMSKeyNotAccessibleException",
"documentation" : "Error accessing KMS key.
"
}, {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBClusterRequest",
"variableName" : "createDBClusterRequest",
"variableType" : "CreateDBClusterRequest",
"documentation" : "",
"simpleType" : "CreateDBClusterRequest",
"variableSetterType" : "CreateDBClusterRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBCluster",
"operationName" : "CreateDBCluster",
"returnType" : {
"returnType" : "DBCluster",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
-
-
This data type is used as a response element in the DescribeDBClusters action.
"
},
"syncReturnType" : "DBCluster"
},
"CreateDBClusterParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBClusterParameterGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB parameter groups.
"
}, {
"exceptionName" : "DBParameterGroupAlreadyExistsException",
"documentation" : "A DB parameter group with the same name exists.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBClusterParameterGroupRequest",
"variableName" : "createDBClusterParameterGroupRequest",
"variableType" : "CreateDBClusterParameterGroupRequest",
"documentation" : "",
"simpleType" : "CreateDBClusterParameterGroupRequest",
"variableSetterType" : "CreateDBClusterParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBClusterParameterGroup",
"operationName" : "CreateDBClusterParameterGroup",
"returnType" : {
"returnType" : "DBClusterParameterGroup",
"documentation" : "Contains the result of a successful invocation of the CreateDBClusterParameterGroup or CopyDBClusterParameterGroup action.
This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.
"
},
"syncReturnType" : "DBClusterParameterGroup"
},
"CreateDBClusterSnapshot" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBClusterSnapshot",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterSnapshotAlreadyExistsException",
"documentation" : "User already has a DB cluster snapshot with the given identifier.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
}, {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
}, {
"exceptionName" : "SnapshotQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB snapshots.
"
}, {
"exceptionName" : "InvalidDBClusterSnapshotStateException",
"documentation" : "The supplied value is not a valid DB cluster snapshot state.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBClusterSnapshotRequest",
"variableName" : "createDBClusterSnapshotRequest",
"variableType" : "CreateDBClusterSnapshotRequest",
"documentation" : "",
"simpleType" : "CreateDBClusterSnapshotRequest",
"variableSetterType" : "CreateDBClusterSnapshotRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBClusterSnapshot",
"operationName" : "CreateDBClusterSnapshot",
"returnType" : {
"returnType" : "DBClusterSnapshot",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBClusterSnapshots action.
"
},
"syncReturnType" : "DBClusterSnapshot"
},
"CreateDBInstance" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBInstance",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new DB instance.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceAlreadyExistsException",
"documentation" : "User already has a DB instance with the given identifier.
"
}, {
"exceptionName" : "InsufficientDBInstanceCapacityException",
"documentation" : "Specified DB instance class is not available in the specified Availability Zone.
"
}, {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
}, {
"exceptionName" : "DBSecurityGroupNotFoundException",
"documentation" : " DBSecurityGroupName does not refer to an existing DB security group.
"
}, {
"exceptionName" : "InstanceQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB instances.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "DBSubnetGroupDoesNotCoverEnoughAZsException",
"documentation" : "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "ProvisionedIopsNotAvailableInAZException",
"documentation" : "Provisioned IOPS not available in the specified Availability Zone.
"
}, {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
}, {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
}, {
"exceptionName" : "StorageTypeNotSupportedException",
"documentation" : " StorageType specified cannot be associated with the DB Instance.
"
}, {
"exceptionName" : "AuthorizationNotFoundException",
"documentation" : "Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
"
}, {
"exceptionName" : "KMSKeyNotAccessibleException",
"documentation" : "Error accessing KMS key.
"
}, {
"exceptionName" : "DomainNotFoundException",
"documentation" : " Domain does not refer to an existing Active Directory Domain.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBInstanceRequest",
"variableName" : "createDBInstanceRequest",
"variableType" : "CreateDBInstanceRequest",
"documentation" : "",
"simpleType" : "CreateDBInstanceRequest",
"variableSetterType" : "CreateDBInstanceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBInstance",
"operationName" : "CreateDBInstance",
"returnType" : {
"returnType" : "DBInstance",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
"
},
"syncReturnType" : "DBInstance"
},
"CreateDBInstanceReadReplica" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBInstance",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
The source DB instance must have backup retention enabled.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceAlreadyExistsException",
"documentation" : "User already has a DB instance with the given identifier.
"
}, {
"exceptionName" : "InsufficientDBInstanceCapacityException",
"documentation" : "Specified DB instance class is not available in the specified Availability Zone.
"
}, {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
}, {
"exceptionName" : "DBSecurityGroupNotFoundException",
"documentation" : " DBSecurityGroupName does not refer to an existing DB security group.
"
}, {
"exceptionName" : "InstanceQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB instances.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
}, {
"exceptionName" : "InvalidDBInstanceStateException",
"documentation" : " The specified DB instance is not in the available state.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "DBSubnetGroupDoesNotCoverEnoughAZsException",
"documentation" : "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "ProvisionedIopsNotAvailableInAZException",
"documentation" : "Provisioned IOPS not available in the specified Availability Zone.
"
}, {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
}, {
"exceptionName" : "DBSubnetGroupNotAllowedException",
"documentation" : "Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.
"
}, {
"exceptionName" : "InvalidDBSubnetGroupException",
"documentation" : "Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.
"
}, {
"exceptionName" : "StorageTypeNotSupportedException",
"documentation" : " StorageType specified cannot be associated with the DB Instance.
"
}, {
"exceptionName" : "KMSKeyNotAccessibleException",
"documentation" : "Error accessing KMS key.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBInstanceReadReplicaRequest",
"variableName" : "createDBInstanceReadReplicaRequest",
"variableType" : "CreateDBInstanceReadReplicaRequest",
"documentation" : "",
"simpleType" : "CreateDBInstanceReadReplicaRequest",
"variableSetterType" : "CreateDBInstanceReadReplicaRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBInstanceReadReplica",
"operationName" : "CreateDBInstanceReadReplica",
"returnType" : {
"returnType" : "DBInstance",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
"
},
"syncReturnType" : "DBInstance"
},
"CreateDBParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBParameterGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB parameter groups.
"
}, {
"exceptionName" : "DBParameterGroupAlreadyExistsException",
"documentation" : "A DB parameter group with the same name exists.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBParameterGroupRequest",
"variableName" : "createDBParameterGroupRequest",
"variableType" : "CreateDBParameterGroupRequest",
"documentation" : "",
"simpleType" : "CreateDBParameterGroupRequest",
"variableSetterType" : "CreateDBParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBParameterGroup",
"operationName" : "CreateDBParameterGroup",
"returnType" : {
"returnType" : "DBParameterGroup",
"documentation" : "Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
"
},
"syncReturnType" : "DBParameterGroup"
},
"CreateDBSecurityGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSecurityGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new DB security group. DB security groups control access to a DB instance.
",
"exceptions" : [ {
"exceptionName" : "DBSecurityGroupAlreadyExistsException",
"documentation" : " A DB security group with the name specified in DBSecurityGroupName already exists.
"
}, {
"exceptionName" : "DBSecurityGroupQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB security groups.
"
}, {
"exceptionName" : "DBSecurityGroupNotSupportedException",
"documentation" : "A DB security group is not allowed for this action.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBSecurityGroupRequest",
"variableName" : "createDBSecurityGroupRequest",
"variableType" : "CreateDBSecurityGroupRequest",
"documentation" : "",
"simpleType" : "CreateDBSecurityGroupRequest",
"variableSetterType" : "CreateDBSecurityGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBSecurityGroup",
"operationName" : "CreateDBSecurityGroup",
"returnType" : {
"returnType" : "DBSecurityGroup",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
This data type is used as a response element in the DescribeDBSecurityGroups action.
"
},
"syncReturnType" : "DBSecurityGroup"
},
"CreateDBSnapshot" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSnapshot",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a DBSnapshot. The source DBInstance must be in \"available\" state.
",
"exceptions" : [ {
"exceptionName" : "DBSnapshotAlreadyExistsException",
"documentation" : " DBSnapshotIdentifier is already used by an existing snapshot.
"
}, {
"exceptionName" : "InvalidDBInstanceStateException",
"documentation" : " The specified DB instance is not in the available state.
"
}, {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
}, {
"exceptionName" : "SnapshotQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB snapshots.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBSnapshotRequest",
"variableName" : "createDBSnapshotRequest",
"variableType" : "CreateDBSnapshotRequest",
"documentation" : "",
"simpleType" : "CreateDBSnapshotRequest",
"variableSetterType" : "CreateDBSnapshotRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBSnapshot",
"operationName" : "CreateDBSnapshot",
"returnType" : {
"returnType" : "DBSnapshot",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
"
},
"syncReturnType" : "DBSnapshot"
},
"CreateDBSubnetGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSubnetGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
",
"exceptions" : [ {
"exceptionName" : "DBSubnetGroupAlreadyExistsException",
"documentation" : " DBSubnetGroupName is already used by an existing DB subnet group.
"
}, {
"exceptionName" : "DBSubnetGroupQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB subnet groups.
"
}, {
"exceptionName" : "DBSubnetQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
"
}, {
"exceptionName" : "DBSubnetGroupDoesNotCoverEnoughAZsException",
"documentation" : "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDBSubnetGroupRequest",
"variableName" : "createDBSubnetGroupRequest",
"variableType" : "CreateDBSubnetGroupRequest",
"documentation" : "",
"simpleType" : "CreateDBSubnetGroupRequest",
"variableSetterType" : "CreateDBSubnetGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDBSubnetGroup",
"operationName" : "CreateDBSubnetGroup",
"returnType" : {
"returnType" : "DBSubnetGroup",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
"
},
"syncReturnType" : "DBSubnetGroup"
},
"CreateEventSubscription" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EventSubscription",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
",
"exceptions" : [ {
"exceptionName" : "EventSubscriptionQuotaExceededException",
"documentation" : "You have reached the maximum number of event subscriptions.
"
}, {
"exceptionName" : "SubscriptionAlreadyExistException",
"documentation" : "The supplied subscription name already exists.
"
}, {
"exceptionName" : "SNSInvalidTopicException",
"documentation" : "SNS has responded that there is a problem with the SND topic specified.
"
}, {
"exceptionName" : "SNSNoAuthorizationException",
"documentation" : "You do not have permission to publish to the SNS topic ARN.
"
}, {
"exceptionName" : "SNSTopicArnNotFoundException",
"documentation" : "The SNS topic ARN does not exist.
"
}, {
"exceptionName" : "SubscriptionCategoryNotFoundException",
"documentation" : "The supplied category does not exist.
"
}, {
"exceptionName" : "SourceNotFoundException",
"documentation" : "The requested source could not be found.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateEventSubscriptionRequest",
"variableName" : "createEventSubscriptionRequest",
"variableType" : "CreateEventSubscriptionRequest",
"documentation" : "",
"simpleType" : "CreateEventSubscriptionRequest",
"variableSetterType" : "CreateEventSubscriptionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createEventSubscription",
"operationName" : "CreateEventSubscription",
"returnType" : {
"returnType" : "EventSubscription",
"documentation" : "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
"
},
"syncReturnType" : "EventSubscription"
},
"CreateOptionGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "OptionGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new option group. You can create up to 20 option groups.
",
"exceptions" : [ {
"exceptionName" : "OptionGroupAlreadyExistsException",
"documentation" : "The option group you are trying to create already exists.
"
}, {
"exceptionName" : "OptionGroupQuotaExceededException",
"documentation" : "The quota of 20 option groups was exceeded for this AWS account.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateOptionGroupRequest",
"variableName" : "createOptionGroupRequest",
"variableType" : "CreateOptionGroupRequest",
"documentation" : "",
"simpleType" : "CreateOptionGroupRequest",
"variableSetterType" : "CreateOptionGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createOptionGroup",
"operationName" : "CreateOptionGroup",
"returnType" : {
"returnType" : "OptionGroup",
"documentation" : ""
},
"syncReturnType" : "OptionGroup"
},
"DeleteDBCluster" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBCluster",
"authenticated" : true,
"deprecated" : false,
"documentation" : "The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
}, {
"exceptionName" : "DBClusterSnapshotAlreadyExistsException",
"documentation" : "User already has a DB cluster snapshot with the given identifier.
"
}, {
"exceptionName" : "SnapshotQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB snapshots.
"
}, {
"exceptionName" : "InvalidDBClusterSnapshotStateException",
"documentation" : "The supplied value is not a valid DB cluster snapshot state.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDBClusterRequest",
"variableName" : "deleteDBClusterRequest",
"variableType" : "DeleteDBClusterRequest",
"documentation" : "",
"simpleType" : "DeleteDBClusterRequest",
"variableSetterType" : "DeleteDBClusterRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDBCluster",
"operationName" : "DeleteDBCluster",
"returnType" : {
"returnType" : "DBCluster",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
-
-
This data type is used as a response element in the DescribeDBClusters action.
"
},
"syncReturnType" : "DBCluster"
},
"DeleteDBClusterParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteDBClusterParameterGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBParameterGroupStateException",
"documentation" : "The DB parameter group cannot be deleted because it is in use.
"
}, {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDBClusterParameterGroupRequest",
"variableName" : "deleteDBClusterParameterGroupRequest",
"variableType" : "DeleteDBClusterParameterGroupRequest",
"documentation" : "",
"simpleType" : "DeleteDBClusterParameterGroupRequest",
"variableSetterType" : "DeleteDBClusterParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDBClusterParameterGroup",
"operationName" : "DeleteDBClusterParameterGroup",
"returnType" : {
"returnType" : "DeleteDBClusterParameterGroupResult",
"documentation" : null
},
"syncReturnType" : "DeleteDBClusterParameterGroupResult"
},
"DeleteDBClusterSnapshot" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBClusterSnapshot",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBClusterSnapshotStateException",
"documentation" : "The supplied value is not a valid DB cluster snapshot state.
"
}, {
"exceptionName" : "DBClusterSnapshotNotFoundException",
"documentation" : " DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDBClusterSnapshotRequest",
"variableName" : "deleteDBClusterSnapshotRequest",
"variableType" : "DeleteDBClusterSnapshotRequest",
"documentation" : "",
"simpleType" : "DeleteDBClusterSnapshotRequest",
"variableSetterType" : "DeleteDBClusterSnapshotRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDBClusterSnapshot",
"operationName" : "DeleteDBClusterSnapshot",
"returnType" : {
"returnType" : "DBClusterSnapshot",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBClusterSnapshots action.
"
},
"syncReturnType" : "DBClusterSnapshot"
},
"DeleteDBInstance" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBInstance",
"authenticated" : true,
"deprecated" : false,
"documentation" : "The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.
If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if the following are true:
-
The DB cluster is a Read Replica of another Amazon Aurora DB cluster.
-
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
}, {
"exceptionName" : "InvalidDBInstanceStateException",
"documentation" : " The specified DB instance is not in the available state.
"
}, {
"exceptionName" : "DBSnapshotAlreadyExistsException",
"documentation" : " DBSnapshotIdentifier is already used by an existing snapshot.
"
}, {
"exceptionName" : "SnapshotQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB snapshots.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDBInstanceRequest",
"variableName" : "deleteDBInstanceRequest",
"variableType" : "DeleteDBInstanceRequest",
"documentation" : "",
"simpleType" : "DeleteDBInstanceRequest",
"variableSetterType" : "DeleteDBInstanceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDBInstance",
"operationName" : "DeleteDBInstance",
"returnType" : {
"returnType" : "DBInstance",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
"
},
"syncReturnType" : "DBInstance"
},
"DeleteDBParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteDBParameterGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBParameterGroupStateException",
"documentation" : "The DB parameter group cannot be deleted because it is in use.
"
}, {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDBParameterGroupRequest",
"variableName" : "deleteDBParameterGroupRequest",
"variableType" : "DeleteDBParameterGroupRequest",
"documentation" : "",
"simpleType" : "DeleteDBParameterGroupRequest",
"variableSetterType" : "DeleteDBParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDBParameterGroup",
"operationName" : "DeleteDBParameterGroup",
"returnType" : {
"returnType" : "DeleteDBParameterGroupResult",
"documentation" : null
},
"syncReturnType" : "DeleteDBParameterGroupResult"
},
"DeleteDBSecurityGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteDBSecurityGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBSecurityGroupStateException",
"documentation" : "The state of the DB security group does not allow deletion.
"
}, {
"exceptionName" : "DBSecurityGroupNotFoundException",
"documentation" : " DBSecurityGroupName does not refer to an existing DB security group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDBSecurityGroupRequest",
"variableName" : "deleteDBSecurityGroupRequest",
"variableType" : "DeleteDBSecurityGroupRequest",
"documentation" : "",
"simpleType" : "DeleteDBSecurityGroupRequest",
"variableSetterType" : "DeleteDBSecurityGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDBSecurityGroup",
"operationName" : "DeleteDBSecurityGroup",
"returnType" : {
"returnType" : "DeleteDBSecurityGroupResult",
"documentation" : null
},
"syncReturnType" : "DeleteDBSecurityGroupResult"
},
"DeleteDBSnapshot" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSnapshot",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
The DBSnapshot must be in the available state to be deleted.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBSnapshotStateException",
"documentation" : "The state of the DB snapshot does not allow deletion.
"
}, {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDBSnapshotRequest",
"variableName" : "deleteDBSnapshotRequest",
"variableType" : "DeleteDBSnapshotRequest",
"documentation" : "",
"simpleType" : "DeleteDBSnapshotRequest",
"variableSetterType" : "DeleteDBSnapshotRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDBSnapshot",
"operationName" : "DeleteDBSnapshot",
"returnType" : {
"returnType" : "DBSnapshot",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
"
},
"syncReturnType" : "DBSnapshot"
},
"DeleteDBSubnetGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteDBSubnetGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBSubnetGroupStateException",
"documentation" : "The DB subnet group cannot be deleted because it is in use.
"
}, {
"exceptionName" : "InvalidDBSubnetStateException",
"documentation" : " The DB subnet is not in the available state.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDBSubnetGroupRequest",
"variableName" : "deleteDBSubnetGroupRequest",
"variableType" : "DeleteDBSubnetGroupRequest",
"documentation" : "",
"simpleType" : "DeleteDBSubnetGroupRequest",
"variableSetterType" : "DeleteDBSubnetGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDBSubnetGroup",
"operationName" : "DeleteDBSubnetGroup",
"returnType" : {
"returnType" : "DeleteDBSubnetGroupResult",
"documentation" : null
},
"syncReturnType" : "DeleteDBSubnetGroupResult"
},
"DeleteEventSubscription" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EventSubscription",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an RDS event notification subscription.
",
"exceptions" : [ {
"exceptionName" : "SubscriptionNotFoundException",
"documentation" : "The subscription name does not exist.
"
}, {
"exceptionName" : "InvalidEventSubscriptionStateException",
"documentation" : "This error can occur if someone else is modifying a subscription. You should retry the action.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteEventSubscriptionRequest",
"variableName" : "deleteEventSubscriptionRequest",
"variableType" : "DeleteEventSubscriptionRequest",
"documentation" : "",
"simpleType" : "DeleteEventSubscriptionRequest",
"variableSetterType" : "DeleteEventSubscriptionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteEventSubscription",
"operationName" : "DeleteEventSubscription",
"returnType" : {
"returnType" : "EventSubscription",
"documentation" : "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
"
},
"syncReturnType" : "EventSubscription"
},
"DeleteOptionGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteOptionGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an existing option group.
",
"exceptions" : [ {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
}, {
"exceptionName" : "InvalidOptionGroupStateException",
"documentation" : " The option group is not in the available state.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteOptionGroupRequest",
"variableName" : "deleteOptionGroupRequest",
"variableType" : "DeleteOptionGroupRequest",
"documentation" : "",
"simpleType" : "DeleteOptionGroupRequest",
"variableSetterType" : "DeleteOptionGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteOptionGroup",
"operationName" : "DeleteOptionGroup",
"returnType" : {
"returnType" : "DeleteOptionGroupResult",
"documentation" : null
},
"syncReturnType" : "DeleteOptionGroupResult"
},
"DescribeAccountAttributes" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeAccountAttributesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command does not take any parameters.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeAccountAttributesRequest",
"variableName" : "describeAccountAttributesRequest",
"variableType" : "DescribeAccountAttributesRequest",
"documentation" : "",
"simpleType" : "DescribeAccountAttributesRequest",
"variableSetterType" : "DescribeAccountAttributesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeAccountAttributes",
"operationName" : "DescribeAccountAttributes",
"returnType" : {
"returnType" : "DescribeAccountAttributesResult",
"documentation" : "Data returned by the DescribeAccountAttributes action.
"
},
"syncReturnType" : "DescribeAccountAttributesResult"
},
"DescribeCertificates" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeCertificatesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the set of CA certificates provided by Amazon RDS for this AWS account.
",
"exceptions" : [ {
"exceptionName" : "CertificateNotFoundException",
"documentation" : " CertificateIdentifier does not refer to an existing certificate.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeCertificatesRequest",
"variableName" : "describeCertificatesRequest",
"variableType" : "DescribeCertificatesRequest",
"documentation" : "",
"simpleType" : "DescribeCertificatesRequest",
"variableSetterType" : "DescribeCertificatesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeCertificates",
"operationName" : "DescribeCertificates",
"returnType" : {
"returnType" : "DescribeCertificatesResult",
"documentation" : "Data returned by the DescribeCertificates action.
"
},
"syncReturnType" : "DescribeCertificatesResult"
},
"DescribeDBClusterParameterGroups" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBClusterParameterGroupsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : " Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBClusterParameterGroupsRequest",
"variableName" : "describeDBClusterParameterGroupsRequest",
"variableType" : "DescribeDBClusterParameterGroupsRequest",
"documentation" : "",
"simpleType" : "DescribeDBClusterParameterGroupsRequest",
"variableSetterType" : "DescribeDBClusterParameterGroupsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBClusterParameterGroups",
"operationName" : "DescribeDBClusterParameterGroups",
"returnType" : {
"returnType" : "DescribeDBClusterParameterGroupsResult",
"documentation" : ""
},
"syncReturnType" : "DescribeDBClusterParameterGroupsResult"
},
"DescribeDBClusterParameters" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBClusterParametersResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBClusterParametersRequest",
"variableName" : "describeDBClusterParametersRequest",
"variableType" : "DescribeDBClusterParametersRequest",
"documentation" : "",
"simpleType" : "DescribeDBClusterParametersRequest",
"variableSetterType" : "DescribeDBClusterParametersRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBClusterParameters",
"operationName" : "DescribeDBClusterParameters",
"returnType" : {
"returnType" : "DescribeDBClusterParametersResult",
"documentation" : "Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
"
},
"syncReturnType" : "DescribeDBClusterParametersResult"
},
"DescribeDBClusterSnapshotAttributes" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBClusterSnapshotAttributesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
",
"exceptions" : [ {
"exceptionName" : "DBClusterSnapshotNotFoundException",
"documentation" : " DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBClusterSnapshotAttributesRequest",
"variableName" : "describeDBClusterSnapshotAttributesRequest",
"variableType" : "DescribeDBClusterSnapshotAttributesRequest",
"documentation" : "",
"simpleType" : "DescribeDBClusterSnapshotAttributesRequest",
"variableSetterType" : "DescribeDBClusterSnapshotAttributesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBClusterSnapshotAttributes",
"operationName" : "DescribeDBClusterSnapshotAttributes",
"returnType" : {
"returnType" : "DBClusterSnapshotAttributesResult",
"documentation" : "Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
"
},
"syncReturnType" : "DBClusterSnapshotAttributesResult"
},
"DescribeDBClusterSnapshots" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBClusterSnapshotsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterSnapshotNotFoundException",
"documentation" : " DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBClusterSnapshotsRequest",
"variableName" : "describeDBClusterSnapshotsRequest",
"variableType" : "DescribeDBClusterSnapshotsRequest",
"documentation" : "",
"simpleType" : "DescribeDBClusterSnapshotsRequest",
"variableSetterType" : "DescribeDBClusterSnapshotsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBClusterSnapshots",
"operationName" : "DescribeDBClusterSnapshots",
"returnType" : {
"returnType" : "DescribeDBClusterSnapshotsResult",
"documentation" : " Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
"
},
"syncReturnType" : "DescribeDBClusterSnapshotsResult"
},
"DescribeDBClusters" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBClustersResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBClustersRequest",
"variableName" : "describeDBClustersRequest",
"variableType" : "DescribeDBClustersRequest",
"documentation" : "",
"simpleType" : "DescribeDBClustersRequest",
"variableSetterType" : "DescribeDBClustersRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBClusters",
"operationName" : "DescribeDBClusters",
"returnType" : {
"returnType" : "DescribeDBClustersResult",
"documentation" : "Contains the result of a successful invocation of the DescribeDBClusters action.
"
},
"syncReturnType" : "DescribeDBClustersResult"
},
"DescribeDBEngineVersions" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBEngineVersionsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of the available DB engines.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBEngineVersionsRequest",
"variableName" : "describeDBEngineVersionsRequest",
"variableType" : "DescribeDBEngineVersionsRequest",
"documentation" : "",
"simpleType" : "DescribeDBEngineVersionsRequest",
"variableSetterType" : "DescribeDBEngineVersionsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBEngineVersions",
"operationName" : "DescribeDBEngineVersions",
"returnType" : {
"returnType" : "DescribeDBEngineVersionsResult",
"documentation" : " Contains the result of a successful invocation of the DescribeDBEngineVersions action.
"
},
"syncReturnType" : "DescribeDBEngineVersionsResult"
},
"DescribeDBInstances" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBInstancesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns information about provisioned RDS instances. This API supports pagination.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBInstancesRequest",
"variableName" : "describeDBInstancesRequest",
"variableType" : "DescribeDBInstancesRequest",
"documentation" : "",
"simpleType" : "DescribeDBInstancesRequest",
"variableSetterType" : "DescribeDBInstancesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBInstances",
"operationName" : "DescribeDBInstances",
"returnType" : {
"returnType" : "DescribeDBInstancesResult",
"documentation" : " Contains the result of a successful invocation of the DescribeDBInstances action.
"
},
"syncReturnType" : "DescribeDBInstancesResult"
},
"DescribeDBLogFiles" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBLogFilesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of DB log files for the DB instance.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBLogFilesRequest",
"variableName" : "describeDBLogFilesRequest",
"variableType" : "DescribeDBLogFilesRequest",
"documentation" : "",
"simpleType" : "DescribeDBLogFilesRequest",
"variableSetterType" : "DescribeDBLogFilesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBLogFiles",
"operationName" : "DescribeDBLogFiles",
"returnType" : {
"returnType" : "DescribeDBLogFilesResult",
"documentation" : " The response from a call to DescribeDBLogFiles.
"
},
"syncReturnType" : "DescribeDBLogFilesResult"
},
"DescribeDBParameterGroups" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBParameterGroupsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : " Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBParameterGroupsRequest",
"variableName" : "describeDBParameterGroupsRequest",
"variableType" : "DescribeDBParameterGroupsRequest",
"documentation" : "",
"simpleType" : "DescribeDBParameterGroupsRequest",
"variableSetterType" : "DescribeDBParameterGroupsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBParameterGroups",
"operationName" : "DescribeDBParameterGroups",
"returnType" : {
"returnType" : "DescribeDBParameterGroupsResult",
"documentation" : " Contains the result of a successful invocation of the DescribeDBParameterGroups action.
"
},
"syncReturnType" : "DescribeDBParameterGroupsResult"
},
"DescribeDBParameters" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBParametersResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns the detailed parameter list for a particular DB parameter group.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBParametersRequest",
"variableName" : "describeDBParametersRequest",
"variableType" : "DescribeDBParametersRequest",
"documentation" : "",
"simpleType" : "DescribeDBParametersRequest",
"variableSetterType" : "DescribeDBParametersRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBParameters",
"operationName" : "DescribeDBParameters",
"returnType" : {
"returnType" : "DescribeDBParametersResult",
"documentation" : " Contains the result of a successful invocation of the DescribeDBParameters action.
"
},
"syncReturnType" : "DescribeDBParametersResult"
},
"DescribeDBSecurityGroups" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBSecurityGroupsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : " Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
",
"exceptions" : [ {
"exceptionName" : "DBSecurityGroupNotFoundException",
"documentation" : " DBSecurityGroupName does not refer to an existing DB security group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBSecurityGroupsRequest",
"variableName" : "describeDBSecurityGroupsRequest",
"variableType" : "DescribeDBSecurityGroupsRequest",
"documentation" : "",
"simpleType" : "DescribeDBSecurityGroupsRequest",
"variableSetterType" : "DescribeDBSecurityGroupsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBSecurityGroups",
"operationName" : "DescribeDBSecurityGroups",
"returnType" : {
"returnType" : "DescribeDBSecurityGroupsResult",
"documentation" : " Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
"
},
"syncReturnType" : "DescribeDBSecurityGroupsResult"
},
"DescribeDBSnapshotAttributes" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSnapshotAttributesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
",
"exceptions" : [ {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBSnapshotAttributesRequest",
"variableName" : "describeDBSnapshotAttributesRequest",
"variableType" : "DescribeDBSnapshotAttributesRequest",
"documentation" : "",
"simpleType" : "DescribeDBSnapshotAttributesRequest",
"variableSetterType" : "DescribeDBSnapshotAttributesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBSnapshotAttributes",
"operationName" : "DescribeDBSnapshotAttributes",
"returnType" : {
"returnType" : "DBSnapshotAttributesResult",
"documentation" : "Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.
Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
"
},
"syncReturnType" : "DBSnapshotAttributesResult"
},
"DescribeDBSnapshots" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBSnapshotsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns information about DB snapshots. This API action supports pagination.
",
"exceptions" : [ {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBSnapshotsRequest",
"variableName" : "describeDBSnapshotsRequest",
"variableType" : "DescribeDBSnapshotsRequest",
"documentation" : "",
"simpleType" : "DescribeDBSnapshotsRequest",
"variableSetterType" : "DescribeDBSnapshotsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBSnapshots",
"operationName" : "DescribeDBSnapshots",
"returnType" : {
"returnType" : "DescribeDBSnapshotsResult",
"documentation" : " Contains the result of a successful invocation of the DescribeDBSnapshots action.
"
},
"syncReturnType" : "DescribeDBSnapshotsResult"
},
"DescribeDBSubnetGroups" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeDBSubnetGroupsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
",
"exceptions" : [ {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeDBSubnetGroupsRequest",
"variableName" : "describeDBSubnetGroupsRequest",
"variableType" : "DescribeDBSubnetGroupsRequest",
"documentation" : "",
"simpleType" : "DescribeDBSubnetGroupsRequest",
"variableSetterType" : "DescribeDBSubnetGroupsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeDBSubnetGroups",
"operationName" : "DescribeDBSubnetGroups",
"returnType" : {
"returnType" : "DescribeDBSubnetGroupsResult",
"documentation" : " Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
"
},
"syncReturnType" : "DescribeDBSubnetGroupsResult"
},
"DescribeEngineDefaultClusterParameters" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EngineDefaults",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeEngineDefaultClusterParametersRequest",
"variableName" : "describeEngineDefaultClusterParametersRequest",
"variableType" : "DescribeEngineDefaultClusterParametersRequest",
"documentation" : "",
"simpleType" : "DescribeEngineDefaultClusterParametersRequest",
"variableSetterType" : "DescribeEngineDefaultClusterParametersRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeEngineDefaultClusterParameters",
"operationName" : "DescribeEngineDefaultClusterParameters",
"returnType" : {
"returnType" : "EngineDefaults",
"documentation" : " Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
"
},
"syncReturnType" : "EngineDefaults"
},
"DescribeEngineDefaultParameters" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EngineDefaults",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns the default engine and system parameter information for the specified database engine.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeEngineDefaultParametersRequest",
"variableName" : "describeEngineDefaultParametersRequest",
"variableType" : "DescribeEngineDefaultParametersRequest",
"documentation" : "",
"simpleType" : "DescribeEngineDefaultParametersRequest",
"variableSetterType" : "DescribeEngineDefaultParametersRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeEngineDefaultParameters",
"operationName" : "DescribeEngineDefaultParameters",
"returnType" : {
"returnType" : "EngineDefaults",
"documentation" : " Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
"
},
"syncReturnType" : "EngineDefaults"
},
"DescribeEventCategories" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeEventCategoriesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeEventCategoriesRequest",
"variableName" : "describeEventCategoriesRequest",
"variableType" : "DescribeEventCategoriesRequest",
"documentation" : "",
"simpleType" : "DescribeEventCategoriesRequest",
"variableSetterType" : "DescribeEventCategoriesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeEventCategories",
"operationName" : "DescribeEventCategories",
"returnType" : {
"returnType" : "DescribeEventCategoriesResult",
"documentation" : "Data returned from the DescribeEventCategories action.
"
},
"syncReturnType" : "DescribeEventCategoriesResult"
},
"DescribeEventSubscriptions" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeEventSubscriptionsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
",
"exceptions" : [ {
"exceptionName" : "SubscriptionNotFoundException",
"documentation" : "The subscription name does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeEventSubscriptionsRequest",
"variableName" : "describeEventSubscriptionsRequest",
"variableType" : "DescribeEventSubscriptionsRequest",
"documentation" : "",
"simpleType" : "DescribeEventSubscriptionsRequest",
"variableSetterType" : "DescribeEventSubscriptionsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeEventSubscriptions",
"operationName" : "DescribeEventSubscriptions",
"returnType" : {
"returnType" : "DescribeEventSubscriptionsResult",
"documentation" : "Data returned by the DescribeEventSubscriptions action.
"
},
"syncReturnType" : "DescribeEventSubscriptionsResult"
},
"DescribeEvents" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeEventsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeEventsRequest",
"variableName" : "describeEventsRequest",
"variableType" : "DescribeEventsRequest",
"documentation" : "",
"simpleType" : "DescribeEventsRequest",
"variableSetterType" : "DescribeEventsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeEvents",
"operationName" : "DescribeEvents",
"returnType" : {
"returnType" : "DescribeEventsResult",
"documentation" : " Contains the result of a successful invocation of the DescribeEvents action.
"
},
"syncReturnType" : "DescribeEventsResult"
},
"DescribeOptionGroupOptions" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeOptionGroupOptionsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes all available options.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeOptionGroupOptionsRequest",
"variableName" : "describeOptionGroupOptionsRequest",
"variableType" : "DescribeOptionGroupOptionsRequest",
"documentation" : "",
"simpleType" : "DescribeOptionGroupOptionsRequest",
"variableSetterType" : "DescribeOptionGroupOptionsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeOptionGroupOptions",
"operationName" : "DescribeOptionGroupOptions",
"returnType" : {
"returnType" : "DescribeOptionGroupOptionsResult",
"documentation" : ""
},
"syncReturnType" : "DescribeOptionGroupOptionsResult"
},
"DescribeOptionGroups" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeOptionGroupsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes the available option groups.
",
"exceptions" : [ {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeOptionGroupsRequest",
"variableName" : "describeOptionGroupsRequest",
"variableType" : "DescribeOptionGroupsRequest",
"documentation" : "",
"simpleType" : "DescribeOptionGroupsRequest",
"variableSetterType" : "DescribeOptionGroupsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeOptionGroups",
"operationName" : "DescribeOptionGroups",
"returnType" : {
"returnType" : "DescribeOptionGroupsResult",
"documentation" : "List of option groups.
"
},
"syncReturnType" : "DescribeOptionGroupsResult"
},
"DescribeOrderableDBInstanceOptions" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeOrderableDBInstanceOptionsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of orderable DB instance options for the specified engine.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeOrderableDBInstanceOptionsRequest",
"variableName" : "describeOrderableDBInstanceOptionsRequest",
"variableType" : "DescribeOrderableDBInstanceOptionsRequest",
"documentation" : "",
"simpleType" : "DescribeOrderableDBInstanceOptionsRequest",
"variableSetterType" : "DescribeOrderableDBInstanceOptionsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeOrderableDBInstanceOptions",
"operationName" : "DescribeOrderableDBInstanceOptions",
"returnType" : {
"returnType" : "DescribeOrderableDBInstanceOptionsResult",
"documentation" : " Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
"
},
"syncReturnType" : "DescribeOrderableDBInstanceOptionsResult"
},
"DescribePendingMaintenanceActions" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribePendingMaintenanceActionsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The specified resource ID was not found.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribePendingMaintenanceActionsRequest",
"variableName" : "describePendingMaintenanceActionsRequest",
"variableType" : "DescribePendingMaintenanceActionsRequest",
"documentation" : "",
"simpleType" : "DescribePendingMaintenanceActionsRequest",
"variableSetterType" : "DescribePendingMaintenanceActionsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describePendingMaintenanceActions",
"operationName" : "DescribePendingMaintenanceActions",
"returnType" : {
"returnType" : "DescribePendingMaintenanceActionsResult",
"documentation" : "Data returned from the DescribePendingMaintenanceActions action.
"
},
"syncReturnType" : "DescribePendingMaintenanceActionsResult"
},
"DescribeReservedDBInstances" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeReservedDBInstancesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
",
"exceptions" : [ {
"exceptionName" : "ReservedDBInstanceNotFoundException",
"documentation" : "The specified reserved DB Instance not found.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeReservedDBInstancesRequest",
"variableName" : "describeReservedDBInstancesRequest",
"variableType" : "DescribeReservedDBInstancesRequest",
"documentation" : "",
"simpleType" : "DescribeReservedDBInstancesRequest",
"variableSetterType" : "DescribeReservedDBInstancesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeReservedDBInstances",
"operationName" : "DescribeReservedDBInstances",
"returnType" : {
"returnType" : "DescribeReservedDBInstancesResult",
"documentation" : " Contains the result of a successful invocation of the DescribeReservedDBInstances action.
"
},
"syncReturnType" : "DescribeReservedDBInstancesResult"
},
"DescribeReservedDBInstancesOfferings" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeReservedDBInstancesOfferingsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists available reserved DB instance offerings.
",
"exceptions" : [ {
"exceptionName" : "ReservedDBInstancesOfferingNotFoundException",
"documentation" : "Specified offering does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeReservedDBInstancesOfferingsRequest",
"variableName" : "describeReservedDBInstancesOfferingsRequest",
"variableType" : "DescribeReservedDBInstancesOfferingsRequest",
"documentation" : "",
"simpleType" : "DescribeReservedDBInstancesOfferingsRequest",
"variableSetterType" : "DescribeReservedDBInstancesOfferingsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeReservedDBInstancesOfferings",
"operationName" : "DescribeReservedDBInstancesOfferings",
"returnType" : {
"returnType" : "DescribeReservedDBInstancesOfferingsResult",
"documentation" : " Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
"
},
"syncReturnType" : "DescribeReservedDBInstancesOfferingsResult"
},
"DescribeSourceRegions" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeSourceRegionsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of the source AWS regions where the current AWS region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
",
"exceptions" : null,
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeSourceRegionsRequest",
"variableName" : "describeSourceRegionsRequest",
"variableType" : "DescribeSourceRegionsRequest",
"documentation" : "",
"simpleType" : "DescribeSourceRegionsRequest",
"variableSetterType" : "DescribeSourceRegionsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeSourceRegions",
"operationName" : "DescribeSourceRegions",
"returnType" : {
"returnType" : "DescribeSourceRegionsResult",
"documentation" : "Contains the result of a successful invocation of the DescribeSourceRegions action.
"
},
"syncReturnType" : "DescribeSourceRegionsResult"
},
"DownloadDBLogFilePortion" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DownloadDBLogFilePortionResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Downloads all or a portion of the specified log file, up to 1 MB in size.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
}, {
"exceptionName" : "DBLogFileNotFoundException",
"documentation" : " LogFileName does not refer to an existing DB log file.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DownloadDBLogFilePortionRequest",
"variableName" : "downloadDBLogFilePortionRequest",
"variableType" : "DownloadDBLogFilePortionRequest",
"documentation" : "",
"simpleType" : "DownloadDBLogFilePortionRequest",
"variableSetterType" : "DownloadDBLogFilePortionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "downloadDBLogFilePortion",
"operationName" : "DownloadDBLogFilePortion",
"returnType" : {
"returnType" : "DownloadDBLogFilePortionResult",
"documentation" : "This data type is used as a response element to DownloadDBLogFilePortion.
"
},
"syncReturnType" : "DownloadDBLogFilePortionResult"
},
"FailoverDBCluster" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBCluster",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.
Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
}, {
"exceptionName" : "InvalidDBInstanceStateException",
"documentation" : " The specified DB instance is not in the available state.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "FailoverDBClusterRequest",
"variableName" : "failoverDBClusterRequest",
"variableType" : "FailoverDBClusterRequest",
"documentation" : "",
"simpleType" : "FailoverDBClusterRequest",
"variableSetterType" : "FailoverDBClusterRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "failoverDBCluster",
"operationName" : "FailoverDBCluster",
"returnType" : {
"returnType" : "DBCluster",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
-
-
This data type is used as a response element in the DescribeDBClusters action.
"
},
"syncReturnType" : "DBCluster"
},
"ListTagsForResource" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListTagsForResourceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
}, {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListTagsForResourceRequest",
"variableName" : "listTagsForResourceRequest",
"variableType" : "ListTagsForResourceRequest",
"documentation" : "",
"simpleType" : "ListTagsForResourceRequest",
"variableSetterType" : "ListTagsForResourceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listTagsForResource",
"operationName" : "ListTagsForResource",
"returnType" : {
"returnType" : "ListTagsForResourceResult",
"documentation" : ""
},
"syncReturnType" : "ListTagsForResourceResult"
},
"ModifyDBCluster" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBCluster",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "InvalidDBSubnetGroupStateException",
"documentation" : "The DB subnet group cannot be deleted because it is in use.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
}, {
"exceptionName" : "DBClusterParameterGroupNotFoundException",
"documentation" : " DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
"
}, {
"exceptionName" : "InvalidDBSecurityGroupStateException",
"documentation" : "The state of the DB security group does not allow deletion.
"
}, {
"exceptionName" : "InvalidDBInstanceStateException",
"documentation" : " The specified DB instance is not in the available state.
"
}, {
"exceptionName" : "DBClusterAlreadyExistsException",
"documentation" : "User already has a DB cluster with the given identifier.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyDBClusterRequest",
"variableName" : "modifyDBClusterRequest",
"variableType" : "ModifyDBClusterRequest",
"documentation" : "",
"simpleType" : "ModifyDBClusterRequest",
"variableSetterType" : "ModifyDBClusterRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyDBCluster",
"operationName" : "ModifyDBCluster",
"returnType" : {
"returnType" : "DBCluster",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
-
-
This data type is used as a response element in the DescribeDBClusters action.
"
},
"syncReturnType" : "DBCluster"
},
"ModifyDBClusterParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ModifyDBClusterParameterGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : " Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
}, {
"exceptionName" : "InvalidDBParameterGroupStateException",
"documentation" : "The DB parameter group cannot be deleted because it is in use.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyDBClusterParameterGroupRequest",
"variableName" : "modifyDBClusterParameterGroupRequest",
"variableType" : "ModifyDBClusterParameterGroupRequest",
"documentation" : "",
"simpleType" : "ModifyDBClusterParameterGroupRequest",
"variableSetterType" : "ModifyDBClusterParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyDBClusterParameterGroup",
"operationName" : "ModifyDBClusterParameterGroup",
"returnType" : {
"returnType" : "ModifyDBClusterParameterGroupResult",
"documentation" : ""
},
"syncReturnType" : "ModifyDBClusterParameterGroupResult"
},
"ModifyDBClusterSnapshotAttribute" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBClusterSnapshotAttributesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
If a manual DB cluster snapshot is encrypted, it cannot be shared.
",
"exceptions" : [ {
"exceptionName" : "DBClusterSnapshotNotFoundException",
"documentation" : " DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
"
}, {
"exceptionName" : "InvalidDBClusterSnapshotStateException",
"documentation" : "The supplied value is not a valid DB cluster snapshot state.
"
}, {
"exceptionName" : "SharedSnapshotQuotaExceededException",
"documentation" : "You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyDBClusterSnapshotAttributeRequest",
"variableName" : "modifyDBClusterSnapshotAttributeRequest",
"variableType" : "ModifyDBClusterSnapshotAttributeRequest",
"documentation" : "",
"simpleType" : "ModifyDBClusterSnapshotAttributeRequest",
"variableSetterType" : "ModifyDBClusterSnapshotAttributeRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyDBClusterSnapshotAttribute",
"operationName" : "ModifyDBClusterSnapshotAttribute",
"returnType" : {
"returnType" : "DBClusterSnapshotAttributesResult",
"documentation" : "Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
"
},
"syncReturnType" : "DBClusterSnapshotAttributesResult"
},
"ModifyDBInstance" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBInstance",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBInstanceStateException",
"documentation" : " The specified DB instance is not in the available state.
"
}, {
"exceptionName" : "InvalidDBSecurityGroupStateException",
"documentation" : "The state of the DB security group does not allow deletion.
"
}, {
"exceptionName" : "DBInstanceAlreadyExistsException",
"documentation" : "User already has a DB instance with the given identifier.
"
}, {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
}, {
"exceptionName" : "DBSecurityGroupNotFoundException",
"documentation" : " DBSecurityGroupName does not refer to an existing DB security group.
"
}, {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
}, {
"exceptionName" : "InsufficientDBInstanceCapacityException",
"documentation" : "Specified DB instance class is not available in the specified Availability Zone.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "ProvisionedIopsNotAvailableInAZException",
"documentation" : "Provisioned IOPS not available in the specified Availability Zone.
"
}, {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
}, {
"exceptionName" : "DBUpgradeDependencyFailureException",
"documentation" : "The DB upgrade failed because a resource the DB depends on could not be modified.
"
}, {
"exceptionName" : "StorageTypeNotSupportedException",
"documentation" : " StorageType specified cannot be associated with the DB Instance.
"
}, {
"exceptionName" : "AuthorizationNotFoundException",
"documentation" : "Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
"
}, {
"exceptionName" : "CertificateNotFoundException",
"documentation" : " CertificateIdentifier does not refer to an existing certificate.
"
}, {
"exceptionName" : "DomainNotFoundException",
"documentation" : " Domain does not refer to an existing Active Directory Domain.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyDBInstanceRequest",
"variableName" : "modifyDBInstanceRequest",
"variableType" : "ModifyDBInstanceRequest",
"documentation" : "",
"simpleType" : "ModifyDBInstanceRequest",
"variableSetterType" : "ModifyDBInstanceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyDBInstance",
"operationName" : "ModifyDBInstance",
"returnType" : {
"returnType" : "DBInstance",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
"
},
"syncReturnType" : "DBInstance"
},
"ModifyDBParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ModifyDBParameterGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : " Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
",
"exceptions" : [ {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
}, {
"exceptionName" : "InvalidDBParameterGroupStateException",
"documentation" : "The DB parameter group cannot be deleted because it is in use.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyDBParameterGroupRequest",
"variableName" : "modifyDBParameterGroupRequest",
"variableType" : "ModifyDBParameterGroupRequest",
"documentation" : "",
"simpleType" : "ModifyDBParameterGroupRequest",
"variableSetterType" : "ModifyDBParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyDBParameterGroup",
"operationName" : "ModifyDBParameterGroup",
"returnType" : {
"returnType" : "ModifyDBParameterGroupResult",
"documentation" : " Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
"
},
"syncReturnType" : "ModifyDBParameterGroupResult"
},
"ModifyDBSnapshotAttribute" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSnapshotAttributesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.
If the manual DB snapshot is encrypted, it cannot be shared.
",
"exceptions" : [ {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
}, {
"exceptionName" : "InvalidDBSnapshotStateException",
"documentation" : "The state of the DB snapshot does not allow deletion.
"
}, {
"exceptionName" : "SharedSnapshotQuotaExceededException",
"documentation" : "You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyDBSnapshotAttributeRequest",
"variableName" : "modifyDBSnapshotAttributeRequest",
"variableType" : "ModifyDBSnapshotAttributeRequest",
"documentation" : "",
"simpleType" : "ModifyDBSnapshotAttributeRequest",
"variableSetterType" : "ModifyDBSnapshotAttributeRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyDBSnapshotAttribute",
"operationName" : "ModifyDBSnapshotAttribute",
"returnType" : {
"returnType" : "DBSnapshotAttributesResult",
"documentation" : "Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.
Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
"
},
"syncReturnType" : "DBSnapshotAttributesResult"
},
"ModifyDBSubnetGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBSubnetGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
",
"exceptions" : [ {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "DBSubnetQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
"
}, {
"exceptionName" : "SubnetAlreadyInUseException",
"documentation" : "The DB subnet is already in use in the Availability Zone.
"
}, {
"exceptionName" : "DBSubnetGroupDoesNotCoverEnoughAZsException",
"documentation" : "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyDBSubnetGroupRequest",
"variableName" : "modifyDBSubnetGroupRequest",
"variableType" : "ModifyDBSubnetGroupRequest",
"documentation" : "",
"simpleType" : "ModifyDBSubnetGroupRequest",
"variableSetterType" : "ModifyDBSubnetGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyDBSubnetGroup",
"operationName" : "ModifyDBSubnetGroup",
"returnType" : {
"returnType" : "DBSubnetGroup",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
"
},
"syncReturnType" : "DBSubnetGroup"
},
"ModifyEventSubscription" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EventSubscription",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
",
"exceptions" : [ {
"exceptionName" : "EventSubscriptionQuotaExceededException",
"documentation" : "You have reached the maximum number of event subscriptions.
"
}, {
"exceptionName" : "SubscriptionNotFoundException",
"documentation" : "The subscription name does not exist.
"
}, {
"exceptionName" : "SNSInvalidTopicException",
"documentation" : "SNS has responded that there is a problem with the SND topic specified.
"
}, {
"exceptionName" : "SNSNoAuthorizationException",
"documentation" : "You do not have permission to publish to the SNS topic ARN.
"
}, {
"exceptionName" : "SNSTopicArnNotFoundException",
"documentation" : "The SNS topic ARN does not exist.
"
}, {
"exceptionName" : "SubscriptionCategoryNotFoundException",
"documentation" : "The supplied category does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyEventSubscriptionRequest",
"variableName" : "modifyEventSubscriptionRequest",
"variableType" : "ModifyEventSubscriptionRequest",
"documentation" : "",
"simpleType" : "ModifyEventSubscriptionRequest",
"variableSetterType" : "ModifyEventSubscriptionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyEventSubscription",
"operationName" : "ModifyEventSubscription",
"returnType" : {
"returnType" : "EventSubscription",
"documentation" : "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
"
},
"syncReturnType" : "EventSubscription"
},
"ModifyOptionGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "OptionGroup",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Modifies an existing option group.
",
"exceptions" : [ {
"exceptionName" : "InvalidOptionGroupStateException",
"documentation" : " The option group is not in the available state.
"
}, {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ModifyOptionGroupRequest",
"variableName" : "modifyOptionGroupRequest",
"variableType" : "ModifyOptionGroupRequest",
"documentation" : "",
"simpleType" : "ModifyOptionGroupRequest",
"variableSetterType" : "ModifyOptionGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "modifyOptionGroup",
"operationName" : "ModifyOptionGroup",
"returnType" : {
"returnType" : "OptionGroup",
"documentation" : ""
},
"syncReturnType" : "OptionGroup"
},
"PromoteReadReplica" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBInstance",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Promotes a Read Replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBInstanceStateException",
"documentation" : " The specified DB instance is not in the available state.
"
}, {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PromoteReadReplicaRequest",
"variableName" : "promoteReadReplicaRequest",
"variableType" : "PromoteReadReplicaRequest",
"documentation" : "",
"simpleType" : "PromoteReadReplicaRequest",
"variableSetterType" : "PromoteReadReplicaRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "promoteReadReplica",
"operationName" : "PromoteReadReplica",
"returnType" : {
"returnType" : "DBInstance",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
"
},
"syncReturnType" : "DBInstance"
},
"PromoteReadReplicaDBCluster" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBCluster",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Promotes a Read Replica DB cluster to a standalone DB cluster.
",
"exceptions" : [ {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PromoteReadReplicaDBClusterRequest",
"variableName" : "promoteReadReplicaDBClusterRequest",
"variableType" : "PromoteReadReplicaDBClusterRequest",
"documentation" : "",
"simpleType" : "PromoteReadReplicaDBClusterRequest",
"variableSetterType" : "PromoteReadReplicaDBClusterRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "promoteReadReplicaDBCluster",
"operationName" : "PromoteReadReplicaDBCluster",
"returnType" : {
"returnType" : "DBCluster",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
-
-
This data type is used as a response element in the DescribeDBClusters action.
"
},
"syncReturnType" : "DBCluster"
},
"PurchaseReservedDBInstancesOffering" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ReservedDBInstance",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Purchases a reserved DB instance offering.
",
"exceptions" : [ {
"exceptionName" : "ReservedDBInstancesOfferingNotFoundException",
"documentation" : "Specified offering does not exist.
"
}, {
"exceptionName" : "ReservedDBInstanceAlreadyExistsException",
"documentation" : "User already has a reservation with the given identifier.
"
}, {
"exceptionName" : "ReservedDBInstanceQuotaExceededException",
"documentation" : "Request would exceed the user's DB Instance quota.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PurchaseReservedDBInstancesOfferingRequest",
"variableName" : "purchaseReservedDBInstancesOfferingRequest",
"variableType" : "PurchaseReservedDBInstancesOfferingRequest",
"documentation" : "",
"simpleType" : "PurchaseReservedDBInstancesOfferingRequest",
"variableSetterType" : "PurchaseReservedDBInstancesOfferingRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "purchaseReservedDBInstancesOffering",
"operationName" : "PurchaseReservedDBInstancesOffering",
"returnType" : {
"returnType" : "ReservedDBInstance",
"documentation" : " This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
"
},
"syncReturnType" : "ReservedDBInstance"
},
"RebootDBInstance" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBInstance",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBInstanceStateException",
"documentation" : " The specified DB instance is not in the available state.
"
}, {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RebootDBInstanceRequest",
"variableName" : "rebootDBInstanceRequest",
"variableType" : "RebootDBInstanceRequest",
"documentation" : "",
"simpleType" : "RebootDBInstanceRequest",
"variableSetterType" : "RebootDBInstanceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "rebootDBInstance",
"operationName" : "RebootDBInstance",
"returnType" : {
"returnType" : "DBInstance",
"documentation" : "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
"
},
"syncReturnType" : "DBInstance"
},
"RemoveSourceIdentifierFromSubscription" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EventSubscription",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Removes a source identifier from an existing RDS event notification subscription.
",
"exceptions" : [ {
"exceptionName" : "SubscriptionNotFoundException",
"documentation" : "The subscription name does not exist.
"
}, {
"exceptionName" : "SourceNotFoundException",
"documentation" : "The requested source could not be found.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RemoveSourceIdentifierFromSubscriptionRequest",
"variableName" : "removeSourceIdentifierFromSubscriptionRequest",
"variableType" : "RemoveSourceIdentifierFromSubscriptionRequest",
"documentation" : "",
"simpleType" : "RemoveSourceIdentifierFromSubscriptionRequest",
"variableSetterType" : "RemoveSourceIdentifierFromSubscriptionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "removeSourceIdentifierFromSubscription",
"operationName" : "RemoveSourceIdentifierFromSubscription",
"returnType" : {
"returnType" : "EventSubscription",
"documentation" : "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
"
},
"syncReturnType" : "EventSubscription"
},
"RemoveTagsFromResource" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "RemoveTagsFromResourceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceNotFoundException",
"documentation" : " DBInstanceIdentifier does not refer to an existing DB instance.
"
}, {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RemoveTagsFromResourceRequest",
"variableName" : "removeTagsFromResourceRequest",
"variableType" : "RemoveTagsFromResourceRequest",
"documentation" : "",
"simpleType" : "RemoveTagsFromResourceRequest",
"variableSetterType" : "RemoveTagsFromResourceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "removeTagsFromResource",
"operationName" : "RemoveTagsFromResource",
"returnType" : {
"returnType" : "RemoveTagsFromResourceResult",
"documentation" : null
},
"syncReturnType" : "RemoveTagsFromResourceResult"
},
"ResetDBClusterParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ResetDBClusterParameterGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : " Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBParameterGroupStateException",
"documentation" : "The DB parameter group cannot be deleted because it is in use.
"
}, {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ResetDBClusterParameterGroupRequest",
"variableName" : "resetDBClusterParameterGroupRequest",
"variableType" : "ResetDBClusterParameterGroupRequest",
"documentation" : "",
"simpleType" : "ResetDBClusterParameterGroupRequest",
"variableSetterType" : "ResetDBClusterParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "resetDBClusterParameterGroup",
"operationName" : "ResetDBClusterParameterGroup",
"returnType" : {
"returnType" : "ResetDBClusterParameterGroupResult",
"documentation" : ""
},
"syncReturnType" : "ResetDBClusterParameterGroupResult"
},
"ResetDBParameterGroup" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ResetDBParameterGroupResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : " Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
",
"exceptions" : [ {
"exceptionName" : "InvalidDBParameterGroupStateException",
"documentation" : "The DB parameter group cannot be deleted because it is in use.
"
}, {
"exceptionName" : "DBParameterGroupNotFoundException",
"documentation" : " DBParameterGroupName does not refer to an existing DB parameter group.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ResetDBParameterGroupRequest",
"variableName" : "resetDBParameterGroupRequest",
"variableType" : "ResetDBParameterGroupRequest",
"documentation" : "",
"simpleType" : "ResetDBParameterGroupRequest",
"variableSetterType" : "ResetDBParameterGroupRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "resetDBParameterGroup",
"operationName" : "ResetDBParameterGroup",
"returnType" : {
"returnType" : "ResetDBParameterGroupResult",
"documentation" : " Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
"
},
"syncReturnType" : "ResetDBParameterGroupResult"
},
"RestoreDBClusterFromS3" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBCluster",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket.
",
"exceptions" : [ {
"exceptionName" : "DBClusterAlreadyExistsException",
"documentation" : "User already has a DB cluster with the given identifier.
"
}, {
"exceptionName" : "DBClusterQuotaExceededException",
"documentation" : "User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "InvalidDBClusterStateException",
"documentation" : "The DB cluster is not in a valid state.
"
}, {
"exceptionName" : "InvalidDBSubnetGroupStateException",
"documentation" : "The DB subnet group cannot be deleted because it is in use.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
}, {
"exceptionName" : "InvalidS3BucketException",
"documentation" : "The specified Amazon S3 bucket name could not be found or Amazon RDS is not authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
"
}, {
"exceptionName" : "DBClusterParameterGroupNotFoundException",
"documentation" : " DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
"
}, {
"exceptionName" : "KMSKeyNotAccessibleException",
"documentation" : "Error accessing KMS key.
"
}, {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
}, {
"exceptionName" : "InsufficientStorageClusterCapacityException",
"documentation" : "There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RestoreDBClusterFromS3Request",
"variableName" : "restoreDBClusterFromS3Request",
"variableType" : "RestoreDBClusterFromS3Request",
"documentation" : "",
"simpleType" : "RestoreDBClusterFromS3Request",
"variableSetterType" : "RestoreDBClusterFromS3Request"
},
"inputStreamPropertyName" : null,
"methodName" : "restoreDBClusterFromS3",
"operationName" : "RestoreDBClusterFromS3",
"returnType" : {
"returnType" : "DBCluster",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
-
-
This data type is used as a response element in the DescribeDBClusters action.
"
},
"syncReturnType" : "DBCluster"
},
"RestoreDBClusterFromSnapshot" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBCluster",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterAlreadyExistsException",
"documentation" : "User already has a DB cluster with the given identifier.
"
}, {
"exceptionName" : "DBClusterQuotaExceededException",
"documentation" : "User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
}, {
"exceptionName" : "DBClusterSnapshotNotFoundException",
"documentation" : " DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
"
}, {
"exceptionName" : "InsufficientDBClusterCapacityException",
"documentation" : "The DB cluster does not have enough capacity for the current operation.
"
}, {
"exceptionName" : "InsufficientStorageClusterCapacityException",
"documentation" : "There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
"
}, {
"exceptionName" : "InvalidDBSnapshotStateException",
"documentation" : "The state of the DB snapshot does not allow deletion.
"
}, {
"exceptionName" : "InvalidDBClusterSnapshotStateException",
"documentation" : "The supplied value is not a valid DB cluster snapshot state.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "InvalidRestoreException",
"documentation" : "Cannot restore from vpc backup to non-vpc DB instance.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
}, {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
}, {
"exceptionName" : "KMSKeyNotAccessibleException",
"documentation" : "Error accessing KMS key.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RestoreDBClusterFromSnapshotRequest",
"variableName" : "restoreDBClusterFromSnapshotRequest",
"variableType" : "RestoreDBClusterFromSnapshotRequest",
"documentation" : "",
"simpleType" : "RestoreDBClusterFromSnapshotRequest",
"variableSetterType" : "RestoreDBClusterFromSnapshotRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "restoreDBClusterFromSnapshot",
"operationName" : "RestoreDBClusterFromSnapshot",
"returnType" : {
"returnType" : "DBCluster",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
-
-
This data type is used as a response element in the DescribeDBClusters action.
"
},
"syncReturnType" : "DBCluster"
},
"RestoreDBClusterToPointInTime" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBCluster",
"authenticated" : true,
"deprecated" : false,
"documentation" : " Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
",
"exceptions" : [ {
"exceptionName" : "DBClusterAlreadyExistsException",
"documentation" : "User already has a DB cluster with the given identifier.
"
}, {
"exceptionName" : "DBClusterQuotaExceededException",
"documentation" : "User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "DBClusterNotFoundException",
"documentation" : " DBClusterIdentifier does not refer to an existing DB cluster.
"
}, {
"exceptionName" : "DBClusterSnapshotNotFoundException",
"documentation" : " DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
"
}, {
"exceptionName" : "InsufficientDBClusterCapacityException",
"documentation" : "The DB cluster does not have enough capacity for the current operation.
"
}, {
"exceptionName" : "InsufficientStorageClusterCapacityException",
"documentation" : "There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
"
}, {
"exceptionName" : "InvalidDBSnapshotStateException",
"documentation" : "The state of the DB snapshot does not allow deletion.
"
}, {
"exceptionName" : "InvalidDBClusterSnapshotStateException",
"documentation" : "The supplied value is not a valid DB cluster snapshot state.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "InvalidRestoreException",
"documentation" : "Cannot restore from vpc backup to non-vpc DB instance.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
}, {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
}, {
"exceptionName" : "KMSKeyNotAccessibleException",
"documentation" : "Error accessing KMS key.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RestoreDBClusterToPointInTimeRequest",
"variableName" : "restoreDBClusterToPointInTimeRequest",
"variableType" : "RestoreDBClusterToPointInTimeRequest",
"documentation" : "",
"simpleType" : "RestoreDBClusterToPointInTimeRequest",
"variableSetterType" : "RestoreDBClusterToPointInTimeRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "restoreDBClusterToPointInTime",
"operationName" : "RestoreDBClusterToPointInTime",
"returnType" : {
"returnType" : "DBCluster",
"documentation" : "Contains the result of a successful invocation of the following actions:
-
-
-
-
-
-
This data type is used as a response element in the DescribeDBClusters action.
"
},
"syncReturnType" : "DBCluster"
},
"RestoreDBInstanceFromDBSnapshot" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DBInstance",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
",
"exceptions" : [ {
"exceptionName" : "DBInstanceAlreadyExistsException",
"documentation" : "User already has a DB instance with the given identifier.
"
}, {
"exceptionName" : "DBSnapshotNotFoundException",
"documentation" : " DBSnapshotIdentifier does not refer to an existing DB snapshot.
"
}, {
"exceptionName" : "InstanceQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed number of DB instances.
"
}, {
"exceptionName" : "InsufficientDBInstanceCapacityException",
"documentation" : "Specified DB instance class is not available in the specified Availability Zone.
"
}, {
"exceptionName" : "InvalidDBSnapshotStateException",
"documentation" : "The state of the DB snapshot does not allow deletion.
"
}, {
"exceptionName" : "StorageQuotaExceededException",
"documentation" : "Request would result in user exceeding the allowed amount of storage available across all DB instances.
"
}, {
"exceptionName" : "InvalidVPCNetworkStateException",
"documentation" : "DB subnet group does not cover all Availability Zones after it is created because users' change.
"
}, {
"exceptionName" : "InvalidRestoreException",
"documentation" : "Cannot restore from vpc backup to non-vpc DB instance.
"
}, {
"exceptionName" : "DBSubnetGroupNotFoundException",
"documentation" : " DBSubnetGroupName does not refer to an existing DB subnet group.
"
}, {
"exceptionName" : "DBSubnetGroupDoesNotCoverEnoughAZsException",
"documentation" : "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
"
}, {
"exceptionName" : "InvalidSubnetException",
"documentation" : "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
"
}, {
"exceptionName" : "ProvisionedIopsNotAvailableInAZException",
"documentation" : "Provisioned IOPS not available in the specified Availability Zone.
"
}, {
"exceptionName" : "OptionGroupNotFoundException",
"documentation" : "The specified option group could not be found.
"
}, {
"exceptionName" : "StorageTypeNotSupportedException",
"documentation" : " StorageType specified cannot be associated with the DB Instance.
"
}, {
"exceptionName" : "AuthorizationNotFoundException",
"documentation" : "Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
"
}, {
"exceptionName" : "KMSKeyNotAccessibleException",
"documentation" : "Error accessing KMS key.
"
}, {
"exceptionName" : "DBSecurityGroupNotFoundException",
"documentation" : " DBSecurityGroupName does not refer to an existing DB security group.
"
}, {
"exceptionName" : "DomainNotFoundException",
"documentation" : " Domain does not refer to an existing Active Directory Domain.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RestoreDBInstanceFromDBSnapshotRequest",
"variableName" : "restoreDBInstanceFromDBSnapshotRequest",
"variableType" : "RestoreDBInstanceFromDBSnapshotRequest",
"documentation" : "",
"simpleType" : "RestoreDBInstanceFromDBSnapshotRequest",
"variableSetterType" : "RestoreDBInstanceFromDBSnapshotRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "restoreDBInstanceFromDBSnapshot",
"operationName" : "RestoreDBInstanceFromDBSnapshot",
"returnType" : {
"returnType" : "DBInstance",
"documentation" : "Contains the result of a successful invocation of the following actions:
-