Skip to content

create_availability_configuration

create_availability_configuration(
    organization_id: OrganizationId,
    domain_name: DomainName,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    client_token: Optional[IdempotencyClientToken] = None,
    ews_provider: Optional[EwsAvailabilityProvider] = None,
    lambda_provider: Optional[LambdaAvailabilityProvider] = None,
) -> CreateAvailabilityConfigurationResponse

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Parameters:

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

    An idempotent token that ensures that an API request is executed only once.

  • organization_id (OrganizationId) –

    The WorkMail organization for which the AvailabilityConfiguration will be created.

  • domain_name (DomainName) –

    The domain to which the provider applies.

  • ews_provider (Optional[EwsAvailabilityProvider], default: None ) –

    Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.

  • lambda_provider (Optional[LambdaAvailabilityProvider], default: None ) –

    Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.

Raises:

Source code in docs_src/capo_workmail/_services/work_mail.py
def create_availability_configuration(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    domain_name: "capo_workmail.types.domain_name.DomainName",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    client_token: Optional[
        "capo_workmail.types.idempotency_client_token.IdempotencyClientToken"
    ] = None,
    ews_provider: Optional[
        "capo_workmail.types.ews_availability_provider.EwsAvailabilityProvider"
    ] = None,
    lambda_provider: Optional[
        "capo_workmail.types.lambda_availability_provider.LambdaAvailabilityProvider"
    ] = None,
) -> "capo_workmail.types.create_availability_configuration_response.CreateAvailabilityConfigurationResponse":
    """<p>Creates an <code>AvailabilityConfiguration</code> for the given WorkMail organization and domain.</p>

    Args:
        client_token: <p>An idempotent token that ensures that an API request is executed only once.</p>
        organization_id: <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be created.</p>
        domain_name: <p>The domain to which the provider applies.</p>
        ews_provider: <p>Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>.</p>
        lambda_provider: <p>Lambda availability provider definition. The request must contain exactly one provider definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>.</p>

    Raises:
        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.name_availability_exception.NameAvailabilityException: <p>The user, group, or resource name isn't unique in WorkMail.</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_availability_configuration_request.CreateAvailabilityConfigurationRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.create_availability_configuration_response.CreateAvailabilityConfigurationResponse"
    ]:
        import capo_workmail._operations.work_mail_service.create_availability_configuration

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

    def _redact_input(
        input_: "capo_workmail.types.create_availability_configuration_request.CreateAvailabilityConfigurationRequest",
    ) -> dict[str, Any]:
        import capo_workmail.types.create_availability_configuration_request

        return capo_workmail.types.create_availability_configuration_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateAvailabilityConfiguration", redact_input=_redact_input
        ),
    )
    input_: capo_workmail.types.create_availability_configuration_request.CreateAvailabilityConfigurationRequest = {
        "organization_id": organization_id,
        "domain_name": domain_name,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if ews_provider is not None:
        input_["ews_provider"] = ews_provider
    if lambda_provider is not None:
        input_["lambda_provider"] = lambda_provider

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