create_alias `async` ¶

create_alias(
    organization_id: OrganizationId,
    entity_id: WorkMailIdentifier,
    alias: EmailAddress,
    *,
    config_overrides: Optional[AsyncWorkMailClientConfig] = None,
) -> CreateAliasResponse

Adds an alias to the set of a given member (user or group) of WorkMail.

Parameters:

organization_id (OrganizationId) –

The organization under which the member (user or group) exists.
entity_id (WorkMailIdentifier) –

The member (user or group) to which this alias is added.
alias (EmailAddress) –

The alias to add to the member set.

Raises:

EmailAddressInUseException –

The email address that you're trying to assign is already created for a different user, group, or resource.
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.
LimitExceededException –

The request exceeds the limit of the resource.
MailDomainNotFoundException –

The domain specified is not found in your organization.
MailDomainStateException –

After a domain has been added to the organization, it must be verified. The domain is not yet verified.
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 create_alias(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    entity_id: "capo_workmail.types.work_mail_identifier.WorkMailIdentifier",
    alias: "capo_workmail.types.email_address.EmailAddress",
    *,
    config_overrides: Optional[AsyncWorkMailClientConfig] = None,
) -> "capo_workmail.types.create_alias_response.CreateAliasResponse":
    """<p>Adds an alias to the set of a given member (user or group) of WorkMail.</p>

    Args:
        organization_id: <p>The organization under which the member (user or group) exists.</p>
        entity_id: <p>The member (user or group) to which this alias is added.</p>
        alias: <p>The alias to add to the member set.</p>

    Raises:
        capo_workmail.errors.email_address_in_use_exception.EmailAddressInUseException: <p>The email address that you're trying to assign is already created for a different user, group, or resource.</p>
        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.limit_exceeded_exception.LimitExceededException: <p>The request exceeds the limit of the resource.</p>
        capo_workmail.errors.mail_domain_not_found_exception.MailDomainNotFoundException: <p>The domain specified is not found in your organization.</p>
        capo_workmail.errors.mail_domain_state_exception.MailDomainStateException: <p>After a domain has been added to the organization, it must be verified. The domain is not yet verified.</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.create_alias_request.CreateAliasRequest]",
    ) -> AsyncOperationResponse[
        "capo_workmail.types.create_alias_response.CreateAliasResponse"
    ]:
        import capo_workmail._operations.work_mail_service.create_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateAlias")
    )
    input_: capo_workmail.types.create_alias_request.CreateAliasRequest = {
        "organization_id": organization_id,
        "entity_id": entity_id,
        "alias": alias,
    }

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

create_alias async ¶

create_alias `async` ¶