:doc:`IoT <../../iot>` / Client / describe_dimension

******************
describe_dimension
******************



.. py:method:: IoT.Client.describe_dimension(**kwargs)

  

  Provides details about a dimension that is defined in your Amazon Web Services accounts.

   

  Requires permission to access the `DescribeDimension <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/DescribeDimension>`_  


  **Request Syntax**
  ::

    response = client.describe_dimension(
        name='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The unique identifier for the dimension.

    

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

    
    ::

      {
          'name': 'string',
          'arn': 'string',
          'type': 'TOPIC_FILTER',
          'stringValues': [
              'string',
          ],
          'creationDate': datetime(2015, 1, 1),
          'lastModifiedDate': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **name** *(string) --* 

        The unique identifier for the dimension.

        
      

      - **arn** *(string) --* 

        The Amazon Resource Name (ARN) for the dimension.

        
      

      - **type** *(string) --* 

        The type of the dimension.

        
      

      - **stringValues** *(list) --* 

        The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

        
        

        - *(string) --* 
    
      

      - **creationDate** *(datetime) --* 

        The date the dimension was created.

        
      

      - **lastModifiedDate** *(datetime) --* 

        The date the dimension was last modified.

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  