:doc:`odb <../../odb>` / Client / get_odb_network

***************
get_odb_network
***************



.. py:method:: odb.Client.get_odb_network(**kwargs)

  

  Returns information about the specified ODB network.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/odb-2024-08-20/GetOdbNetwork>`_  


  **Request Syntax**
  ::

    response = client.get_odb_network(
        odbNetworkId='string'
    )
    
  :type odbNetworkId: string
  :param odbNetworkId: **[REQUIRED]** 

    The unique identifier of the ODB network.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'odbNetwork': {
              'odbNetworkId': 'string',
              'displayName': 'string',
              'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
              'statusReason': 'string',
              'odbNetworkArn': 'string',
              'availabilityZone': 'string',
              'availabilityZoneId': 'string',
              'clientSubnetCidr': 'string',
              'backupSubnetCidr': 'string',
              'customDomainName': 'string',
              'defaultDnsPrefix': 'string',
              'peeredCidrs': [
                  'string',
              ],
              'ociNetworkAnchorId': 'string',
              'ociNetworkAnchorUrl': 'string',
              'ociResourceAnchorName': 'string',
              'ociVcnId': 'string',
              'ociVcnUrl': 'string',
              'ociDnsForwardingConfigs': [
                  {
                      'domainName': 'string',
                      'ociDnsListenerIp': 'string'
                  },
              ],
              'createdAt': datetime(2015, 1, 1),
              'percentProgress': ...,
              'managedServices': {
                  'serviceNetworkArn': 'string',
                  'resourceGatewayArn': 'string',
                  'managedServicesIpv4Cidrs': [
                      'string',
                  ],
                  'serviceNetworkEndpoint': {
                      'vpcEndpointId': 'string',
                      'vpcEndpointType': 'SERVICENETWORK'
                  },
                  'managedS3BackupAccess': {
                      'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
                      'ipv4Addresses': [
                          'string',
                      ]
                  },
                  'zeroEtlAccess': {
                      'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
                      'cidr': 'string'
                  },
                  's3Access': {
                      'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
                      'ipv4Addresses': [
                          'string',
                      ],
                      'domainName': 'string',
                      's3PolicyDocument': 'string'
                  },
                  'stsAccess': {
                      'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
                      'ipv4Addresses': [
                          'string',
                      ],
                      'domainName': 'string',
                      'stsPolicyDocument': 'string'
                  },
                  'kmsAccess': {
                      'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
                      'ipv4Addresses': [
                          'string',
                      ],
                      'domainName': 'string',
                      'kmsPolicyDocument': 'string'
                  },
                  'crossRegionS3RestoreSourcesAccess': [
                      {
                          'region': 'string',
                          'ipv4Addresses': [
                              'string',
                          ],
                          'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
                      },
                  ]
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **odbNetwork** *(dict) --* 

        The ODB network.

        
        

        - **odbNetworkId** *(string) --* 

          The unique identifier of the ODB network.

          
        

        - **displayName** *(string) --* 

          The user-friendly name of the ODB network.

          
        

        - **status** *(string) --* 

          The current status of the ODB network.

          
        

        - **statusReason** *(string) --* 

          Additional information about the current status of the ODB network.

          
        

        - **odbNetworkArn** *(string) --* 

          The Amazon Resource Name (ARN) of the ODB network.

          
        

        - **availabilityZone** *(string) --* 

          The Amazon Web Services Availability Zone (AZ) where the ODB network is located.

          
        

        - **availabilityZoneId** *(string) --* 

          The AZ ID of the AZ where the ODB network is located.

          
        

        - **clientSubnetCidr** *(string) --* 

          The CIDR range of the client subnet in the ODB network.

          
        

        - **backupSubnetCidr** *(string) --* 

          The CIDR range of the backup subnet in the ODB network.

          
        

        - **customDomainName** *(string) --* 

          The domain name for the resources in the ODB network.

          
        

        - **defaultDnsPrefix** *(string) --* 

          The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.

          
        

        - **peeredCidrs** *(list) --* 

          The list of CIDR ranges from the peered VPC that are allowed access to the ODB network.

          
          

          - *(string) --* 
      
        

        - **ociNetworkAnchorId** *(string) --* 

          The unique identifier of the OCI network anchor for the ODB network.

          
        

        - **ociNetworkAnchorUrl** *(string) --* 

          The URL of the OCI network anchor for the ODB network.

          
        

        - **ociResourceAnchorName** *(string) --* 

          The name of the OCI resource anchor that's associated with the ODB network.

          
        

        - **ociVcnId** *(string) --* 

          The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) that's associated with the ODB network.

          
        

        - **ociVcnUrl** *(string) --* 

          The URL for the VCN that's associated with the ODB network.

          
        

        - **ociDnsForwardingConfigs** *(list) --* 

          The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.

          
          

          - *(dict) --* 

            DNS configuration to forward DNS resolver endpoints to your OCI Private Zone.

            
            

            - **domainName** *(string) --* 

              Domain name to which DNS resolver forwards to.

              
            

            - **ociDnsListenerIp** *(string) --* 

              OCI DNS listener IP for custom DNS setup.

              
        
      
        

        - **createdAt** *(datetime) --* 

          The date and time when the ODB network was created.

          
        

        - **percentProgress** *(float) --* 

          The amount of progress made on the current operation on the ODB network, expressed as a percentage.

          
        

        - **managedServices** *(dict) --* 

          The managed services configuration for the ODB network.

          
          

          - **serviceNetworkArn** *(string) --* 

            The Amazon Resource Name (ARN) of the service network.

            
          

          - **resourceGatewayArn** *(string) --* 

            The Amazon Resource Name (ARN) of the resource gateway.

            
          

          - **managedServicesIpv4Cidrs** *(list) --* 

            The IPv4 CIDR blocks for the managed services.

            
            

            - *(string) --* 
        
          

          - **serviceNetworkEndpoint** *(dict) --* 

            The service network endpoint configuration.

            
            

            - **vpcEndpointId** *(string) --* 

              The identifier of the VPC endpoint.

              
            

            - **vpcEndpointType** *(string) --* 

              The type of the VPC endpoint.

              
        
          

          - **managedS3BackupAccess** *(dict) --* 

            The managed Amazon S3 backup access configuration.

            
            

            - **status** *(string) --* 

              The status of the managed Amazon S3 backup access.

              
            

            - **ipv4Addresses** *(list) --* 

              The IPv4 addresses for the managed Amazon S3 backup access.

              
              

              - *(string) --* 
          
        
          

          - **zeroEtlAccess** *(dict) --* 

            The Zero-ETL access configuration.

            
            

            - **status** *(string) --* 

              The status of the Zero-ETL access.

              
            

            - **cidr** *(string) --* 

              The CIDR block for the Zero-ETL access.

              
        
          

          - **s3Access** *(dict) --* 

            The Amazon S3 access configuration.

            
            

            - **status** *(string) --* 

              The status of the Amazon S3 access.

              
            

            - **ipv4Addresses** *(list) --* 

              The IPv4 addresses for the Amazon S3 access.

              
              

              - *(string) --* 
          
            

            - **domainName** *(string) --* 

              The domain name for the Amazon S3 access.

              
            

            - **s3PolicyDocument** *(string) --* 

              The endpoint policy for the Amazon S3 access.

              
        
          

          - **stsAccess** *(dict) --* 

            The Amazon Web Services Security Token Service (STS) access configuration.

            
            

            - **status** *(string) --* 

              The current status of the Amazon Web Services Security Token Service (STS) access configuration.

              
            

            - **ipv4Addresses** *(list) --* 

              The IPv4 addresses allowed for Amazon Web Services Security Token Service (STS) access.

              
              

              - *(string) --* 
          
            

            - **domainName** *(string) --* 

              The domain name for Amazon Web Services Security Token Service (STS) access configuration.

              
            

            - **stsPolicyDocument** *(string) --* 

              The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage.

              
        
          

          - **kmsAccess** *(dict) --* 

            The Amazon Web Services Key Management Service (KMS) access configuration.

            
            

            - **status** *(string) --* 

              The current status of the Amazon Web Services Key Management Service (KMS) access configuration.

              
            

            - **ipv4Addresses** *(list) --* 

              The IPv4 addresses allowed for Amazon Web Services Key Management Service (KMS) access.

              
              

              - *(string) --* 
          
            

            - **domainName** *(string) --* 

              The domain name for Amazon Web Services Key Management Service (KMS) access configuration.

              
            

            - **kmsPolicyDocument** *(string) --* 

              The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage.

              
        
          

          - **crossRegionS3RestoreSourcesAccess** *(list) --* 

            The access configuration for the cross-Region Amazon S3 database restore source.

            
            

            - *(dict) --* 

              The configuration access for the cross-Region Amazon S3 database restore source for the ODB network.

              
              

              - **region** *(string) --* 

                The Amazon Web Services Region for cross-Region Amazon S3 restore access.

                
              

              - **ipv4Addresses** *(list) --* 

                The IPv4 addresses allowed for cross-Region Amazon S3 restore access.

                
                

                - *(string) --* 
            
              

              - **status** *(string) --* 

                The current status of the cross-Region Amazon S3 restore access configuration.

                
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`odb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`odb.Client.exceptions.ValidationException`

  
  *   :py:class:`odb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`odb.Client.exceptions.InternalServerException`

  
  *   :py:class:`odb.Client.exceptions.ResourceNotFoundException`

  