GetOdbPeeringConnection
Retrieves information about an ODB peering connection.
Request Syntax
{
"odbPeeringConnectionId": "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.
- odbPeeringConnectionId
-
The unique identifier of the ODB peering connection to retrieve information about.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 2048.
Pattern:
(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})
Required: Yes
Response Syntax
{
"odbPeeringConnection": {
"createdAt": "string",
"displayName": "string",
"odbNetworkArn": "string",
"odbPeeringConnectionArn": "string",
"odbPeeringConnectionId": "string",
"odbPeeringConnectionType": "string",
"peerNetworkArn": "string",
"percentProgress": number,
"status": "string",
"statusReason": "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.
- odbPeeringConnection
-
A peering connection between an ODB network and either another ODB network or a customer-owned VPC.
Type: OdbPeeringConnection object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.
HTTP Status Code: 400
- InternalServerException
-
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The request has failed validation because it is missing required fields or has invalid inputs.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: