SSOAdmin / Client / update_application

update_application#

SSOAdmin.Client.update_application(**kwargs)#

Updates application properties.

See also: AWS API Documentation

Request Syntax

response = client.update_application(
    ApplicationArn='string',
    Description='string',
    Name='string',
    PortalOptions={
        'SignInOptions': {
            'ApplicationUrl': 'string',
            'Origin': 'IDENTITY_CENTER'|'APPLICATION'
        }
    },
    Status='ENABLED'|'DISABLED'
)
Parameters:

  • ApplicationArn (string) –

    [REQUIRED]

    Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • Description (string) – The description of the .

  • Name (string) – Specifies the updated name for the application.

  • 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 an application 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) – [REQUIRED]

        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.

  • Status (string) – Specifies whether the application is enabled or disabled.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException

  • SSOAdmin.Client.exceptions.ConflictException