delete_account_assignment

SSOAdmin.Client.delete_account_assignment(**kwargs)

Deletes a principal's access from a specified AWS account using a specified permission set.

Note

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

See also: AWS API Documentation

Request Syntax

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

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 AWS Service Namespaces in the AWS General Reference .

• TargetId (string) --

  [REQUIRED]

  TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

• TargetType (string) --

  [REQUIRED]

  The entity type for which the assignment will be deleted.

• PermissionSetArn (string) --

  [REQUIRED]

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

• PrincipalType (string) --

  [REQUIRED]

  The entity type for which the assignment will be deleted.

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

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • AccountAssignmentDeletionStatus (dict) --

    The status object for the account assignment deletion operation.

    • Status (string) --

      The status of the permission set provisioning process.

    • RequestId (string) --

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

    • FailureReason (string) --

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

    • TargetId (string) --

      TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

    • TargetType (string) --

      The entity type for which the assignment will be created.

    • PermissionSetArn (string) --

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

    • PrincipalType (string) --

      The entity type for which the assignment will be created.

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

    • CreatedDate (datetime) --

      The date that the permission set was created.

Exceptions

• SSOAdmin.Client.exceptions.ResourceNotFoundException
• SSOAdmin.Client.exceptions.InternalServerException
• SSOAdmin.Client.exceptions.ThrottlingException
• SSOAdmin.Client.exceptions.ValidationException
• SSOAdmin.Client.exceptions.AccessDeniedException
• SSOAdmin.Client.exceptions.ConflictException