Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListOdbPeeringConnections

Lists all ODB peering connections or those associated with a specific ODB network.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string",
   "odbNetworkId": "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.

maxResults

The maximum number of ODB peering connections to return in the response.

Default: 20

Constraints:

Must be between 1 and 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

The pagination token for the next page of ODB peering connections.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Required: No

odbNetworkId

The identifier of the ODB network to list peering connections for.

If not specified, lists all ODB peering connections in the account.

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: No

Response Syntax


{
   "nextToken": "string",
   "odbPeeringConnections": [ 
      { 
         "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.

nextToken

The pagination token for the next page of ODB peering connections.

Type: String

odbPeeringConnections

The list of ODB peering connections.

Type: Array of OdbPeeringConnectionSummary objects

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