Delete Account Assignment

ssoadmin_delete_account_assignment

R Documentation

Deletes a principal's access from a specified Amazon Web Services account using a specified permission set¶

Description¶

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

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

Usage¶

ssoadmin_delete_account_assignment(InstanceArn, PermissionSetArn,
  PrincipalId, PrincipalType, TargetId, TargetType)

Arguments¶

InstanceArn: [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: [required] The ARN of the permission set that will be used to remove access.
PrincipalId: [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: [required] The entity type for which the assignment will be deleted.
TargetId: [required] TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
TargetType: [required] The entity type for which the assignment will be deleted.

Value¶

A list with the following syntax:

list(
  AccountAssignmentDeletionStatus = list(
    CreatedDate = as.POSIXct(
      "2015-01-01"
    ),
    FailureReason = "string",
    PermissionSetArn = "string",
    PrincipalId = "string",
    PrincipalType = "USER"|"GROUP",
    RequestId = "string",
    Status = "IN_PROGRESS"|"FAILED"|"SUCCEEDED",
    TargetId = "string",
    TargetType = "AWS_ACCOUNT"
  )
)

Request syntax¶

svc$delete_account_assignment(
  InstanceArn = "string",
  PermissionSetArn = "string",
  PrincipalId = "string",
  PrincipalType = "USER"|"GROUP",
  TargetId = "string",
  TargetType = "AWS_ACCOUNT"
)