update_package_scope `async` ¶

update_package_scope(
    package_id: PackageID,
    operation: PackageScopeOperationEnum,
    package_user_list: PackageUserList,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
) -> UpdatePackageScopeResponse

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

Parameters:

package_id (PackageID) –

ID of the package whose scope is being updated.
operation (PackageScopeOperationEnum) –

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

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

Raises:

BaseException –

An error occurred while processing the request.
DisabledOperationException –

An error occured because the client wanted to access an unsupported operation.
InternalException –

Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException –

An exception for accessing or deleting a resource that doesn't exist.
ValidationException –

An exception for accessing or deleting a resource that doesn't exist.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_opensearch/_services/async_open_search.py

async def update_package_scope(
    self,
    package_id: "capo_opensearch.types.package_id.PackageID",
    operation: "capo_opensearch.types.package_scope_operation_enum.PackageScopeOperationEnum",
    package_user_list: "capo_opensearch.types.package_user_list.PackageUserList",
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
) -> (
    "capo_opensearch.types.update_package_scope_response.UpdatePackageScopeResponse"
):
    """<p>Updates the scope of a package. Scope of the package defines users who can view and associate a package.</p>

    Args:
        package_id: <p>ID of the package whose scope is being updated.</p>
        operation: <p> The operation to perform on the package scope (e.g., add/remove/override users).</p>
        package_user_list: <p> List of users to be added or removed from the package scope.</p>

    Raises:
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearch.types.update_package_scope_request.UpdatePackageScopeRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.update_package_scope_response.UpdatePackageScopeResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.update_package_scope

        (
            output,
            http_response,
        ) = await capo_opensearch._operations.amazon_open_search_service.update_package_scope.async_update_package_scope(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePackageScope")
    )
    input_: capo_opensearch.types.update_package_scope_request.UpdatePackageScopeRequest = {
        "package_id": package_id,
        "operation": operation,
        "package_user_list": package_user_list,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_package_scope async ¶

update_package_scope `async` ¶