AccountAccess / Client / get_application

get_application

AccountAccess.Client.get_application(**kwargs)

Retrieves details about an account access manager application, including its status, identity source, and tags.

See also: AWS API Documentation

Request Syntax

response = client.get_application(
    applicationArn='string'
)
Parameters:

applicationArn (string) –

[REQUIRED]

Specifies the ARN of the application to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'identitySource': {
        'identityCenter': {
            'instanceArn': 'string',
            'applicationArn': 'string'
        }
    },
    'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED',
    'tenantId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'error': {
        'code': 'AUTHORIZATION_ERROR'|'RESOURCE_NOT_FOUND_ERROR'|'SERVICE_QUOTA_EXCEEDED_ERROR'|'INTERNAL_SERVICE_ERROR',
        'message': 'string'
    }
}

Response Structure

  • (dict) –

    • identitySource (dict) –

      The identity source details for the application, including the IAM Identity Center instance configuration.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: identityCenter. 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'}

      • identityCenter (dict) –

        The IAM Identity Center configuration details for the identity source.

        • instanceArn (string) –

          The ARN of the IAM Identity Center instance.

        • applicationArn (string) –

          The ARN of the IAM Identity Center application created for this account access manager application.

    • status (string) –

      The current status of the application.

    • tenantId (string) –

      The tenant identifier associated with the application.

    • createdAt (datetime) –

      The date and time when the application was created.

    • updatedAt (datetime) –

      The date and time when the application was last updated.

    • tags (dict) –

      The tags associated with the application.

      • (string) –

        • (string) –

    • error (dict) –

      The error details if the application is in a failed state.

      • code (string) –

        The error code that identifies the type of error.

      • message (string) –

        A human-readable message that describes the error.

Exceptions

  • AccountAccess.Client.exceptions.AccessDeniedException

  • AccountAccess.Client.exceptions.ResourceNotFoundException

  • AccountAccess.Client.exceptions.ValidationException

  • AccountAccess.Client.exceptions.InternalServerException