Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

DescribeRdsDbInstances

Describes Amazon RDS instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Request Syntax

{
   "RdsDbInstanceArns": [ "string" ],
   "StackId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

RdsDbInstanceArns

An array containing the ARNs of the instances to be described.

Type: Array of strings

Required: No

StackId

The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.

Type: String

Required: Yes

Response Syntax

{
   "RdsDbInstances": [ 
      { 
         "Address": "string",
         "DbInstanceIdentifier": "string",
         "DbPassword": "string",
         "DbUser": "string",
         "Engine": "string",
         "MissingOnRds": boolean,
         "RdsDbInstanceArn": "string",
         "Region": "string",
         "StackId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RdsDbInstances

An a array of RdsDbInstance objects that describe the instances.

Type: Array of RdsDbInstance objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: