SSOAdmin / Client / get_application_authentication_method

get_application_authentication_method#

SSOAdmin.Client.get_application_authentication_method(**kwargs)#

Retrieves details about an authentication method used by an application.

See also: AWS API Documentation

Request Syntax

response = client.get_application_authentication_method(
    ApplicationArn='string',
    AuthenticationMethodType='IAM'
)
Parameters:

  • ApplicationArn (string) –

    [REQUIRED]

    Specifies the ARN of the application.

  • AuthenticationMethodType (string) –

    [REQUIRED]

    Specifies the type of authentication method for which you want details.

Return type:

dict

Returns:

Response Syntax

{
    'AuthenticationMethod': {
        'Iam': {
            'ActorPolicy': {...}|[...]|123|123.4|'string'|True|None
        }
    }
}

Response Structure

  • (dict) –

    • AuthenticationMethod (dict) –

      A structure that contains details about the requested authentication method.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: Iam. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • Iam (dict) –

        A structure that describes details for IAM authentication.

        • ActorPolicy (document) –

          An IAM policy document in JSON.

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException