:doc:`EC2 <../../ec2>` / Client / describe_identity_id_format

***************************
describe_identity_id_format
***************************



.. py:method:: EC2.Client.describe_identity_id_format(**kwargs)

  

  Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see `Resource IDs <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html>`__ in the *Amazon Elastic Compute Cloud User Guide*.

   

  The following resource types support longer IDs: ``bundle`` | ``conversion-task`` | ``customer-gateway`` | ``dhcp-options`` | ``elastic-ip-allocation`` | ``elastic-ip-association`` | ``export-task`` | ``flow-log`` | ``image`` | ``import-task`` | ``instance`` | ``internet-gateway`` | ``network-acl`` | ``network-acl-association`` | ``network-interface`` | ``network-interface-attachment`` | ``prefix-list`` | ``reservation`` | ``route-table`` | ``route-table-association`` | ``security-group`` | ``snapshot`` | ``subnet`` | ``subnet-cidr-block-association`` | ``volume`` | ``vpc`` | ``vpc-cidr-block-association`` | ``vpc-endpoint`` | ``vpc-peering-connection`` | ``vpn-connection`` | ``vpn-gateway``.

   

  These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIdentityIdFormat>`_  


  **Request Syntax**
  ::

    response = client.describe_identity_id_format(
        Resource='string',
        PrincipalArn='string'
    )
    
  :type Resource: string
  :param Resource: 

    The type of resource: ``bundle`` | ``conversion-task`` | ``customer-gateway`` | ``dhcp-options`` | ``elastic-ip-allocation`` | ``elastic-ip-association`` | ``export-task`` | ``flow-log`` | ``image`` | ``import-task`` | ``instance`` | ``internet-gateway`` | ``network-acl`` | ``network-acl-association`` | ``network-interface`` | ``network-interface-attachment`` | ``prefix-list`` | ``reservation`` | ``route-table`` | ``route-table-association`` | ``security-group`` | ``snapshot`` | ``subnet`` | ``subnet-cidr-block-association`` | ``volume`` | ``vpc`` | ``vpc-cidr-block-association`` | ``vpc-endpoint`` | ``vpc-peering-connection`` | ``vpn-connection`` | ``vpn-gateway``

    

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

    The ARN of the principal, which can be an IAM role, IAM user, or the root user.

    

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

    
    ::

      {
          'Statuses': [
              {
                  'Deadline': datetime(2015, 1, 1),
                  'Resource': 'string',
                  'UseLongIds': True|False
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Statuses** *(list) --* 

        Information about the ID format for the resources.

        
        

        - *(dict) --* 

          Describes the ID format for a resource.

          
          

          - **Deadline** *(datetime) --* 

            The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

            
          

          - **Resource** *(string) --* 

            The type of resource.

            
          

          - **UseLongIds** *(boolean) --* 

            Indicates whether longer IDs (17-character IDs) are enabled for the resource.

            
      
    
  