| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SSOAdmin.DeleteAccountAssignment
Description
Deletes a principal's access from a specified AWS account using a specified permission set.
After a successful response, call
DescribeAccountAssignmentCreationStatus to describe the status of an
assignment deletion request.
Synopsis
- data DeleteAccountAssignment = DeleteAccountAssignment' {}
- newDeleteAccountAssignment :: Text -> Text -> TargetType -> Text -> PrincipalType -> Text -> DeleteAccountAssignment
- deleteAccountAssignment_instanceArn :: Lens' DeleteAccountAssignment Text
- deleteAccountAssignment_targetId :: Lens' DeleteAccountAssignment Text
- deleteAccountAssignment_targetType :: Lens' DeleteAccountAssignment TargetType
- deleteAccountAssignment_permissionSetArn :: Lens' DeleteAccountAssignment Text
- deleteAccountAssignment_principalType :: Lens' DeleteAccountAssignment PrincipalType
- deleteAccountAssignment_principalId :: Lens' DeleteAccountAssignment Text
- data DeleteAccountAssignmentResponse = DeleteAccountAssignmentResponse' {}
- newDeleteAccountAssignmentResponse :: Int -> DeleteAccountAssignmentResponse
- deleteAccountAssignmentResponse_accountAssignmentDeletionStatus :: Lens' DeleteAccountAssignmentResponse (Maybe AccountAssignmentOperationStatus)
- deleteAccountAssignmentResponse_httpStatus :: Lens' DeleteAccountAssignmentResponse Int
Creating a Request
data DeleteAccountAssignment Source #
See: newDeleteAccountAssignment smart constructor.
Constructors
| DeleteAccountAssignment' | |
Fields
| |
Instances
newDeleteAccountAssignment Source #
Arguments
| :: Text | |
| -> Text | |
| -> TargetType | |
| -> Text | |
| -> PrincipalType | |
| -> Text | |
| -> DeleteAccountAssignment |
Create a value of DeleteAccountAssignment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAccountAssignment, deleteAccountAssignment_instanceArn - 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.
DeleteAccountAssignment, deleteAccountAssignment_targetId - TargetID is an AWS account identifier, typically a 10-12 digit string
(For example, 123456789012).
DeleteAccountAssignment, deleteAccountAssignment_targetType - The entity type for which the assignment will be deleted.
DeleteAccountAssignment, deleteAccountAssignment_permissionSetArn - The ARN of the permission set that will be used to remove access.
DeleteAccountAssignment, deleteAccountAssignment_principalType - The entity type for which the assignment will be deleted.
DeleteAccountAssignment, deleteAccountAssignment_principalId - 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.
Request Lenses
deleteAccountAssignment_instanceArn :: Lens' DeleteAccountAssignment Text Source #
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.
deleteAccountAssignment_targetId :: Lens' DeleteAccountAssignment Text Source #
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
deleteAccountAssignment_targetType :: Lens' DeleteAccountAssignment TargetType Source #
The entity type for which the assignment will be deleted.
deleteAccountAssignment_permissionSetArn :: Lens' DeleteAccountAssignment Text Source #
The ARN of the permission set that will be used to remove access.
deleteAccountAssignment_principalType :: Lens' DeleteAccountAssignment PrincipalType Source #
The entity type for which the assignment will be deleted.
deleteAccountAssignment_principalId :: Lens' DeleteAccountAssignment Text Source #
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.
Destructuring the Response
data DeleteAccountAssignmentResponse Source #
See: newDeleteAccountAssignmentResponse smart constructor.
Constructors
| DeleteAccountAssignmentResponse' | |
Fields
| |
Instances
newDeleteAccountAssignmentResponse Source #
Create a value of DeleteAccountAssignmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountAssignmentDeletionStatus:DeleteAccountAssignmentResponse', deleteAccountAssignmentResponse_accountAssignmentDeletionStatus - The status object for the account assignment deletion operation.
$sel:httpStatus:DeleteAccountAssignmentResponse', deleteAccountAssignmentResponse_httpStatus - The response's http status code.
Response Lenses
deleteAccountAssignmentResponse_accountAssignmentDeletionStatus :: Lens' DeleteAccountAssignmentResponse (Maybe AccountAssignmentOperationStatus) Source #
The status object for the account assignment deletion operation.
deleteAccountAssignmentResponse_httpStatus :: Lens' DeleteAccountAssignmentResponse Int Source #
The response's http status code.