:doc:`WorkMail <../../workmail>` / Client / list_availability_configurations

********************************
list_availability_configurations
********************************



.. py:method:: WorkMail.Client.list_availability_configurations(**kwargs)

  

  List all the ``AvailabilityConfiguration``'s for the given WorkMail organization.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAvailabilityConfigurations>`_  


  **Request Syntax**
  ::

    response = client.list_availability_configurations(
        OrganizationId='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next page of results. The first call does not require a token.

    

  
  
  :rtype: 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**
  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.InvalidParameterException`

  