OpenSearchService / Client / update_package_scope

update_package_scope¶

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.

Request Syntax

response = client.update_package_scope(
    PackageID='string',
    Operation='ADD'|'OVERRIDE'|'REMOVE',
    PackageUserList=[
        'string',
    ]
)

Parameters:

PackageID (string) –
[REQUIRED]

ID of the package whose scope is being updated.
Operation (string) –
[REQUIRED]

The operation to perform on the package scope (e.g., add/remove/override users).
PackageUserList (list) –
[REQUIRED]

List of users to be added or removed from the package scope.
- (string) –

Return type:

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

OpenSearchService.Client.exceptions.BaseException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.DisabledOperationException