SSOAdmin / Client / list_applications

list_applications

SSOAdmin.Client.list_applications(**kwargs)

Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account.

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    Filter={
        'ApplicationAccount': 'string',
        'ApplicationProvider': 'string'
    },
    InstanceArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• Filter (dict) –

  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.

• InstanceArn (string) –

  [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 in the Amazon Web Services General Reference.

• MaxResults (integer) – Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

• NextToken (string) – Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s NextToken response to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Applications': [
        {
            'ApplicationAccount': 'string',
            'ApplicationArn': 'string',
            'ApplicationProviderArn': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'Description': 'string',
            'InstanceArn': 'string',
            'Name': 'string',
            'PortalOptions': {
                'SignInOptions': {
                    'ApplicationUrl': 'string',
                    'Origin': 'IDENTITY_CENTER'|'APPLICATION'
                },
                'Visibility': 'ENABLED'|'DISABLED'
            },
            'Status': 'ENABLED'|'DISABLED'
        },
    ],
    'NextToken': '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.

      • ApplicationAccount (string) –

        The Amazon Web Services account ID number of the application.

      • ApplicationArn (string) –

        The ARN of the application.

      • ApplicationProviderArn (string) –

        The ARN of the application provider for this application.

      • CreatedDate (datetime) –

        The date and time when the application was originally created.

      • Description (string) –

        The description of the application.

      • InstanceArn (string) –

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

      • Name (string) –

        The name of the application.

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

          • ApplicationUrl (string) –

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

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

        • Visibility (string) –

          Indicates whether this application is visible in the access portal.

      • Status (string) –

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

  • NextToken (string) –

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Exceptions

• SSOAdmin.Client.exceptions.ThrottlingException

• SSOAdmin.Client.exceptions.InternalServerException

• SSOAdmin.Client.exceptions.AccessDeniedException

• SSOAdmin.Client.exceptions.ValidationException