describe_entity `async` ¶

describe_entity(
    organization_id: OrganizationId,
    email: EmailAddress,
    *,
    config_overrides: Optional[AsyncWorkMailClientConfig] = None,
) -> DescribeEntityResponse

Returns basic details about an entity in WorkMail.

Parameters:

organization_id (OrganizationId) –

The identifier for the organization under which the entity exists.
email (EmailAddress) –

The email under which the entity exists.

Raises:

EntityNotFoundException –

The identifier supplied for the user, group, or resource does not exist in your organization.
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.
UnknownServiceError –

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

Source code in docs_src/capo_workmail/_services/async_work_mail.py

async def describe_entity(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    email: "capo_workmail.types.email_address.EmailAddress",
    *,
    config_overrides: Optional[AsyncWorkMailClientConfig] = None,
) -> "capo_workmail.types.describe_entity_response.DescribeEntityResponse":
    """<p>Returns basic details about an entity in WorkMail. </p>

    Args:
        organization_id: <p>The identifier for the organization under which the entity exists.</p>
        email: <p>The email under which the entity exists.</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.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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workmail.types.describe_entity_request.DescribeEntityRequest]",
    ) -> AsyncOperationResponse[
        "capo_workmail.types.describe_entity_response.DescribeEntityResponse"
    ]:
        import capo_workmail._operations.work_mail_service.describe_entity

        (
            output,
            http_response,
        ) = await capo_workmail._operations.work_mail_service.describe_entity.async_describe_entity(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEntity")
    )
    input_: capo_workmail.types.describe_entity_request.DescribeEntityRequest = {
        "organization_id": organization_id,
        "email": email,
    }

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

describe_entity async ¶

describe_entity `async` ¶