SSOAdmin / Client / describe_account_assignment_deletion_status

describe_account_assignment_deletion_status#

SSOAdmin.Client.describe_account_assignment_deletion_status(**kwargs)#

Describes the status of the assignment deletion request.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_assignment_deletion_status(
    AccountAssignmentDeletionRequestId='string',
    InstanceArn='string'
)
Parameters:

  • AccountAssignmentDeletionRequestId (string) –

    [REQUIRED]

    The identifier that is used to track the request operation progress.

  • InstanceArn (string) –

    [REQUIRED]

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Return type:

dict

Returns:

Response Syntax

{
    'AccountAssignmentDeletionStatus': {
        'CreatedDate': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'PermissionSetArn': 'string',
        'PrincipalId': 'string',
        'PrincipalType': 'USER'|'GROUP',
        'RequestId': 'string',
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'TargetId': 'string',
        'TargetType': 'AWS_ACCOUNT'
    }
}

Response Structure

  • (dict) –

    • AccountAssignmentDeletionStatus (dict) –

      The status object for the account assignment deletion operation.

      • CreatedDate (datetime) –

        The date that the permission set was created.

      • FailureReason (string) –

        The message that contains an error or exception in case of an operation failure.

      • PermissionSetArn (string) –

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

      • PrincipalId (string) –

        An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

      • PrincipalType (string) –

        The entity type for which the assignment will be created.

      • RequestId (string) –

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • Status (string) –

        The status of the permission set provisioning process.

      • TargetId (string) –

        TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

      • TargetType (string) –

        The entity type for which the assignment will be created.

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException