WorkMail / Client / list_availability_configurations

list_availability_configurations#

WorkMail.Client.list_availability_configurations(**kwargs)#

List all the AvailabilityConfiguration’s for the given WorkMail organization.

See also: AWS API Documentation

Request Syntax

response = client.list_availability_configurations(
    OrganizationId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The WorkMail organization for which the AvailabilityConfiguration’s will be listed.

  • MaxResults (integer) – The maximum number of results to return in a single call.

  • NextToken (string) – The token to use to retrieve the next page of results. The first call does not require a token.

Return type:

dict

Returns:

Response Syntax

{
    'AvailabilityConfigurations': [
        {
            'DomainName': 'string',
            'ProviderType': 'EWS'|'LAMBDA',
            'EwsProvider': {
                'EwsEndpoint': 'string',
                'EwsUsername': 'string'
            },
            'LambdaProvider': {
                'LambdaArn': 'string'
            },
            'DateCreated': datetime(2015, 1, 1),
            'DateModified': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AvailabilityConfigurations (list) –

      The list of AvailabilityConfiguration’s that exist for the specified WorkMail organization.

      • (dict) –

        List all the AvailabilityConfiguration’s for the given WorkMail organization.

        • DomainName (string) –

          Displays the domain to which the provider applies.

        • ProviderType (string) –

          Displays the provider type that applies to this domain.

        • EwsProvider (dict) –

          If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required.

          • EwsEndpoint (string) –

            The endpoint of the remote EWS server.

          • EwsUsername (string) –

            The username used to authenticate the remote EWS server.

        • LambdaProvider (dict) –

          If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required.

          • LambdaArn (string) –

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

        • DateCreated (datetime) –

          The date and time at which the availability configuration was created.

        • DateModified (datetime) –

          The date and time at which the availability configuration was last modified.

    • NextToken (string) –

      The token to use to retrieve the next page of results. The value is null when there are no further results to return.

Exceptions

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.InvalidParameterException