# GetOdbNetwork


Returns information about the specified ODB network.

## Request Syntax


```
{
   "odbNetworkId": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [odbNetworkId](#API_GetOdbNetwork_RequestSyntax) **   <a name="odb-GetOdbNetwork-request-odbNetworkId"></a>
The unique identifier of the ODB network.  
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


```
{
   "odbNetwork": { 
      "availabilityZone": "string",
      "availabilityZoneId": "string",
      "backupSubnetCidr": "string",
      "clientSubnetCidr": "string",
      "createdAt": "string",
      "customDomainName": "string",
      "defaultDnsPrefix": "string",
      "displayName": "string",
      "ec2PlacementGroupIds": [ "string" ],
      "managedServices": { 
         "crossRegionS3RestoreSourcesAccess": [ 
            { 
               "ipv4Addresses": [ "string" ],
               "region": "string",
               "status": "string"
            }
         ],
         "kmsAccess": { 
            "domainName": "string",
            "ipv4Addresses": [ "string" ],
            "kmsPolicyDocument": "string",
            "status": "string"
         },
         "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"
         },
         "stsAccess": { 
            "domainName": "string",
            "ipv4Addresses": [ "string" ],
            "status": "string",
            "stsPolicyDocument": "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.

 ** [odbNetwork](#API_GetOdbNetwork_ResponseSyntax) **   <a name="odb-GetOdbNetwork-response-odbNetwork"></a>
The ODB network.  
Type: [OdbNetwork](API_OdbNetwork.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
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.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetOdbNetwork)