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

******************
update_odb_network
******************



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

  

  Updates properties of a specified ODB network.

  

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


  **Request Syntax**
  ::

    response = client.update_odb_network(
        odbNetworkId='string',
        displayName='string',
        peeredCidrsToBeAdded=[
            'string',
        ],
        peeredCidrsToBeRemoved=[
            'string',
        ],
        s3Access='ENABLED'|'DISABLED',
        zeroEtlAccess='ENABLED'|'DISABLED',
        stsAccess='ENABLED'|'DISABLED',
        kmsAccess='ENABLED'|'DISABLED',
        s3PolicyDocument='string',
        stsPolicyDocument='string',
        kmsPolicyDocument='string',
        crossRegionS3RestoreSourcesToEnable=[
            'string',
        ],
        crossRegionS3RestoreSourcesToDisable=[
            'string',
        ]
    )
    
  :type odbNetworkId: string
  :param odbNetworkId: **[REQUIRED]** 

    The unique identifier of the ODB network to update.

    

  
  :type displayName: string
  :param displayName: 

    The new user-friendly name of the ODB network.

    

  
  :type peeredCidrsToBeAdded: list
  :param peeredCidrsToBeAdded: 

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

    

  
    - *(string) --* 

    

  :type peeredCidrsToBeRemoved: list
  :param peeredCidrsToBeRemoved: 

    The list of CIDR ranges from the peered VPC to remove from the ODB network.

    

  
    - *(string) --* 

    

  :type s3Access: string
  :param s3Access: 

    Specifies the updated configuration for Amazon S3 access from the ODB network.

    

  
  :type zeroEtlAccess: string
  :param zeroEtlAccess: 

    Specifies the updated configuration for Zero-ETL access from the ODB network.

    

  
  :type stsAccess: string
  :param stsAccess: 

    The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

    

  
  :type kmsAccess: string
  :param kmsAccess: 

    The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

    

  
  :type s3PolicyDocument: string
  :param s3PolicyDocument: 

    Specifies the updated endpoint policy for Amazon S3 access from the ODB network.

    

  
  :type stsPolicyDocument: string
  :param stsPolicyDocument: 

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

    

  
  :type kmsPolicyDocument: string
  :param kmsPolicyDocument: 

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

    

  
  :type crossRegionS3RestoreSourcesToEnable: list
  :param crossRegionS3RestoreSourcesToEnable: 

    The cross-Region Amazon S3 restore sources to enable for the ODB network.

    

  
    - *(string) --* 

    

  :type crossRegionS3RestoreSourcesToDisable: list
  :param crossRegionS3RestoreSourcesToDisable: 

    The cross-Region Amazon S3 restore sources to disable for the ODB network.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'displayName': 'string',
          'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
          'statusReason': 'string',
          'odbNetworkId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **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 status of the ODB network.

        
      

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

        The unique identifier of the ODB network.

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

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

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

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

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

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

  