Skip to content

add_resource_permissions async

add_resource_permissions(
    resource_id: ResourceIdType,
    principals: SharePrincipalList,
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    notification_options: Optional[NotificationOptions] = None,
) -> AddResourcePermissionsResponse

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Parameters:

  • authentication_token (Optional[AuthenticationHeaderType], default: None ) –

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • resource_id (ResourceIdType) –

    The ID of the resource.

  • principals (SharePrincipalList) –

    The users, groups, or organization being granted permission.

  • notification_options (Optional[NotificationOptions], default: None ) –

    The notification options.

Raises:

Source code in docs_src/capo_workdocs/_services/async_work_docs.py
async def add_resource_permissions(
    self,
    resource_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    principals: "capo_workdocs.types.share_principal_list.SharePrincipalList",
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    notification_options: Optional[
        "capo_workdocs.types.notification_options.NotificationOptions"
    ] = None,
) -> "capo_workdocs.types.add_resource_permissions_response.AddResourcePermissionsResponse":
    """<p>Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.</p>

    Args:
        authentication_token: <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
        resource_id: <p>The ID of the resource.</p>
        principals: <p>The users, groups, or organization being granted permission.</p>
        notification_options: <p>The notification options.</p>

    Raises:
        capo_workdocs.errors.failed_dependency_exception.FailedDependencyException: <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
        capo_workdocs.errors.prohibited_state_exception.ProhibitedStateException: <p>The specified document version is not in the INITIALIZED state.</p>
        capo_workdocs.errors.service_unavailable_exception.ServiceUnavailableException: <p>One or more of the dependencies is unavailable.</p>
        capo_workdocs.errors.unauthorized_operation_exception.UnauthorizedOperationException: <p>The operation is not permitted.</p>
        capo_workdocs.errors.unauthorized_resource_access_exception.UnauthorizedResourceAccessException: <p>The caller does not have access to perform the action on the resource.</p>
        capo_workdocs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workdocs.types.add_resource_permissions_request.AddResourcePermissionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_workdocs.types.add_resource_permissions_response.AddResourcePermissionsResponse"
    ]:
        import capo_workdocs._operations.aws_gorilla_boy_service.add_resource_permissions

        (
            output,
            http_response,
        ) = await capo_workdocs._operations.aws_gorilla_boy_service.add_resource_permissions.async_add_resource_permissions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workdocs.types.add_resource_permissions_request.AddResourcePermissionsRequest",
    ) -> dict[str, Any]:
        import capo_workdocs.types.add_resource_permissions_request

        return (
            capo_workdocs.types.add_resource_permissions_request.redact_sensitive(
                input_
            )
        )

    def _redact_output(
        output: "capo_workdocs.types.add_resource_permissions_response.AddResourcePermissionsResponse",
    ) -> dict[str, Any]:
        import capo_workdocs.types.add_resource_permissions_response

        return (
            capo_workdocs.types.add_resource_permissions_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "AddResourcePermissions",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_workdocs.types.add_resource_permissions_request.AddResourcePermissionsRequest = {
        "resource_id": resource_id,
        "principals": principals,
    }
    if authentication_token is not None:
        input_["authentication_token"] = authentication_token
    if notification_options is not None:
        input_["notification_options"] = notification_options

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