@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSSOAdminClient extends AmazonWebServiceClient implements AWSSSOAdmin
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AWSSSOAdminClientBuilder builder()
public AttachManagedPolicyToPermissionSetResult attachManagedPolicyToPermissionSet(AttachManagedPolicyToPermissionSetRequest request)
Attaches an IAM 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 action to apply the corresponding IAM policy updates to
all assigned accounts.
attachManagedPolicyToPermissionSet in interface AWSSSOAdminattachManagedPolicyToPermissionSetRequest - 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.public CreateAccountAssignmentResult createAccountAssignment(CreateAccountAssignmentRequest request)
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 AWS SSO.
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 attached to the SSO-created IAM role. 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 will need to call
ProvisionPermissionSet to make these updates.
createAccountAssignment in interface AWSSSOAdmincreateAccountAssignmentRequest - 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.public CreatePermissionSetResult createPermissionSet(CreatePermissionSetRequest request)
Creates a permission set within a specified SSO instance.
To grant users and groups access to AWS account resources, use CreateAccountAssignment .
createPermissionSet in interface AWSSSOAdmincreatePermissionSetRequest - 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.public DeleteAccountAssignmentResult deleteAccountAssignment(DeleteAccountAssignmentRequest request)
Deletes a principal's access from a specified AWS account using a specified permission set.
deleteAccountAssignment in interface AWSSSOAdmindeleteAccountAssignmentRequest - 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.public DeleteInlinePolicyFromPermissionSetResult deleteInlinePolicyFromPermissionSet(DeleteInlinePolicyFromPermissionSetRequest request)
Deletes the inline policy from a specified permission set.
deleteInlinePolicyFromPermissionSet in interface AWSSSOAdmindeleteInlinePolicyFromPermissionSetRequest - 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.public DeletePermissionSetResult deletePermissionSet(DeletePermissionSetRequest request)
Deletes the specified permission set.
deletePermissionSet in interface AWSSSOAdmindeletePermissionSetRequest - 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.public DescribeAccountAssignmentCreationStatusResult describeAccountAssignmentCreationStatus(DescribeAccountAssignmentCreationStatusRequest request)
Describes the status of the assignment creation request.
describeAccountAssignmentCreationStatus in interface AWSSSOAdmindescribeAccountAssignmentCreationStatusRequest - 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.public DescribeAccountAssignmentDeletionStatusResult describeAccountAssignmentDeletionStatus(DescribeAccountAssignmentDeletionStatusRequest request)
Describes the status of the assignment deletion request.
describeAccountAssignmentDeletionStatus in interface AWSSSOAdmindescribeAccountAssignmentDeletionStatusRequest - 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.public DescribePermissionSetResult describePermissionSet(DescribePermissionSetRequest request)
Gets the details of the permission set.
describePermissionSet in interface AWSSSOAdmindescribePermissionSetRequest - 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.public DescribePermissionSetProvisioningStatusResult describePermissionSetProvisioningStatus(DescribePermissionSetProvisioningStatusRequest request)
Describes the status for the given permission set provisioning request.
describePermissionSetProvisioningStatus in interface AWSSSOAdmindescribePermissionSetProvisioningStatusRequest - 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.public DetachManagedPolicyFromPermissionSetResult detachManagedPolicyFromPermissionSet(DetachManagedPolicyFromPermissionSetRequest request)
Detaches the attached IAM managed policy ARN from the specified permission set.
detachManagedPolicyFromPermissionSet in interface AWSSSOAdmindetachManagedPolicyFromPermissionSetRequest - 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.public GetInlinePolicyForPermissionSetResult getInlinePolicyForPermissionSet(GetInlinePolicyForPermissionSetRequest request)
Obtains the inline policy assigned to the permission set.
getInlinePolicyForPermissionSet in interface AWSSSOAdmingetInlinePolicyForPermissionSetRequest - 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.public ListAccountAssignmentCreationStatusResult listAccountAssignmentCreationStatus(ListAccountAssignmentCreationStatusRequest request)
Lists the status of the AWS account assignment creation requests for a specified SSO instance.
listAccountAssignmentCreationStatus in interface AWSSSOAdminlistAccountAssignmentCreationStatusRequest - 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.public ListAccountAssignmentDeletionStatusResult listAccountAssignmentDeletionStatus(ListAccountAssignmentDeletionStatusRequest request)
Lists the status of the AWS account assignment deletion requests for a specified SSO instance.
listAccountAssignmentDeletionStatus in interface AWSSSOAdminlistAccountAssignmentDeletionStatusRequest - 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.public ListAccountAssignmentsResult listAccountAssignments(ListAccountAssignmentsRequest request)
Lists the assignee of the specified AWS account with the specified permission set.
listAccountAssignments in interface AWSSSOAdminlistAccountAssignmentsRequest - 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.public ListAccountsForProvisionedPermissionSetResult listAccountsForProvisionedPermissionSet(ListAccountsForProvisionedPermissionSetRequest request)
Lists all the AWS accounts where the specified permission set is provisioned.
listAccountsForProvisionedPermissionSet in interface AWSSSOAdminlistAccountsForProvisionedPermissionSetRequest - 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.public ListInstancesResult listInstances(ListInstancesRequest request)
Lists the SSO instances that the caller has access to.
listInstances in interface AWSSSOAdminlistInstancesRequest - 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.public ListManagedPoliciesInPermissionSetResult listManagedPoliciesInPermissionSet(ListManagedPoliciesInPermissionSetRequest request)
Lists the IAM managed policy that is attached to a specified permission set.
listManagedPoliciesInPermissionSet in interface AWSSSOAdminlistManagedPoliciesInPermissionSetRequest - 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.public ListPermissionSetProvisioningStatusResult listPermissionSetProvisioningStatus(ListPermissionSetProvisioningStatusRequest request)
Lists the status of the permission set provisioning requests for a specified SSO instance.
listPermissionSetProvisioningStatus in interface AWSSSOAdminlistPermissionSetProvisioningStatusRequest - 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.public ListPermissionSetsResult listPermissionSets(ListPermissionSetsRequest request)
Lists the PermissionSets in an SSO instance.
listPermissionSets in interface AWSSSOAdminlistPermissionSetsRequest - 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.public ListPermissionSetsProvisionedToAccountResult listPermissionSetsProvisionedToAccount(ListPermissionSetsProvisionedToAccountRequest request)
Lists all the permission sets that are provisioned to a specified AWS account.
listPermissionSetsProvisionedToAccount in interface AWSSSOAdminlistPermissionSetsProvisionedToAccountRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags that are attached to a specified resource.
listTagsForResource in interface AWSSSOAdminlistTagsForResourceRequest - 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.public ProvisionPermissionSetResult provisionPermissionSet(ProvisionPermissionSetRequest request)
The process by which a specified permission set is provisioned to the specified target.
provisionPermissionSet in interface AWSSSOAdminprovisionPermissionSetRequest - 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.public PutInlinePolicyToPermissionSetResult putInlinePolicyToPermissionSet(PutInlinePolicyToPermissionSetRequest request)
Attaches an IAM 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.
putInlinePolicyToPermissionSet in interface AWSSSOAdminputInlinePolicyToPermissionSetRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Associates a set of tags with a specified resource.
tagResource in interface AWSSSOAdmintagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Disassociates a set of tags from a specified resource.
untagResource in interface AWSSSOAdminuntagResourceRequest - 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.public UpdatePermissionSetResult updatePermissionSet(UpdatePermissionSetRequest request)
Updates an existing permission set.
updatePermissionSet in interface AWSSSOAdminupdatePermissionSetRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSSSOAdminrequest - The originally executed request