:doc:`OpenSearchService <../../opensearch>` / Client / update_package_scope

********************
update_package_scope
********************



.. py:method:: OpenSearchService.Client.update_package_scope(**kwargs)

  

  Updates the scope of a package. Scope of the package defines users who can view and associate a package.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackageScope>`_  


  **Request Syntax**
  ::

    response = client.update_package_scope(
        PackageID='string',
        Operation='ADD'|'OVERRIDE'|'REMOVE',
        PackageUserList=[
            'string',
        ]
    )
    
  :type PackageID: string
  :param PackageID: **[REQUIRED]** 

    ID of the package whose scope is being updated.

    

  
  :type Operation: string
  :param Operation: **[REQUIRED]** 

    The operation to perform on the package scope (e.g., add/remove/override users).

    

  
  :type PackageUserList: list
  :param PackageUserList: **[REQUIRED]** 

    List of users to be added or removed from the package scope.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'PackageID': 'string',
          'Operation': 'ADD'|'OVERRIDE'|'REMOVE',
          'PackageUserList': [
              'string',
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PackageID** *(string) --* 

        ID of the package whose scope was updated.

        
      

      - **Operation** *(string) --* 

        The operation that was performed on the package scope.

        
      

      - **PackageUserList** *(list) --* 

        List of users who have access to the package after the scope update.

        
        

        - *(string) --* 
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchService.Client.exceptions.BaseException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.InternalException`

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

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

  
  *   :py:class:`OpenSearchService.Client.exceptions.DisabledOperationException`

  