WorkMail / Paginator / ListAvailabilityConfigurations


class WorkMail.Paginator.ListAvailabilityConfigurations#
paginator = client.get_paginator('list_availability_configurations')

Creates an iterator that will paginate through responses from WorkMail.Client.list_availability_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • OrganizationId (string) –


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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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)


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.