Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListOdbNetworks

Returns information about the ODB networks owned by your AWS account.

Request Syntax


{
   "maxResults": number,
   "nextToken": "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 items to return for this request. To get the next page of items, make another request with the token returned in the output.

Default: 10

Type: Integer

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

Required: No

nextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Type: String

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

Required: No

Response Syntax


{
   "nextToken": "string",
   "odbNetworks": [ 
      { 
         "availabilityZone": "string",
         "availabilityZoneId": "string",
         "backupSubnetCidr": "string",
         "clientSubnetCidr": "string",
         "createdAt": "string",
         "customDomainName": "string",
         "defaultDnsPrefix": "string",
         "displayName": "string",
         "managedServices": { 
            "managedS3BackupAccess": { 
               "ipv4Addresses": [ "string" ],
               "status": "string"
            },
            "managedServicesIpv4Cidrs": [ "string" ],
            "resourceGatewayArn": "string",
            "s3Access": { 
               "domainName": "string",
               "ipv4Addresses": [ "string" ],
               "s3PolicyDocument": "string",
               "status": "string"
            },
            "serviceNetworkArn": "string",
            "serviceNetworkEndpoint": { 
               "vpcEndpointId": "string",
               "vpcEndpointType": "string"
            },
            "zeroEtlAccess": { 
               "cidr": "string",
               "status": "string"
            }
         },
         "ociDnsForwardingConfigs": [ 
            { 
               "domainName": "string",
               "ociDnsListenerIp": "string"
            }
         ],
         "ociNetworkAnchorId": "string",
         "ociNetworkAnchorUrl": "string",
         "ociResourceAnchorName": "string",
         "ociVcnId": "string",
         "ociVcnUrl": "string",
         "odbNetworkArn": "string",
         "odbNetworkId": "string",
         "peeredCidrs": [ "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 token to include in another request to get the next page of items. This value is null when there are no more items to return.

Type: String

odbNetworks

The list of ODB networks.

Type: Array of OdbNetworkSummary 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

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