DescribeDBProxies
Returns information about DB proxies.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBProxyName
-
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your AWS account ID.
Type: String
Required: No
- Filters.Filter.N
-
This parameter is not currently supported.
Type: Array of Filter objects
Required: No
- Marker
-
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.Type: String
Required: No
- MaxRecords
-
The maximum number of records to include in the response. If more records exist than the specified
MaxRecordsvalue, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Valid Range: Minimum value of 20. Maximum value of 100.
Required: No
Response Elements
The following elements are returned by the service.
- DBProxies.member.N
-
A return value representing an arbitrary number of
DBProxydata structures.Type: Array of DBProxy objects
- Marker
-
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBProxyNotFoundFault
-
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
