@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSSOAdminClient extends AmazonWebServiceClient implements AWSSSOAdmin
IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size and type.
IAM Identity Center uses the sso and identitystore API namespaces.
This reference guide provides information on single sign-on operations which could be used for access management of Amazon Web Services 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.
Amazon Web Services 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 Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
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, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSSSOAdminClientBuilder builder()
public AttachCustomerManagedPolicyReferenceToPermissionSetResult attachCustomerManagedPolicyReferenceToPermissionSet(AttachCustomerManagedPolicyReferenceToPermissionSetRequest request)
Attaches the specified customer managed policy to the specified PermissionSet.
attachCustomerManagedPolicyReferenceToPermissionSet in interface AWSSSOAdminattachCustomerManagedPolicyReferenceToPermissionSetRequest - 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.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 AttachManagedPolicyToPermissionSetResult attachManagedPolicyToPermissionSet(AttachManagedPolicyToPermissionSetRequest request)
Attaches an Amazon Web Services 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.
attachManagedPolicyToPermissionSet in interface AWSSSOAdminattachManagedPolicyToPermissionSetRequest - 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.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 Amazon Web Services 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.
createAccountAssignment in interface AWSSSOAdmincreateAccountAssignmentRequest - 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.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 CreateApplicationResult createApplication(CreateApplicationRequest request)
Creates an application in IAM Identity Center for the given application provider.
createApplication in interface AWSSSOAdmincreateApplicationRequest - 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.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 CreateApplicationAssignmentResult createApplicationAssignment(CreateApplicationAssignmentRequest request)
Grant application access to a user or group.
createApplicationAssignment in interface AWSSSOAdmincreateApplicationAssignmentRequest - 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.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 CreateInstanceResult createInstance(CreateInstanceRequest request)
Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services Regions.
The CreateInstance request is rejected if the following apply:
The instance is created within the organization management account.
An instance already exists in the same account.
createInstance in interface AWSSSOAdmincreateInstanceRequest - 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.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.ValidationException - The request failed because it contains a syntax error.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 CreateInstanceAccessControlAttributeConfigurationResult createInstanceAccessControlAttributeConfiguration(CreateInstanceAccessControlAttributeConfigurationRequest request)
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.
createInstanceAccessControlAttributeConfiguration in interface AWSSSOAdmincreateInstanceAccessControlAttributeConfigurationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 IAM Identity Center instance.
To grant users and groups access to Amazon Web Services account resources, use
CreateAccountAssignment .
createPermissionSet in interface AWSSSOAdmincreatePermissionSetRequest - 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.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 CreateTrustedTokenIssuerResult createTrustedTokenIssuer(CreateTrustedTokenIssuerRequest request)
Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services.
This trusted token issuer describes an external identity provider (IdP) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication.
createTrustedTokenIssuer in interface AWSSSOAdmincreateTrustedTokenIssuerRequest - 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.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.ValidationException - The request failed because it contains a syntax error.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 Amazon Web Services account using a specified permission set.
After a successful response, call DescribeAccountAssignmentDeletionStatus to describe the status of
an assignment deletion request.
deleteAccountAssignment in interface AWSSSOAdmindeleteAccountAssignmentRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
Deletes the association with the application. The connected service resource still exists.
deleteApplication in interface AWSSSOAdmindeleteApplicationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DeleteApplicationAccessScopeResult deleteApplicationAccessScope(DeleteApplicationAccessScopeRequest request)
Deletes an IAM Identity Center access scope from an application.
deleteApplicationAccessScope in interface AWSSSOAdmindeleteApplicationAccessScopeRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DeleteApplicationAssignmentResult deleteApplicationAssignment(DeleteApplicationAssignmentRequest request)
Revoke application access to an application by deleting application assignments for a user or group.
deleteApplicationAssignment in interface AWSSSOAdmindeleteApplicationAssignmentRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DeleteApplicationAuthenticationMethodResult deleteApplicationAuthenticationMethod(DeleteApplicationAuthenticationMethodRequest request)
Deletes an authentication method from an application.
deleteApplicationAuthenticationMethod in interface AWSSSOAdmindeleteApplicationAuthenticationMethodRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DeleteApplicationGrantResult deleteApplicationGrant(DeleteApplicationGrantRequest request)
Deletes a grant from an application.
deleteApplicationGrant in interface AWSSSOAdmindeleteApplicationGrantRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.
deleteInstance in interface AWSSSOAdmindeleteInstanceRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.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.ValidationException - The request failed because it contains a syntax error.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 DeleteInstanceAccessControlAttributeConfigurationResult deleteInstanceAccessControlAttributeConfiguration(DeleteInstanceAccessControlAttributeConfigurationRequest request)
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.
deleteInstanceAccessControlAttributeConfiguration in interface AWSSSOAdmindeleteInstanceAccessControlAttributeConfigurationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DeletePermissionsBoundaryFromPermissionSetResult deletePermissionsBoundaryFromPermissionSet(DeletePermissionsBoundaryFromPermissionSetRequest request)
Deletes the permissions boundary from a specified PermissionSet.
deletePermissionsBoundaryFromPermissionSet in interface AWSSSOAdmindeletePermissionsBoundaryFromPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DeleteTrustedTokenIssuerResult deleteTrustedTokenIssuer(DeleteTrustedTokenIssuerRequest request)
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.
deleteTrustedTokenIssuer in interface AWSSSOAdmindeleteTrustedTokenIssuerRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DescribeAccountAssignmentDeletionStatusResult describeAccountAssignmentDeletionStatus(DescribeAccountAssignmentDeletionStatusRequest request)
Describes the status of the assignment deletion request.
describeAccountAssignmentDeletionStatus in interface AWSSSOAdmindescribeAccountAssignmentDeletionStatusRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)
Retrieves the details of an application associated with an instance of IAM Identity Center.
describeApplication in interface AWSSSOAdmindescribeApplicationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DescribeApplicationAssignmentResult describeApplicationAssignment(DescribeApplicationAssignmentRequest request)
Retrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal.
describeApplicationAssignment in interface AWSSSOAdmindescribeApplicationAssignmentRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DescribeApplicationProviderResult describeApplicationProvider(DescribeApplicationProviderRequest request)
Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.
describeApplicationProvider in interface AWSSSOAdmindescribeApplicationProviderRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DescribeInstanceResult describeInstance(DescribeInstanceRequest request)
Returns the details of an instance of IAM Identity Center. The status can be one of the following:
CREATE_IN_PROGRESS - The instance is in the process of being created. When the instance is ready for
use, DescribeInstance returns the status of ACTIVE. While the instance is in the
CREATE_IN_PROGRESS state, you can call only DescribeInstance and DeleteInstance operations.
DELETE_IN_PROGRESS - The instance is being deleted. Returns AccessDeniedException after
the delete operation completes.
ACTIVE - The instance is active.
describeInstance in interface AWSSSOAdmindescribeInstanceRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.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.ValidationException - The request failed because it contains a syntax error.public DescribeInstanceAccessControlAttributeConfigurationResult describeInstanceAccessControlAttributeConfiguration(DescribeInstanceAccessControlAttributeConfigurationRequest request)
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.
describeInstanceAccessControlAttributeConfiguration in interface AWSSSOAdmindescribeInstanceAccessControlAttributeConfigurationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DescribePermissionSetResult describePermissionSet(DescribePermissionSetRequest request)
Gets the details of the permission set.
describePermissionSet in interface AWSSSOAdmindescribePermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DescribePermissionSetProvisioningStatusResult describePermissionSetProvisioningStatus(DescribePermissionSetProvisioningStatusRequest request)
Describes the status for the given permission set provisioning request.
describePermissionSetProvisioningStatus in interface AWSSSOAdmindescribePermissionSetProvisioningStatusRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DescribeTrustedTokenIssuerResult describeTrustedTokenIssuer(DescribeTrustedTokenIssuerRequest request)
Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.
describeTrustedTokenIssuer in interface AWSSSOAdmindescribeTrustedTokenIssuerRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public DetachCustomerManagedPolicyReferenceFromPermissionSetResult detachCustomerManagedPolicyReferenceFromPermissionSet(DetachCustomerManagedPolicyReferenceFromPermissionSetRequest request)
Detaches the specified customer managed policy from the specified PermissionSet.
detachCustomerManagedPolicyReferenceFromPermissionSet in interface AWSSSOAdmindetachCustomerManagedPolicyReferenceFromPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 DetachManagedPolicyFromPermissionSetResult detachManagedPolicyFromPermissionSet(DetachManagedPolicyFromPermissionSetRequest request)
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
detachManagedPolicyFromPermissionSet in interface AWSSSOAdmindetachManagedPolicyFromPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 GetApplicationAccessScopeResult getApplicationAccessScope(GetApplicationAccessScopeRequest request)
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
getApplicationAccessScope in interface AWSSSOAdmingetApplicationAccessScopeRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public GetApplicationAssignmentConfigurationResult getApplicationAssignmentConfiguration(GetApplicationAssignmentConfigurationRequest request)
Retrieves the configuration of PutApplicationAssignmentConfiguration.
getApplicationAssignmentConfiguration in interface AWSSSOAdmingetApplicationAssignmentConfigurationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public GetApplicationAuthenticationMethodResult getApplicationAuthenticationMethod(GetApplicationAuthenticationMethodRequest request)
Retrieves details about an authentication method used by an application.
getApplicationAuthenticationMethod in interface AWSSSOAdmingetApplicationAuthenticationMethodRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public GetApplicationGrantResult getApplicationGrant(GetApplicationGrantRequest request)
Retrieves details about an application grant.
getApplicationGrant in interface AWSSSOAdmingetApplicationGrantRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public GetInlinePolicyForPermissionSetResult getInlinePolicyForPermissionSet(GetInlinePolicyForPermissionSetRequest request)
Obtains the inline policy assigned to the permission set.
getInlinePolicyForPermissionSet in interface AWSSSOAdmingetInlinePolicyForPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public GetPermissionsBoundaryForPermissionSetResult getPermissionsBoundaryForPermissionSet(GetPermissionsBoundaryForPermissionSetRequest request)
Obtains the permissions boundary for a specified PermissionSet.
getPermissionsBoundaryForPermissionSet in interface AWSSSOAdmingetPermissionsBoundaryForPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListAccountAssignmentCreationStatusResult listAccountAssignmentCreationStatus(ListAccountAssignmentCreationStatusRequest request)
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
listAccountAssignmentCreationStatus in interface AWSSSOAdminlistAccountAssignmentCreationStatusRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListAccountAssignmentDeletionStatusResult listAccountAssignmentDeletionStatus(ListAccountAssignmentDeletionStatusRequest request)
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
listAccountAssignmentDeletionStatus in interface AWSSSOAdminlistAccountAssignmentDeletionStatusRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListAccountAssignmentsResult listAccountAssignments(ListAccountAssignmentsRequest request)
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
listAccountAssignments in interface AWSSSOAdminlistAccountAssignmentsRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListAccountAssignmentsForPrincipalResult listAccountAssignmentsForPrincipal(ListAccountAssignmentsForPrincipalRequest request)
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
listAccountAssignmentsForPrincipal in interface AWSSSOAdminlistAccountAssignmentsForPrincipalRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListAccountsForProvisionedPermissionSetResult listAccountsForProvisionedPermissionSet(ListAccountsForProvisionedPermissionSetRequest request)
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
listAccountsForProvisionedPermissionSet in interface AWSSSOAdminlistAccountsForProvisionedPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListApplicationAccessScopesResult listApplicationAccessScopes(ListApplicationAccessScopesRequest request)
Lists the access scopes and authorized targets associated with an application.
listApplicationAccessScopes in interface AWSSSOAdminlistApplicationAccessScopesRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListApplicationAssignmentsResult listApplicationAssignments(ListApplicationAssignmentsRequest request)
Lists Amazon Web Services account users that are assigned to an application.
listApplicationAssignments in interface AWSSSOAdminlistApplicationAssignmentsRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListApplicationAssignmentsForPrincipalResult listApplicationAssignmentsForPrincipal(ListApplicationAssignmentsForPrincipalRequest request)
Lists the applications to which a specified principal is assigned.
listApplicationAssignmentsForPrincipal in interface AWSSSOAdminlistApplicationAssignmentsForPrincipalRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListApplicationAuthenticationMethodsResult listApplicationAuthenticationMethods(ListApplicationAuthenticationMethodsRequest request)
Lists all of the authentication methods supported by the specified application.
listApplicationAuthenticationMethods in interface AWSSSOAdminlistApplicationAuthenticationMethodsRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListApplicationGrantsResult listApplicationGrants(ListApplicationGrantsRequest request)
List the grants associated with an application.
listApplicationGrants in interface AWSSSOAdminlistApplicationGrantsRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListApplicationProvidersResult listApplicationProviders(ListApplicationProvidersRequest request)
Lists the application providers configured in the IAM Identity Center identity store.
listApplicationProviders in interface AWSSSOAdminlistApplicationProvidersRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.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.ValidationException - The request failed because it contains a syntax error.public ListApplicationsResult listApplications(ListApplicationsRequest request)
Lists all applications associated with the instance of IAM Identity Center. When listing applications for an
instance in the management account, member accounts must use the applicationAccount parameter to
filter the list to only applications created from that account.
listApplications in interface AWSSSOAdminlistApplicationsRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.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.ValidationException - The request failed because it contains a syntax error.public ListCustomerManagedPolicyReferencesInPermissionSetResult listCustomerManagedPolicyReferencesInPermissionSet(ListCustomerManagedPolicyReferencesInPermissionSetRequest request)
Lists all customer managed policies attached to a specified PermissionSet.
listCustomerManagedPolicyReferencesInPermissionSet in interface AWSSSOAdminlistCustomerManagedPolicyReferencesInPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListInstancesResult listInstances(ListInstancesRequest request)
Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.
listInstances in interface AWSSSOAdminlistInstancesRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.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.ValidationException - The request failed because it contains a syntax error.public ListManagedPoliciesInPermissionSetResult listManagedPoliciesInPermissionSet(ListManagedPoliciesInPermissionSetRequest request)
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
listManagedPoliciesInPermissionSet in interface AWSSSOAdminlistManagedPoliciesInPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListPermissionSetProvisioningStatusResult listPermissionSetProvisioningStatus(ListPermissionSetProvisioningStatusRequest request)
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
listPermissionSetProvisioningStatus in interface AWSSSOAdminlistPermissionSetProvisioningStatusRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListPermissionSetsResult listPermissionSets(ListPermissionSetsRequest request)
Lists the PermissionSets in an IAM Identity Center instance.
listPermissionSets in interface AWSSSOAdminlistPermissionSetsRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListPermissionSetsProvisionedToAccountResult listPermissionSetsProvisionedToAccount(ListPermissionSetsProvisionedToAccountRequest request)
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
listPermissionSetsProvisionedToAccount in interface AWSSSOAdminlistPermissionSetsProvisionedToAccountRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags that are attached to a specified resource.
listTagsForResource in interface AWSSSOAdminlistTagsForResourceRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.public ListTrustedTokenIssuersResult listTrustedTokenIssuers(ListTrustedTokenIssuersRequest request)
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
listTrustedTokenIssuers in interface AWSSSOAdminlistTrustedTokenIssuersRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.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.ValidationException - The request failed because it contains a syntax error.public ProvisionPermissionSetResult provisionPermissionSet(ProvisionPermissionSetRequest request)
The process by which a specified permission set is provisioned to the specified target.
provisionPermissionSet in interface AWSSSOAdminprovisionPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 PutApplicationAccessScopeResult putApplicationAccessScope(PutApplicationAccessScopeRequest request)
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
putApplicationAccessScope in interface AWSSSOAdminputApplicationAccessScopeRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 PutApplicationAssignmentConfigurationResult putApplicationAssignmentConfiguration(PutApplicationAssignmentConfigurationRequest request)
Configure how users gain access to an application. If AssignmentsRequired is true
(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application. If an
assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to
true.
putApplicationAssignmentConfiguration in interface AWSSSOAdminputApplicationAssignmentConfigurationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 PutApplicationAuthenticationMethodResult putApplicationAuthenticationMethod(PutApplicationAuthenticationMethodRequest request)
Adds or updates an authentication method for an application.
putApplicationAuthenticationMethod in interface AWSSSOAdminputApplicationAuthenticationMethodRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 PutApplicationGrantResult putApplicationGrant(PutApplicationGrantRequest request)
Adds a grant to an application.
putApplicationGrant in interface AWSSSOAdminputApplicationGrantRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 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 - 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.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 PutPermissionsBoundaryToPermissionSetResult putPermissionsBoundaryToPermissionSet(PutPermissionsBoundaryToPermissionSetRequest request)
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
putPermissionsBoundaryToPermissionSet in interface AWSSSOAdminputPermissionsBoundaryToPermissionSetRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 - 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.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
Updates application properties.
updateApplication in interface AWSSSOAdminupdateApplicationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 UpdateInstanceResult updateInstance(UpdateInstanceRequest request)
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
updateInstance in interface AWSSSOAdminupdateInstanceRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.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.ValidationException - The request failed because it contains a syntax error.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 UpdateInstanceAccessControlAttributeConfigurationResult updateInstanceAccessControlAttributeConfiguration(UpdateInstanceAccessControlAttributeConfigurationRequest request)
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.
updateInstanceAccessControlAttributeConfiguration in interface AWSSSOAdminupdateInstanceAccessControlAttributeConfigurationRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 UpdateTrustedTokenIssuerResult updateTrustedTokenIssuer(UpdateTrustedTokenIssuerRequest request)
Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.
updateTrustedTokenIssuer in interface AWSSSOAdminupdateTrustedTokenIssuerRequest - ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal
server.ResourceNotFoundException - Indicates that a requested resource is not found.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The request failed because it contains a syntax error.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 requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSSSOAdminshutdown in class AmazonWebServiceClient