create_availability_configuration

create_availability_configuration(**kwargs)

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

See also: AWS API Documentation

Request Syntax

response = client.create_availability_configuration(
    ClientToken='string',
    OrganizationId='string',
    DomainName='string',
    EwsProvider={
        'EwsEndpoint': 'string',
        'EwsUsername': 'string',
        'EwsPassword': 'string'
    },
    LambdaProvider={
        'LambdaArn': 'string'
    }
)

Parameters

• ClientToken (string) --

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

  This field is autopopulated if not provided.

• OrganizationId (string) --

  [REQUIRED]

  The WorkMail organization for which the AvailabilityConfiguration will be created.

• DomainName (string) --

  [REQUIRED]

  The domain to which the provider applies.

• EwsProvider (dict) --

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

  • EwsEndpoint (string) -- [REQUIRED]

    The endpoint of the remote EWS server.

  • EwsUsername (string) -- [REQUIRED]

    The username used to authenticate the remote EWS server.

  • EwsPassword (string) -- [REQUIRED]

    The password used to authenticate the remote EWS server.

• LambdaProvider (dict) --

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

  • LambdaArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException
• WorkMail.Client.exceptions.NameAvailabilityException
• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.LimitExceededException