:doc:`EC2 <../../ec2>` / Paginator / DescribePrincipalIdFormat

*************************
DescribePrincipalIdFormat
*************************



.. py:class:: EC2.Paginator.DescribePrincipalIdFormat

  ::

    
    paginator = client.get_paginator('describe_principal_id_format')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.describe_principal_id_format`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          Resources=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DryRun: boolean
    :param DryRun: 

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

      

    
    :type Resources: list
    :param Resources: 

      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``

      

    
      - *(string) --* 

      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

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

      

      - *(dict) --* 
        

        - **Principals** *(list) --* 

          Information about the ID format settings for the ARN.

          
          

          - *(dict) --* 

            PrincipalIdFormat description

            
            

            - **Arn** *(string) --* 

              PrincipalIdFormatARN description

              
            

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

              PrincipalIdFormatStatuses description

              
              

              - *(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.

                  
            
          
        
      
    