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

*****************
describe_resource
*****************



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

  

  Returns the data available for the resource.

  

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


  **Request Syntax**
  ::

    response = client.describe_resource(
        OrganizationId='string',
        ResourceId='string'
    )
    
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

    The identifier associated with the organization for which the resource is described.

    

  
  :type ResourceId: string
  :param ResourceId: **[REQUIRED]** 

    The identifier of the resource to be described.

     

    The identifier can accept *ResourceId*, *Resourcename*, or *email*. The following identity formats are available:

     

    
    * Resource ID: r-0123456789a0123456789b0123456789
     
    * Email address: resource@domain.tld
     
    * Resource name: resource
    

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ResourceId': 'string',
          'Email': 'string',
          'Name': 'string',
          'Type': 'ROOM'|'EQUIPMENT',
          'BookingOptions': {
              'AutoAcceptRequests': True|False,
              'AutoDeclineRecurringRequests': True|False,
              'AutoDeclineConflictingRequests': True|False
          },
          'State': 'ENABLED'|'DISABLED'|'DELETED',
          'EnabledDate': datetime(2015, 1, 1),
          'DisabledDate': datetime(2015, 1, 1),
          'Description': 'string',
          'HiddenFromGlobalAddressList': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ResourceId** *(string) --* 

        The identifier of the described resource.

        
      

      - **Email** *(string) --* 

        The email of the described resource.

        
      

      - **Name** *(string) --* 

        The name of the described resource.

        
      

      - **Type** *(string) --* 

        The type of the described resource.

        
      

      - **BookingOptions** *(dict) --* 

        The booking options for the described resource.

        
        

        - **AutoAcceptRequests** *(boolean) --* 

          The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.

          
        

        - **AutoDeclineRecurringRequests** *(boolean) --* 

          The resource's ability to automatically decline any recurring requests.

          
        

        - **AutoDeclineConflictingRequests** *(boolean) --* 

          The resource's ability to automatically decline any conflicting requests.

          
    
      

      - **State** *(string) --* 

        The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.

        
      

      - **EnabledDate** *(datetime) --* 

        The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

        
      

      - **DisabledDate** *(datetime) --* 

        The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

        
      

      - **Description** *(string) --* 

        Description of the resource.

        
      

      - **HiddenFromGlobalAddressList** *(boolean) --* 

        If enabled, the resource is hidden from the global address list.

        
  
  **Exceptions**
  
  *   :py:class:`WorkMail.Client.exceptions.EntityNotFoundException`

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

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

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

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

  