:doc:`SSOAdmin <../../sso-admin>` / Paginator / ListApplications

****************
ListApplications
****************



.. py:class:: SSOAdmin.Paginator.ListApplications

  ::

    
    paginator = client.get_paginator('list_applications')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SSOAdmin.Client.list_applications`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListApplications>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          InstanceArn='string',
          Filter={
              'ApplicationAccount': 'string',
              'ApplicationProvider': 'string'
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type InstanceArn: string
    :param InstanceArn: **[REQUIRED]** 

      The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see `Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces </general/latest/gr/aws-arns-and-namespaces.html>`__ in the *Amazon Web Services General Reference*.

      

    
    :type Filter: dict
    :param Filter: 

      Filters response results.

      

    
      - **ApplicationAccount** *(string) --* 

        An Amazon Web Services account ID number that filters the results in the response.

        

      
      - **ApplicationProvider** *(string) --* 

        The ARN of an application provider that can filter the results in the response.

        

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

      
      ::

        {
            'Applications': [
                {
                    'ApplicationArn': 'string',
                    'ApplicationProviderArn': 'string',
                    'Name': 'string',
                    'ApplicationAccount': 'string',
                    'InstanceArn': 'string',
                    'Status': 'ENABLED'|'DISABLED',
                    'PortalOptions': {
                        'SignInOptions': {
                            'Origin': 'IDENTITY_CENTER'|'APPLICATION',
                            'ApplicationUrl': 'string'
                        },
                        'Visibility': 'ENABLED'|'DISABLED'
                    },
                    'Description': 'string',
                    'CreatedDate': datetime(2015, 1, 1),
                    'CreatedFrom': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Applications** *(list) --* 

          Retrieves all applications associated with the instance.

          
          

          - *(dict) --* 

            A structure that describes an application that uses IAM Identity Center for access management.

            
            

            - **ApplicationArn** *(string) --* 

              The ARN of the application.

              
            

            - **ApplicationProviderArn** *(string) --* 

              The ARN of the application provider for this application.

              
            

            - **Name** *(string) --* 

              The name of the application.

              
            

            - **ApplicationAccount** *(string) --* 

              The Amazon Web Services account ID number of the application.

              
            

            - **InstanceArn** *(string) --* 

              The ARN of the instance of IAM Identity Center that is configured with this application.

              
            

            - **Status** *(string) --* 

              The current status of the application in this instance of IAM Identity Center.

              
            

            - **PortalOptions** *(dict) --* 

              A structure that describes the options for the access portal associated with this application.

              
              

              - **SignInOptions** *(dict) --* 

                A structure that describes the sign-in options for the access portal.

                
                

                - **Origin** *(string) --* 

                  This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

                   

                  
                  * ``APPLICATION``: IAM Identity Center redirects the customer to the configured ``ApplicationUrl``.
                   
                  * ``IDENTITY_CENTER``: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
                  

                  
                

                - **ApplicationUrl** *(string) --* 

                  The URL that accepts authentication requests for an application. This is a required parameter if the ``Origin`` parameter is ``APPLICATION``.

                  
            
              

              - **Visibility** *(string) --* 

                Indicates whether this application is visible in the access portal.

                
          
            

            - **Description** *(string) --* 

              The description of the application.

              
            

            - **CreatedDate** *(datetime) --* 

              The date and time when the application was originally created.

              
            

            - **CreatedFrom** *(string) --* 

              The Amazon Web Services Region where the application was created in IAM Identity Center.

              
        
      
    