@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSSOAdmin
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSSOAdmin instead.
AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across AWS accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in AWS, for organizations of any size and type.
Although AWS Single Sign-On was renamed, the sso and identitystore API namespaces will
continue to retain their original name for backward compatibility purposes. For more information, see IAM Identity Center rename.
This reference guide provides information on single sign-on operations which could be used for access management of AWS accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AttachCustomerManagedPolicyReferenceToPermissionSetResult |
attachCustomerManagedPolicyReferenceToPermissionSet(AttachCustomerManagedPolicyReferenceToPermissionSetRequest attachCustomerManagedPolicyReferenceToPermissionSetRequest)
Attaches the specified customer managed policy to the specified PermissionSet.
|
AttachManagedPolicyToPermissionSetResult |
attachManagedPolicyToPermissionSet(AttachManagedPolicyToPermissionSetRequest attachManagedPolicyToPermissionSetRequest)
Attaches an AWS managed policy ARN to a permission set.
|
CreateAccountAssignmentResult |
createAccountAssignment(CreateAccountAssignmentRequest createAccountAssignmentRequest)
Assigns access to a principal for a specified AWS account using a specified permission set.
|
CreateInstanceAccessControlAttributeConfigurationResult |
createInstanceAccessControlAttributeConfiguration(CreateInstanceAccessControlAttributeConfigurationRequest createInstanceAccessControlAttributeConfigurationRequest)
Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance.
|
CreatePermissionSetResult |
createPermissionSet(CreatePermissionSetRequest createPermissionSetRequest)
Creates a permission set within a specified IAM Identity Center instance.
|
DeleteAccountAssignmentResult |
deleteAccountAssignment(DeleteAccountAssignmentRequest deleteAccountAssignmentRequest)
Deletes a principal's access from a specified AWS account using a specified permission set.
|
DeleteInlinePolicyFromPermissionSetResult |
deleteInlinePolicyFromPermissionSet(DeleteInlinePolicyFromPermissionSetRequest deleteInlinePolicyFromPermissionSetRequest)
Deletes the inline policy from a specified permission set.
|
DeleteInstanceAccessControlAttributeConfigurationResult |
deleteInstanceAccessControlAttributeConfiguration(DeleteInstanceAccessControlAttributeConfigurationRequest deleteInstanceAccessControlAttributeConfigurationRequest)
Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and
deletes all of the attribute mappings that have been configured.
|
DeletePermissionsBoundaryFromPermissionSetResult |
deletePermissionsBoundaryFromPermissionSet(DeletePermissionsBoundaryFromPermissionSetRequest deletePermissionsBoundaryFromPermissionSetRequest)
Deletes the permissions boundary from a specified PermissionSet.
|
DeletePermissionSetResult |
deletePermissionSet(DeletePermissionSetRequest deletePermissionSetRequest)
Deletes the specified permission set.
|
DescribeAccountAssignmentCreationStatusResult |
describeAccountAssignmentCreationStatus(DescribeAccountAssignmentCreationStatusRequest describeAccountAssignmentCreationStatusRequest)
Describes the status of the assignment creation request.
|
DescribeAccountAssignmentDeletionStatusResult |
describeAccountAssignmentDeletionStatus(DescribeAccountAssignmentDeletionStatusRequest describeAccountAssignmentDeletionStatusRequest)
Describes the status of the assignment deletion request.
|
DescribeInstanceAccessControlAttributeConfigurationResult |
describeInstanceAccessControlAttributeConfiguration(DescribeInstanceAccessControlAttributeConfigurationRequest describeInstanceAccessControlAttributeConfigurationRequest)
Returns the list of IAM Identity Center identity store attributes that have been configured to work with
attributes-based access control (ABAC) for the specified IAM Identity Center instance.
|
DescribePermissionSetResult |
describePermissionSet(DescribePermissionSetRequest describePermissionSetRequest)
Gets the details of the permission set.
|
DescribePermissionSetProvisioningStatusResult |
describePermissionSetProvisioningStatus(DescribePermissionSetProvisioningStatusRequest describePermissionSetProvisioningStatusRequest)
Describes the status for the given permission set provisioning request.
|
DetachCustomerManagedPolicyReferenceFromPermissionSetResult |
detachCustomerManagedPolicyReferenceFromPermissionSet(DetachCustomerManagedPolicyReferenceFromPermissionSetRequest detachCustomerManagedPolicyReferenceFromPermissionSetRequest)
Detaches the specified customer managed policy from the specified PermissionSet.
|
DetachManagedPolicyFromPermissionSetResult |
detachManagedPolicyFromPermissionSet(DetachManagedPolicyFromPermissionSetRequest detachManagedPolicyFromPermissionSetRequest)
Detaches the attached AWS managed policy ARN from the specified permission set.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetInlinePolicyForPermissionSetResult |
getInlinePolicyForPermissionSet(GetInlinePolicyForPermissionSetRequest getInlinePolicyForPermissionSetRequest)
Obtains the inline policy assigned to the permission set.
|
GetPermissionsBoundaryForPermissionSetResult |
getPermissionsBoundaryForPermissionSet(GetPermissionsBoundaryForPermissionSetRequest getPermissionsBoundaryForPermissionSetRequest)
Obtains the permissions boundary for a specified PermissionSet.
|
ListAccountAssignmentCreationStatusResult |
listAccountAssignmentCreationStatus(ListAccountAssignmentCreationStatusRequest listAccountAssignmentCreationStatusRequest)
Lists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance.
|
ListAccountAssignmentDeletionStatusResult |
listAccountAssignmentDeletionStatus(ListAccountAssignmentDeletionStatusRequest listAccountAssignmentDeletionStatusRequest)
Lists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance.
|
ListAccountAssignmentsResult |
listAccountAssignments(ListAccountAssignmentsRequest listAccountAssignmentsRequest)
Lists the assignee of the specified AWS account with the specified permission set.
|
ListAccountsForProvisionedPermissionSetResult |
listAccountsForProvisionedPermissionSet(ListAccountsForProvisionedPermissionSetRequest listAccountsForProvisionedPermissionSetRequest)
Lists all the AWS accounts where the specified permission set is provisioned.
|
ListCustomerManagedPolicyReferencesInPermissionSetResult |
listCustomerManagedPolicyReferencesInPermissionSet(ListCustomerManagedPolicyReferencesInPermissionSetRequest listCustomerManagedPolicyReferencesInPermissionSetRequest)
Lists all customer managed policies attached to a specified PermissionSet.
|
ListInstancesResult |
listInstances(ListInstancesRequest listInstancesRequest)
Lists the IAM Identity Center instances that the caller has access to.
|
ListManagedPoliciesInPermissionSetResult |
listManagedPoliciesInPermissionSet(ListManagedPoliciesInPermissionSetRequest listManagedPoliciesInPermissionSetRequest)
Lists the AWS managed policy that is attached to a specified permission set.
|
ListPermissionSetProvisioningStatusResult |
listPermissionSetProvisioningStatus(ListPermissionSetProvisioningStatusRequest listPermissionSetProvisioningStatusRequest)
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
|
ListPermissionSetsResult |
listPermissionSets(ListPermissionSetsRequest listPermissionSetsRequest)
Lists the PermissionSets in an IAM Identity Center instance.
|
ListPermissionSetsProvisionedToAccountResult |
listPermissionSetsProvisionedToAccount(ListPermissionSetsProvisionedToAccountRequest listPermissionSetsProvisionedToAccountRequest)
Lists all the permission sets that are provisioned to a specified AWS account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are attached to a specified resource.
|
ProvisionPermissionSetResult |
provisionPermissionSet(ProvisionPermissionSetRequest provisionPermissionSetRequest)
The process by which a specified permission set is provisioned to the specified target.
|
PutInlinePolicyToPermissionSetResult |
putInlinePolicyToPermissionSet(PutInlinePolicyToPermissionSetRequest putInlinePolicyToPermissionSetRequest)
Attaches an inline policy to a permission set.
|
PutPermissionsBoundaryToPermissionSetResult |
putPermissionsBoundaryToPermissionSet(PutPermissionsBoundaryToPermissionSetRequest putPermissionsBoundaryToPermissionSetRequest)
Attaches an AWS managed or customer managed policy to the specified PermissionSet as a permissions
boundary.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associates a set of tags with a specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Disassociates a set of tags from a specified resource.
|
UpdateInstanceAccessControlAttributeConfigurationResult |
updateInstanceAccessControlAttributeConfiguration(UpdateInstanceAccessControlAttributeConfigurationRequest updateInstanceAccessControlAttributeConfigurationRequest)
Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance
for attributes-based access control (ABAC).
|
UpdatePermissionSetResult |
updatePermissionSet(UpdatePermissionSetRequest updatePermissionSetRequest)
Updates an existing permission set.
|
static final String ENDPOINT_PREFIX
AttachCustomerManagedPolicyReferenceToPermissionSetResult attachCustomerManagedPolicyReferenceToPermissionSet(AttachCustomerManagedPolicyReferenceToPermissionSetRequest attachCustomerManagedPolicyReferenceToPermissionSetRequest)
Attaches the specified customer managed policy to the specified PermissionSet.
attachCustomerManagedPolicyReferenceToPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ServiceQuotaExceededException - Indicates that the principal has crossed the permitted number of resources that can be created.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.AttachManagedPolicyToPermissionSetResult attachManagedPolicyToPermissionSet(AttachManagedPolicyToPermissionSetRequest attachManagedPolicyToPermissionSetRequest)
Attaches an AWS managed policy ARN to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet after this operation. Calling ProvisionPermissionSet
applies the corresponding IAM policy updates to all assigned accounts.
attachManagedPolicyToPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ServiceQuotaExceededException - Indicates that the principal has crossed the permitted number of resources that can be created.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.CreateAccountAssignmentResult createAccountAssignment(CreateAccountAssignmentRequest createAccountAssignmentRequest)
Assigns access to a principal for a specified AWS account using a specified permission set.
The term principal here refers to a user or group that is defined in IAM Identity Center.
As part of a successful CreateAccountAssignment call, the specified permission set will
automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role
created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies
attached to roles in your accounts will not be updated automatically. In this case, you must call
ProvisionPermissionSet to make these updates.
After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of
an assignment creation request.
createAccountAssignmentRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ServiceQuotaExceededException - Indicates that the principal has crossed the permitted number of resources that can be created.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.CreateInstanceAccessControlAttributeConfigurationResult createInstanceAccessControlAttributeConfiguration(CreateInstanceAccessControlAttributeConfigurationRequest createInstanceAccessControlAttributeConfigurationRequest)
Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate
that InstanceAccessControlAttributeConfiguration was created.
createInstanceAccessControlAttributeConfigurationRequest - InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.ResourceNotFoundException - Indicates that a requested resource is not found.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.CreatePermissionSetResult createPermissionSet(CreatePermissionSetRequest createPermissionSetRequest)
Creates a permission set within a specified IAM Identity Center instance.
To grant users and groups access to AWS account resources, use CreateAccountAssignment .
createPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ServiceQuotaExceededException - Indicates that the principal has crossed the permitted number of resources that can be created.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.DeleteAccountAssignmentResult deleteAccountAssignment(DeleteAccountAssignmentRequest deleteAccountAssignmentRequest)
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.
deleteAccountAssignmentRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.DeleteInlinePolicyFromPermissionSetResult deleteInlinePolicyFromPermissionSet(DeleteInlinePolicyFromPermissionSetRequest deleteInlinePolicyFromPermissionSetRequest)
Deletes the inline policy from a specified permission set.
deleteInlinePolicyFromPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.DeleteInstanceAccessControlAttributeConfigurationResult deleteInstanceAccessControlAttributeConfiguration(DeleteInstanceAccessControlAttributeConfigurationRequest deleteInstanceAccessControlAttributeConfigurationRequest)
Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
deleteInstanceAccessControlAttributeConfigurationRequest - InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.ResourceNotFoundException - Indicates that a requested resource is not found.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.DeletePermissionSetResult deletePermissionSet(DeletePermissionSetRequest deletePermissionSetRequest)
Deletes the specified permission set.
deletePermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.DeletePermissionsBoundaryFromPermissionSetResult deletePermissionsBoundaryFromPermissionSet(DeletePermissionsBoundaryFromPermissionSetRequest deletePermissionsBoundaryFromPermissionSetRequest)
Deletes the permissions boundary from a specified PermissionSet.
deletePermissionsBoundaryFromPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.DescribeAccountAssignmentCreationStatusResult describeAccountAssignmentCreationStatus(DescribeAccountAssignmentCreationStatusRequest describeAccountAssignmentCreationStatusRequest)
Describes the status of the assignment creation request.
describeAccountAssignmentCreationStatusRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.DescribeAccountAssignmentDeletionStatusResult describeAccountAssignmentDeletionStatus(DescribeAccountAssignmentDeletionStatusRequest describeAccountAssignmentDeletionStatusRequest)
Describes the status of the assignment deletion request.
describeAccountAssignmentDeletionStatusRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.DescribeInstanceAccessControlAttributeConfigurationResult describeInstanceAccessControlAttributeConfiguration(DescribeInstanceAccessControlAttributeConfigurationRequest describeInstanceAccessControlAttributeConfigurationRequest)
Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
describeInstanceAccessControlAttributeConfigurationRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.DescribePermissionSetResult describePermissionSet(DescribePermissionSetRequest describePermissionSetRequest)
Gets the details of the permission set.
describePermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.DescribePermissionSetProvisioningStatusResult describePermissionSetProvisioningStatus(DescribePermissionSetProvisioningStatusRequest describePermissionSetProvisioningStatusRequest)
Describes the status for the given permission set provisioning request.
describePermissionSetProvisioningStatusRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.DetachCustomerManagedPolicyReferenceFromPermissionSetResult detachCustomerManagedPolicyReferenceFromPermissionSet(DetachCustomerManagedPolicyReferenceFromPermissionSetRequest detachCustomerManagedPolicyReferenceFromPermissionSetRequest)
Detaches the specified customer managed policy from the specified PermissionSet.
detachCustomerManagedPolicyReferenceFromPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.DetachManagedPolicyFromPermissionSetResult detachManagedPolicyFromPermissionSet(DetachManagedPolicyFromPermissionSetRequest detachManagedPolicyFromPermissionSetRequest)
Detaches the attached AWS managed policy ARN from the specified permission set.
detachManagedPolicyFromPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.GetInlinePolicyForPermissionSetResult getInlinePolicyForPermissionSet(GetInlinePolicyForPermissionSetRequest getInlinePolicyForPermissionSetRequest)
Obtains the inline policy assigned to the permission set.
getInlinePolicyForPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.GetPermissionsBoundaryForPermissionSetResult getPermissionsBoundaryForPermissionSet(GetPermissionsBoundaryForPermissionSetRequest getPermissionsBoundaryForPermissionSetRequest)
Obtains the permissions boundary for a specified PermissionSet.
getPermissionsBoundaryForPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListAccountAssignmentCreationStatusResult listAccountAssignmentCreationStatus(ListAccountAssignmentCreationStatusRequest listAccountAssignmentCreationStatusRequest)
Lists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance.
listAccountAssignmentCreationStatusRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListAccountAssignmentDeletionStatusResult listAccountAssignmentDeletionStatus(ListAccountAssignmentDeletionStatusRequest listAccountAssignmentDeletionStatusRequest)
Lists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance.
listAccountAssignmentDeletionStatusRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListAccountAssignmentsResult listAccountAssignments(ListAccountAssignmentsRequest listAccountAssignmentsRequest)
Lists the assignee of the specified AWS account with the specified permission set.
listAccountAssignmentsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListAccountsForProvisionedPermissionSetResult listAccountsForProvisionedPermissionSet(ListAccountsForProvisionedPermissionSetRequest listAccountsForProvisionedPermissionSetRequest)
Lists all the AWS accounts where the specified permission set is provisioned.
listAccountsForProvisionedPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListCustomerManagedPolicyReferencesInPermissionSetResult listCustomerManagedPolicyReferencesInPermissionSet(ListCustomerManagedPolicyReferencesInPermissionSetRequest listCustomerManagedPolicyReferencesInPermissionSetRequest)
Lists all customer managed policies attached to a specified PermissionSet.
listCustomerManagedPolicyReferencesInPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest)
Lists the IAM Identity Center instances that the caller has access to.
listInstancesRequest - InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.ListManagedPoliciesInPermissionSetResult listManagedPoliciesInPermissionSet(ListManagedPoliciesInPermissionSetRequest listManagedPoliciesInPermissionSetRequest)
Lists the AWS managed policy that is attached to a specified permission set.
listManagedPoliciesInPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListPermissionSetProvisioningStatusResult listPermissionSetProvisioningStatus(ListPermissionSetProvisioningStatusRequest listPermissionSetProvisioningStatusRequest)
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
listPermissionSetProvisioningStatusRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListPermissionSetsResult listPermissionSets(ListPermissionSetsRequest listPermissionSetsRequest)
Lists the PermissionSets in an IAM Identity Center instance.
listPermissionSetsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListPermissionSetsProvisionedToAccountResult listPermissionSetsProvisionedToAccount(ListPermissionSetsProvisionedToAccountRequest listPermissionSetsProvisionedToAccountRequest)
Lists all the permission sets that are provisioned to a specified AWS account.
listPermissionSetsProvisionedToAccountRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are attached to a specified resource.
listTagsForResourceRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ProvisionPermissionSetResult provisionPermissionSet(ProvisionPermissionSetRequest provisionPermissionSetRequest)
The process by which a specified permission set is provisioned to the specified target.
provisionPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.PutInlinePolicyToPermissionSetResult putInlinePolicyToPermissionSet(PutInlinePolicyToPermissionSetRequest putInlinePolicyToPermissionSetRequest)
Attaches an inline policy to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to
all assigned accounts.
putInlinePolicyToPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ServiceQuotaExceededException - Indicates that the principal has crossed the permitted number of resources that can be created.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.PutPermissionsBoundaryToPermissionSetResult putPermissionsBoundaryToPermissionSet(PutPermissionsBoundaryToPermissionSetRequest putPermissionsBoundaryToPermissionSetRequest)
Attaches an AWS managed or customer managed policy to the specified PermissionSet as a permissions boundary.
putPermissionsBoundaryToPermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Associates a set of tags with a specified resource.
tagResourceRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ServiceQuotaExceededException - Indicates that the principal has crossed the permitted number of resources that can be created.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Disassociates a set of tags from a specified resource.
untagResourceRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.UpdateInstanceAccessControlAttributeConfigurationResult updateInstanceAccessControlAttributeConfiguration(UpdateInstanceAccessControlAttributeConfigurationRequest updateInstanceAccessControlAttributeConfigurationRequest)
Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
updateInstanceAccessControlAttributeConfigurationRequest - InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.ResourceNotFoundException - Indicates that a requested resource is not found.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.UpdatePermissionSetResult updatePermissionSet(UpdatePermissionSetRequest updatePermissionSetRequest)
Updates an existing permission set.
updatePermissionSetRequest - ResourceNotFoundException - Indicates that a requested resource is not found.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.ValidationException - The request failed because it contains a syntax error.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.