Skip to content

list_resource_delegates

list_resource_delegates(
    organization_id: OrganizationId,
    resource_id: EntityIdentifier,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListResourceDelegatesResponse

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

Parameters:

  • organization_id (OrganizationId) –

    The identifier for the organization that contains the resource for which delegates are listed.

  • resource_id (EntityIdentifier) –

    The identifier for the resource whose delegates are listed.

    The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Email address: [email protected]

    • Resource name: resource

  • next_token (Optional[NextToken], default: None ) –

    The token used to paginate through the delegates associated with a resource.

  • max_results (Optional[MaxResults], default: None ) –

    The number of maximum results in a page.

Raises:

  • EntityNotFoundException –

    The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException –

    You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException –

    One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException –

    An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException –

    The organization must have a valid state to perform certain operations on the organization or its members.

  • UnsupportedOperationException –

    You can't perform a write operation against a read-only directory.

  • UnknownServiceError –

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

Source code in docs_src/capo_workmail/_services/work_mail.py
def list_resource_delegates(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    resource_id: "capo_workmail.types.entity_identifier.EntityIdentifier",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    next_token: Optional["capo_workmail.types.next_token.NextToken"] = None,
    max_results: Optional["capo_workmail.types.max_results.MaxResults"] = None,
) -> "capo_workmail.types.list_resource_delegates_response.ListResourceDelegatesResponse":
    """<p>Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.</p>

    Args:
        organization_id: <p>The identifier for the organization that contains the resource for which delegates are listed.</p>
        resource_id: <p>The identifier for the resource whose delegates are listed.</p> <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p> <ul> <li> <p>Resource ID: r-0123456789a0123456789b0123456789</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>Resource name: resource</p> </li> </ul>
        next_token: <p>The token used to paginate through the delegates associated with a resource.</p>
        max_results: <p>The number of maximum results in a page.</p>

    Raises:
        capo_workmail.errors.entity_not_found_exception.EntityNotFoundException: <p>The identifier supplied for the user, group, or resource does not exist in your organization.</p>
        capo_workmail.errors.entity_state_exception.EntityStateException: <p>You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.</p>
        capo_workmail.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the input parameters don't match the service's restrictions.</p>
        capo_workmail.errors.organization_not_found_exception.OrganizationNotFoundException: <p>An operation received a valid organization identifier that either doesn't belong or exist in the system.</p>
        capo_workmail.errors.organization_state_exception.OrganizationStateException: <p>The organization must have a valid state to perform certain operations on the organization or its members.</p>
        capo_workmail.errors.unsupported_operation_exception.UnsupportedOperationException: <p>You can't perform a write operation against a read-only directory.</p>
        capo_workmail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.list_resource_delegates_request.ListResourceDelegatesRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.list_resource_delegates_response.ListResourceDelegatesResponse"
    ]:
        import capo_workmail._operations.work_mail_service.list_resource_delegates

        output, http_response = (
            capo_workmail._operations.work_mail_service.list_resource_delegates.list_resource_delegates(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListResourceDelegates")
    )
    input_: capo_workmail.types.list_resource_delegates_request.ListResourceDelegatesRequest = {
        "organization_id": organization_id,
        "resource_id": resource_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output