create_impersonation_role ¶

create_impersonation_role(
    organization_id: OrganizationId,
    name: ImpersonationRoleName,
    type: ImpersonationRoleType,
    rules: ImpersonationRuleList,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    client_token: Optional[IdempotencyClientToken] = None,
    description: Optional[ImpersonationRoleDescription] = None,
) -> CreateImpersonationRoleResponse

Creates an impersonation role for the given WorkMail organization.

Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

Parameters:

client_token (Optional[IdempotencyClientToken], default: None ) –

The idempotency token for the client request.
organization_id (OrganizationId) –

The WorkMail organization to create the new impersonation role within.
name (ImpersonationRoleName) –

The name of the new impersonation role.
type (ImpersonationRoleType) –

The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.
description (Optional[ImpersonationRoleDescription], default: None ) –

The description of the new impersonation role.
rules (ImpersonationRuleList) –

The list of rules for the impersonation role.

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.
LimitExceededException –

The request exceeds the limit of the resource.
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/work_mail.py

def create_impersonation_role(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    name: "capo_workmail.types.impersonation_role_name.ImpersonationRoleName",
    type: "capo_workmail.types.impersonation_role_type.ImpersonationRoleType",
    rules: "capo_workmail.types.impersonation_rule_list.ImpersonationRuleList",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    client_token: Optional[
        "capo_workmail.types.idempotency_client_token.IdempotencyClientToken"
    ] = None,
    description: Optional[
        "capo_workmail.types.impersonation_role_description.ImpersonationRoleDescription"
    ] = None,
) -> "capo_workmail.types.create_impersonation_role_response.CreateImpersonationRoleResponse":
    """<p>Creates an impersonation role for the given WorkMail organization.</p> <p> <i>Idempotency</i> ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.</p>

    Args:
        client_token: <p>The idempotency token for the client request.</p>
        organization_id: <p>The WorkMail organization to create the new impersonation role within.</p>
        name: <p>The name of the new impersonation role.</p>
        type: <p>The impersonation role's type. The available impersonation role types are <code>READ_ONLY</code> or <code>FULL_ACCESS</code>.</p>
        description: <p>The description of the new impersonation role.</p>
        rules: <p>The list of rules for the impersonation role.</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.limit_exceeded_exception.LimitExceededException: <p>The request exceeds the limit of the resource.</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.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.create_impersonation_role_request.CreateImpersonationRoleRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.create_impersonation_role_response.CreateImpersonationRoleResponse"
    ]:
        import capo_workmail._operations.work_mail_service.create_impersonation_role

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateImpersonationRole")
    )
    input_: capo_workmail.types.create_impersonation_role_request.CreateImpersonationRoleRequest = {
        "organization_id": organization_id,
        "name": name,
        "type": type,
        "rules": rules,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if description is not None:
        input_["description"] = description

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