:doc:`IAMRolesAnywhere <../../rolesanywhere>` / Paginator / ListProfiles

************
ListProfiles
************



.. py:class:: IAMRolesAnywhere.Paginator.ListProfiles

  ::

    
    paginator = client.get_paginator('list_profiles')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IAMRolesAnywhere.Client.list_profiles`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/ListProfiles>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          pageSize=123,
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type pageSize: integer
    :param pageSize: 

      The number of resources in the paginated list.

      

    
    :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.

        

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

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

        

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

      
      ::

        {
            'profiles': [
                {
                    'profileId': 'string',
                    'profileArn': 'string',
                    'name': 'string',
                    'requireInstanceProperties': True|False,
                    'enabled': True|False,
                    'createdBy': 'string',
                    'sessionPolicy': 'string',
                    'roleArns': [
                        'string',
                    ],
                    'managedPolicyArns': [
                        'string',
                    ],
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'durationSeconds': 123,
                    'acceptRoleSessionName': True|False,
                    'attributeMappings': [
                        {
                            'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                            'mappingRules': [
                                {
                                    'specifier': 'string'
                                },
                            ]
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **profiles** *(list) --* 

          A list of profiles.

          
          

          - *(dict) --* 

            The state of the profile after a read or write operation.

            
            

            - **profileId** *(string) --* 

              The unique identifier of the profile.

              
            

            - **profileArn** *(string) --* 

              The ARN of the profile.

              
            

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

              The name of the profile.

              
            

            - **requireInstanceProperties** *(boolean) --* 

              Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

              
            

            - **enabled** *(boolean) --* 

              Indicates whether the profile is enabled.

              
            

            - **createdBy** *(string) --* 

              The Amazon Web Services account that created the profile.

              
            

            - **sessionPolicy** *(string) --* 

              A session policy that applies to the trust boundary of the vended session credentials.

              
            

            - **roleArns** *(list) --* 

              A list of IAM roles that this profile can assume in a temporary credential request.

              
              

              - *(string) --* 
          
            

            - **managedPolicyArns** *(list) --* 

              A list of managed policy ARNs that apply to the vended session credentials.

              
              

              - *(string) --* 
          
            

            - **createdAt** *(datetime) --* 

              The ISO-8601 timestamp when the profile was created.

              
            

            - **updatedAt** *(datetime) --* 

              The ISO-8601 timestamp when the profile was last updated.

              
            

            - **durationSeconds** *(integer) --* 

              Used to determine how long sessions vended using this profile are valid for. See the ``Expiration`` section of the `CreateSession API documentation <https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object>`__ page for more details. In requests, if this value is not provided, the default value will be 3600.

              
            

            - **acceptRoleSessionName** *(boolean) --* 

              Used to determine if a custom role session name will be accepted in a temporary credential request.

              
            

            - **attributeMappings** *(list) --* 

              A mapping applied to the authenticating end-entity certificate.

              
              

              - *(dict) --* 

                A mapping applied to the authenticating end-entity certificate.

                
                

                - **certificateField** *(string) --* 

                  Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

                  
                

                - **mappingRules** *(list) --* 

                  A list of mapping entries for every supported specifier or sub-field.

                  
                  

                  - *(dict) --* 

                    A single mapping entry for each supported specifier or sub-field.

                    
                    

                    - **specifier** *(string) --* 

                      Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

                      
                
              
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    