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

*******************
describe_role_alias
*******************



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

  

  Describes a role alias.

   

  Requires permission to access the `DescribeRoleAlias <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/DescribeRoleAlias>`_  


  **Request Syntax**
  ::

    response = client.describe_role_alias(
        roleAlias='string'
    )
    
  :type roleAlias: string
  :param roleAlias: **[REQUIRED]** 

    The role alias to describe.

    

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

    
    ::

      {
          'roleAliasDescription': {
              'roleAlias': 'string',
              'roleAliasArn': 'string',
              'roleArn': 'string',
              'owner': 'string',
              'credentialDurationSeconds': 123,
              'creationDate': datetime(2015, 1, 1),
              'lastModifiedDate': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **roleAliasDescription** *(dict) --* 

        The role alias description.

        
        

        - **roleAlias** *(string) --* 

          The role alias.

          
        

        - **roleAliasArn** *(string) --* 

          The ARN of the role alias.

          
        

        - **roleArn** *(string) --* 

          The role ARN.

          
        

        - **owner** *(string) --* 

          The role alias owner.

          
        

        - **credentialDurationSeconds** *(integer) --* 

          The number of seconds for which the credential is valid.

          
        

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

          The UNIX timestamp of when the role alias was created.

          
        

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

          The UNIX timestamp of when the role alias was last modified.

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

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

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

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

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

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

  