:doc:`SSOAdmin <../../sso-admin>` / Client / describe_application

********************
describe_application
********************



.. py:method:: SSOAdmin.Client.describe_application(**kwargs)

  

  Retrieves the details of an application associated with an instance of IAM Identity Center.

  

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


  **Request Syntax**
  ::

    response = client.describe_application(
        ApplicationArn='string'
    )
    
  :type ApplicationArn: string
  :param ApplicationArn: **[REQUIRED]** 

    Specifies the ARN of the application. 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*.

    

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

    
    ::

      {
          '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) --* 
      

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

        Specifies the ARN of the application.

        
      

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

        The ARN of the application provider under which the operation will run.

        
      

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

        The application name.

        
      

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

        The account ID.

        
      

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

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

        
      

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

        Specifies whether the application is enabled or disabled.

        
      

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

        A structure that describes the options for the portal associated with an 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 .

        
      

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

        The date the application was created.

        
      

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

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

        
  
  **Exceptions**
  
  *   :py:class:`SSOAdmin.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`SSOAdmin.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.ValidationException`

  