SSOAdmin / Client / delete_account_assignment

delete_account_assignment#

SSOAdmin.Client.delete_account_assignment(**kwargs)#

Deletes a principal’s access from a specified Amazon Web Services account using a specified permission set.

Note

After a successful response, call DescribeAccountAssignmentDeletionStatus to describe the status of an assignment deletion request.

See also: AWS API Documentation

Request Syntax

response = client.delete_account_assignment(
    InstanceArn='string',
    PermissionSetArn='string',
    PrincipalId='string',
    PrincipalType='USER'|'GROUP',
    TargetId='string',
    TargetType='AWS_ACCOUNT'
)
Parameters:

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

  • PermissionSetArn (string) –

    [REQUIRED]

    The ARN of the permission set that will be used to remove access.

  • PrincipalId (string) –

    [REQUIRED]

    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) –

    [REQUIRED]

    The entity type for which the assignment will be deleted.

  • TargetId (string) –

    [REQUIRED]

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

  • TargetType (string) –

    [REQUIRED]

    The entity type for which the assignment will be deleted.

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