Interface SsoAdminClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface SsoAdminClient extends AwsClient
Service client for accessing SSO Admin. This can be created using the staticbuilder()method.IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed applications and other Amazon Web Services resources. You can connect your existing identity provider and synchronize users and groups from your directory, or create and manage your users directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:
-
User access to applications
-
User access to Amazon Web Services accounts
This guide provides information about single sign-on operations that you can use for access to applications and Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
IAM Identity Center uses the
ssoandidentitystoreAPI namespaces.Many API operations for IAM Identity Center 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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
attachCustomerManagedPolicyReferenceToPermissionSet
default AttachCustomerManagedPolicyReferenceToPermissionSetResponse attachCustomerManagedPolicyReferenceToPermissionSet(AttachCustomerManagedPolicyReferenceToPermissionSetRequest attachCustomerManagedPolicyReferenceToPermissionSetRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Attaches the specified customer managed policy to the specified PermissionSet.
- Parameters:
attachCustomerManagedPolicyReferenceToPermissionSetRequest-- Returns:
- Result of the AttachCustomerManagedPolicyReferenceToPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
attachCustomerManagedPolicyReferenceToPermissionSet
default AttachCustomerManagedPolicyReferenceToPermissionSetResponse attachCustomerManagedPolicyReferenceToPermissionSet(Consumer<AttachCustomerManagedPolicyReferenceToPermissionSetRequest.Builder> attachCustomerManagedPolicyReferenceToPermissionSetRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Attaches the specified customer managed policy to the specified PermissionSet.
This is a convenience which creates an instance of the
AttachCustomerManagedPolicyReferenceToPermissionSetRequest.Builderavoiding the need to create one manually viaAttachCustomerManagedPolicyReferenceToPermissionSetRequest.builder()- Parameters:
attachCustomerManagedPolicyReferenceToPermissionSetRequest- AConsumerthat will call methods onAttachCustomerManagedPolicyReferenceToPermissionSetRequest.Builderto create a request.- Returns:
- Result of the AttachCustomerManagedPolicyReferenceToPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
attachManagedPolicyToPermissionSet
default AttachManagedPolicyToPermissionSetResponse attachManagedPolicyToPermissionSet(AttachManagedPolicyToPermissionSetRequest attachManagedPolicyToPermissionSetRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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
ProvisionPermissionSetafter this operation. CallingProvisionPermissionSetapplies the corresponding IAM policy updates to all assigned accounts.- Parameters:
attachManagedPolicyToPermissionSetRequest-- Returns:
- Result of the AttachManagedPolicyToPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
attachManagedPolicyToPermissionSet
default AttachManagedPolicyToPermissionSetResponse attachManagedPolicyToPermissionSet(Consumer<AttachManagedPolicyToPermissionSetRequest.Builder> attachManagedPolicyToPermissionSetRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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
ProvisionPermissionSetafter this operation. CallingProvisionPermissionSetapplies the corresponding IAM policy updates to all assigned accounts.
This is a convenience which creates an instance of the
AttachManagedPolicyToPermissionSetRequest.Builderavoiding the need to create one manually viaAttachManagedPolicyToPermissionSetRequest.builder()- Parameters:
attachManagedPolicyToPermissionSetRequest- AConsumerthat will call methods onAttachManagedPolicyToPermissionSetRequest.Builderto create a request.- Returns:
- Result of the AttachManagedPolicyToPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAccountAssignment
default CreateAccountAssignmentResponse createAccountAssignment(CreateAccountAssignmentRequest createAccountAssignmentRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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
CreateAccountAssignmentcall, 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 callProvisionPermissionSetto make these updates.After a successful response, call
DescribeAccountAssignmentCreationStatusto describe the status of an assignment creation request.- Parameters:
createAccountAssignmentRequest-- Returns:
- Result of the CreateAccountAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAccountAssignment
default CreateAccountAssignmentResponse createAccountAssignment(Consumer<CreateAccountAssignmentRequest.Builder> createAccountAssignmentRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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
CreateAccountAssignmentcall, 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 callProvisionPermissionSetto make these updates.After a successful response, call
DescribeAccountAssignmentCreationStatusto describe the status of an assignment creation request.
This is a convenience which creates an instance of the
CreateAccountAssignmentRequest.Builderavoiding the need to create one manually viaCreateAccountAssignmentRequest.builder()- Parameters:
createAccountAssignmentRequest- AConsumerthat will call methods onCreateAccountAssignmentRequest.Builderto create a request.- Returns:
- Result of the CreateAccountAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createApplication
default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.
- Parameters:
createApplicationRequest-- Returns:
- Result of the CreateApplication operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createApplication
default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builderavoiding the need to create one manually viaCreateApplicationRequest.builder()- Parameters:
createApplicationRequest- AConsumerthat will call methods onCreateApplicationRequest.Builderto create a request.- Returns:
- Result of the CreateApplication operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createApplicationAssignment
default CreateApplicationAssignmentResponse createApplicationAssignment(CreateApplicationAssignmentRequest createApplicationAssignmentRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Grant application access to a user or group.
- Parameters:
createApplicationAssignmentRequest-- Returns:
- Result of the CreateApplicationAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createApplicationAssignment
default CreateApplicationAssignmentResponse createApplicationAssignment(Consumer<CreateApplicationAssignmentRequest.Builder> createApplicationAssignmentRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Grant application access to a user or group.
This is a convenience which creates an instance of the
CreateApplicationAssignmentRequest.Builderavoiding the need to create one manually viaCreateApplicationAssignmentRequest.builder()- Parameters:
createApplicationAssignmentRequest- AConsumerthat will call methods onCreateApplicationAssignmentRequest.Builderto create a request.- Returns:
- Result of the CreateApplicationAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createInstance
default CreateInstanceResponse createInstance(CreateInstanceRequest createInstanceRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
createInstanceRequest-- Returns:
- Result of the CreateInstance operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createInstance
default CreateInstanceResponse createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
CreateInstanceRequest.Builderavoiding the need to create one manually viaCreateInstanceRequest.builder()- Parameters:
createInstanceRequest- AConsumerthat will call methods onCreateInstanceRequest.Builderto create a request.- Returns:
- Result of the CreateInstance operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createInstanceAccessControlAttributeConfiguration
default CreateInstanceAccessControlAttributeConfigurationResponse createInstanceAccessControlAttributeConfiguration(CreateInstanceAccessControlAttributeConfigurationRequest createInstanceAccessControlAttributeConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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
DescribeInstanceAccessControlAttributeConfigurationto validate thatInstanceAccessControlAttributeConfigurationwas created.- Parameters:
createInstanceAccessControlAttributeConfigurationRequest-- Returns:
- Result of the CreateInstanceAccessControlAttributeConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createInstanceAccessControlAttributeConfiguration
default CreateInstanceAccessControlAttributeConfigurationResponse createInstanceAccessControlAttributeConfiguration(Consumer<CreateInstanceAccessControlAttributeConfigurationRequest.Builder> createInstanceAccessControlAttributeConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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
DescribeInstanceAccessControlAttributeConfigurationto validate thatInstanceAccessControlAttributeConfigurationwas created.
This is a convenience which creates an instance of the
CreateInstanceAccessControlAttributeConfigurationRequest.Builderavoiding the need to create one manually viaCreateInstanceAccessControlAttributeConfigurationRequest.builder()- Parameters:
createInstanceAccessControlAttributeConfigurationRequest- AConsumerthat will call methods onCreateInstanceAccessControlAttributeConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateInstanceAccessControlAttributeConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPermissionSet
default CreatePermissionSetResponse createPermissionSet(CreatePermissionSetRequest createPermissionSetRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.- Parameters:
createPermissionSetRequest-- Returns:
- Result of the CreatePermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPermissionSet
default CreatePermissionSetResponse createPermissionSet(Consumer<CreatePermissionSetRequest.Builder> createPermissionSetRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
CreatePermissionSetRequest.Builderavoiding the need to create one manually viaCreatePermissionSetRequest.builder()- Parameters:
createPermissionSetRequest- AConsumerthat will call methods onCreatePermissionSetRequest.Builderto create a request.- Returns:
- Result of the CreatePermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createTrustedTokenIssuer
default CreateTrustedTokenIssuerResponse createTrustedTokenIssuer(CreateTrustedTokenIssuerRequest createTrustedTokenIssuerRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
createTrustedTokenIssuerRequest-- Returns:
- Result of the CreateTrustedTokenIssuer operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createTrustedTokenIssuer
default CreateTrustedTokenIssuerResponse createTrustedTokenIssuer(Consumer<CreateTrustedTokenIssuerRequest.Builder> createTrustedTokenIssuerRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
CreateTrustedTokenIssuerRequest.Builderavoiding the need to create one manually viaCreateTrustedTokenIssuerRequest.builder()- Parameters:
createTrustedTokenIssuerRequest- AConsumerthat will call methods onCreateTrustedTokenIssuerRequest.Builderto create a request.- Returns:
- Result of the CreateTrustedTokenIssuer operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccountAssignment
default DeleteAccountAssignmentResponse deleteAccountAssignment(DeleteAccountAssignmentRequest deleteAccountAssignmentRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
After a successful response, call
DescribeAccountAssignmentDeletionStatusto describe the status of an assignment deletion request.- Parameters:
deleteAccountAssignmentRequest-- Returns:
- Result of the DeleteAccountAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccountAssignment
default DeleteAccountAssignmentResponse deleteAccountAssignment(Consumer<DeleteAccountAssignmentRequest.Builder> deleteAccountAssignmentRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
After a successful response, call
DescribeAccountAssignmentDeletionStatusto describe the status of an assignment deletion request.
This is a convenience which creates an instance of the
DeleteAccountAssignmentRequest.Builderavoiding the need to create one manually viaDeleteAccountAssignmentRequest.builder()- Parameters:
deleteAccountAssignmentRequest- AConsumerthat will call methods onDeleteAccountAssignmentRequest.Builderto create a request.- Returns:
- Result of the DeleteAccountAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplication
default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes the association with the application. The connected service resource still exists.
- Parameters:
deleteApplicationRequest-- Returns:
- Result of the DeleteApplication operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplication
default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes the association with the application. The connected service resource still exists.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builderavoiding the need to create one manually viaDeleteApplicationRequest.builder()- Parameters:
deleteApplicationRequest- AConsumerthat will call methods onDeleteApplicationRequest.Builderto create a request.- Returns:
- Result of the DeleteApplication operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplicationAccessScope
default DeleteApplicationAccessScopeResponse deleteApplicationAccessScope(DeleteApplicationAccessScopeRequest deleteApplicationAccessScopeRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes an IAM Identity Center access scope from an application.
- Parameters:
deleteApplicationAccessScopeRequest-- Returns:
- Result of the DeleteApplicationAccessScope operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplicationAccessScope
default DeleteApplicationAccessScopeResponse deleteApplicationAccessScope(Consumer<DeleteApplicationAccessScopeRequest.Builder> deleteApplicationAccessScopeRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes an IAM Identity Center access scope from an application.
This is a convenience which creates an instance of the
DeleteApplicationAccessScopeRequest.Builderavoiding the need to create one manually viaDeleteApplicationAccessScopeRequest.builder()- Parameters:
deleteApplicationAccessScopeRequest- AConsumerthat will call methods onDeleteApplicationAccessScopeRequest.Builderto create a request.- Returns:
- Result of the DeleteApplicationAccessScope operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplicationAssignment
default DeleteApplicationAssignmentResponse deleteApplicationAssignment(DeleteApplicationAssignmentRequest deleteApplicationAssignmentRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Revoke application access to an application by deleting application assignments for a user or group.
- Parameters:
deleteApplicationAssignmentRequest-- Returns:
- Result of the DeleteApplicationAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplicationAssignment
default DeleteApplicationAssignmentResponse deleteApplicationAssignment(Consumer<DeleteApplicationAssignmentRequest.Builder> deleteApplicationAssignmentRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Revoke application access to an application by deleting application assignments for a user or group.
This is a convenience which creates an instance of the
DeleteApplicationAssignmentRequest.Builderavoiding the need to create one manually viaDeleteApplicationAssignmentRequest.builder()- Parameters:
deleteApplicationAssignmentRequest- AConsumerthat will call methods onDeleteApplicationAssignmentRequest.Builderto create a request.- Returns:
- Result of the DeleteApplicationAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplicationAuthenticationMethod
default DeleteApplicationAuthenticationMethodResponse deleteApplicationAuthenticationMethod(DeleteApplicationAuthenticationMethodRequest deleteApplicationAuthenticationMethodRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes an authentication method from an application.
- Parameters:
deleteApplicationAuthenticationMethodRequest-- Returns:
- Result of the DeleteApplicationAuthenticationMethod operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplicationAuthenticationMethod
default DeleteApplicationAuthenticationMethodResponse deleteApplicationAuthenticationMethod(Consumer<DeleteApplicationAuthenticationMethodRequest.Builder> deleteApplicationAuthenticationMethodRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes an authentication method from an application.
This is a convenience which creates an instance of the
DeleteApplicationAuthenticationMethodRequest.Builderavoiding the need to create one manually viaDeleteApplicationAuthenticationMethodRequest.builder()- Parameters:
deleteApplicationAuthenticationMethodRequest- AConsumerthat will call methods onDeleteApplicationAuthenticationMethodRequest.Builderto create a request.- Returns:
- Result of the DeleteApplicationAuthenticationMethod operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplicationGrant
default DeleteApplicationGrantResponse deleteApplicationGrant(DeleteApplicationGrantRequest deleteApplicationGrantRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes a grant from an application.
- Parameters:
deleteApplicationGrantRequest-- Returns:
- Result of the DeleteApplicationGrant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplicationGrant
default DeleteApplicationGrantResponse deleteApplicationGrant(Consumer<DeleteApplicationGrantRequest.Builder> deleteApplicationGrantRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes a grant from an application.
This is a convenience which creates an instance of the
DeleteApplicationGrantRequest.Builderavoiding the need to create one manually viaDeleteApplicationGrantRequest.builder()- Parameters:
deleteApplicationGrantRequest- AConsumerthat will call methods onDeleteApplicationGrantRequest.Builderto create a request.- Returns:
- Result of the DeleteApplicationGrant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInlinePolicyFromPermissionSet
default DeleteInlinePolicyFromPermissionSetResponse deleteInlinePolicyFromPermissionSet(DeleteInlinePolicyFromPermissionSetRequest deleteInlinePolicyFromPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes the inline policy from a specified permission set.
- Parameters:
deleteInlinePolicyFromPermissionSetRequest-- Returns:
- Result of the DeleteInlinePolicyFromPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInlinePolicyFromPermissionSet
default DeleteInlinePolicyFromPermissionSetResponse deleteInlinePolicyFromPermissionSet(Consumer<DeleteInlinePolicyFromPermissionSetRequest.Builder> deleteInlinePolicyFromPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes the inline policy from a specified permission set.
This is a convenience which creates an instance of the
DeleteInlinePolicyFromPermissionSetRequest.Builderavoiding the need to create one manually viaDeleteInlinePolicyFromPermissionSetRequest.builder()- Parameters:
deleteInlinePolicyFromPermissionSetRequest- AConsumerthat will call methods onDeleteInlinePolicyFromPermissionSetRequest.Builderto create a request.- Returns:
- Result of the DeleteInlinePolicyFromPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInstance
default DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
deleteInstanceRequest-- Returns:
- Result of the DeleteInstance operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInstance
default DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
DeleteInstanceRequest.Builderavoiding the need to create one manually viaDeleteInstanceRequest.builder()- Parameters:
deleteInstanceRequest- AConsumerthat will call methods onDeleteInstanceRequest.Builderto create a request.- Returns:
- Result of the DeleteInstance operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInstanceAccessControlAttributeConfiguration
default DeleteInstanceAccessControlAttributeConfigurationResponse deleteInstanceAccessControlAttributeConfiguration(DeleteInstanceAccessControlAttributeConfigurationRequest deleteInstanceAccessControlAttributeConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
deleteInstanceAccessControlAttributeConfigurationRequest-- Returns:
- Result of the DeleteInstanceAccessControlAttributeConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInstanceAccessControlAttributeConfiguration
default DeleteInstanceAccessControlAttributeConfigurationResponse deleteInstanceAccessControlAttributeConfiguration(Consumer<DeleteInstanceAccessControlAttributeConfigurationRequest.Builder> deleteInstanceAccessControlAttributeConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
DeleteInstanceAccessControlAttributeConfigurationRequest.Builderavoiding the need to create one manually viaDeleteInstanceAccessControlAttributeConfigurationRequest.builder()- Parameters:
deleteInstanceAccessControlAttributeConfigurationRequest- AConsumerthat will call methods onDeleteInstanceAccessControlAttributeConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteInstanceAccessControlAttributeConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePermissionSet
default DeletePermissionSetResponse deletePermissionSet(DeletePermissionSetRequest deletePermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes the specified permission set.
- Parameters:
deletePermissionSetRequest-- Returns:
- Result of the DeletePermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePermissionSet
default DeletePermissionSetResponse deletePermissionSet(Consumer<DeletePermissionSetRequest.Builder> deletePermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes the specified permission set.
This is a convenience which creates an instance of the
DeletePermissionSetRequest.Builderavoiding the need to create one manually viaDeletePermissionSetRequest.builder()- Parameters:
deletePermissionSetRequest- AConsumerthat will call methods onDeletePermissionSetRequest.Builderto create a request.- Returns:
- Result of the DeletePermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePermissionsBoundaryFromPermissionSet
default DeletePermissionsBoundaryFromPermissionSetResponse deletePermissionsBoundaryFromPermissionSet(DeletePermissionsBoundaryFromPermissionSetRequest deletePermissionsBoundaryFromPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes the permissions boundary from a specified PermissionSet.
- Parameters:
deletePermissionsBoundaryFromPermissionSetRequest-- Returns:
- Result of the DeletePermissionsBoundaryFromPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePermissionsBoundaryFromPermissionSet
default DeletePermissionsBoundaryFromPermissionSetResponse deletePermissionsBoundaryFromPermissionSet(Consumer<DeletePermissionsBoundaryFromPermissionSetRequest.Builder> deletePermissionsBoundaryFromPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Deletes the permissions boundary from a specified PermissionSet.
This is a convenience which creates an instance of the
DeletePermissionsBoundaryFromPermissionSetRequest.Builderavoiding the need to create one manually viaDeletePermissionsBoundaryFromPermissionSetRequest.builder()- Parameters:
deletePermissionsBoundaryFromPermissionSetRequest- AConsumerthat will call methods onDeletePermissionsBoundaryFromPermissionSetRequest.Builderto create a request.- Returns:
- Result of the DeletePermissionsBoundaryFromPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTrustedTokenIssuer
default DeleteTrustedTokenIssuerResponse deleteTrustedTokenIssuer(DeleteTrustedTokenIssuerRequest deleteTrustedTokenIssuerRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
deleteTrustedTokenIssuerRequest-- Returns:
- Result of the DeleteTrustedTokenIssuer operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTrustedTokenIssuer
default DeleteTrustedTokenIssuerResponse deleteTrustedTokenIssuer(Consumer<DeleteTrustedTokenIssuerRequest.Builder> deleteTrustedTokenIssuerRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
DeleteTrustedTokenIssuerRequest.Builderavoiding the need to create one manually viaDeleteTrustedTokenIssuerRequest.builder()- Parameters:
deleteTrustedTokenIssuerRequest- AConsumerthat will call methods onDeleteTrustedTokenIssuerRequest.Builderto create a request.- Returns:
- Result of the DeleteTrustedTokenIssuer operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountAssignmentCreationStatus
default DescribeAccountAssignmentCreationStatusResponse describeAccountAssignmentCreationStatus(DescribeAccountAssignmentCreationStatusRequest describeAccountAssignmentCreationStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Describes the status of the assignment creation request.
- Parameters:
describeAccountAssignmentCreationStatusRequest-- Returns:
- Result of the DescribeAccountAssignmentCreationStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountAssignmentCreationStatus
default DescribeAccountAssignmentCreationStatusResponse describeAccountAssignmentCreationStatus(Consumer<DescribeAccountAssignmentCreationStatusRequest.Builder> describeAccountAssignmentCreationStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Describes the status of the assignment creation request.
This is a convenience which creates an instance of the
DescribeAccountAssignmentCreationStatusRequest.Builderavoiding the need to create one manually viaDescribeAccountAssignmentCreationStatusRequest.builder()- Parameters:
describeAccountAssignmentCreationStatusRequest- AConsumerthat will call methods onDescribeAccountAssignmentCreationStatusRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountAssignmentCreationStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountAssignmentDeletionStatus
default DescribeAccountAssignmentDeletionStatusResponse describeAccountAssignmentDeletionStatus(DescribeAccountAssignmentDeletionStatusRequest describeAccountAssignmentDeletionStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Describes the status of the assignment deletion request.
- Parameters:
describeAccountAssignmentDeletionStatusRequest-- Returns:
- Result of the DescribeAccountAssignmentDeletionStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountAssignmentDeletionStatus
default DescribeAccountAssignmentDeletionStatusResponse describeAccountAssignmentDeletionStatus(Consumer<DescribeAccountAssignmentDeletionStatusRequest.Builder> describeAccountAssignmentDeletionStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Describes the status of the assignment deletion request.
This is a convenience which creates an instance of the
DescribeAccountAssignmentDeletionStatusRequest.Builderavoiding the need to create one manually viaDescribeAccountAssignmentDeletionStatusRequest.builder()- Parameters:
describeAccountAssignmentDeletionStatusRequest- AConsumerthat will call methods onDescribeAccountAssignmentDeletionStatusRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountAssignmentDeletionStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeApplication
default DescribeApplicationResponse describeApplication(DescribeApplicationRequest describeApplicationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves the details of an application associated with an instance of IAM Identity Center.
- Parameters:
describeApplicationRequest-- Returns:
- Result of the DescribeApplication operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeApplication
default DescribeApplicationResponse describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves the details of an application associated with an instance of IAM Identity Center.
This is a convenience which creates an instance of the
DescribeApplicationRequest.Builderavoiding the need to create one manually viaDescribeApplicationRequest.builder()- Parameters:
describeApplicationRequest- AConsumerthat will call methods onDescribeApplicationRequest.Builderto create a request.- Returns:
- Result of the DescribeApplication operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeApplicationAssignment
default DescribeApplicationAssignmentResponse describeApplicationAssignment(DescribeApplicationAssignmentRequest describeApplicationAssignmentRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
describeApplicationAssignmentRequest-- Returns:
- Result of the DescribeApplicationAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeApplicationAssignment
default DescribeApplicationAssignmentResponse describeApplicationAssignment(Consumer<DescribeApplicationAssignmentRequest.Builder> describeApplicationAssignmentRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
DescribeApplicationAssignmentRequest.Builderavoiding the need to create one manually viaDescribeApplicationAssignmentRequest.builder()- Parameters:
describeApplicationAssignmentRequest- AConsumerthat will call methods onDescribeApplicationAssignmentRequest.Builderto create a request.- Returns:
- Result of the DescribeApplicationAssignment operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeApplicationProvider
default DescribeApplicationProviderResponse describeApplicationProvider(DescribeApplicationProviderRequest describeApplicationProviderRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
describeApplicationProviderRequest-- Returns:
- Result of the DescribeApplicationProvider operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeApplicationProvider
default DescribeApplicationProviderResponse describeApplicationProvider(Consumer<DescribeApplicationProviderRequest.Builder> describeApplicationProviderRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
DescribeApplicationProviderRequest.Builderavoiding the need to create one manually viaDescribeApplicationProviderRequest.builder()- Parameters:
describeApplicationProviderRequest- AConsumerthat will call methods onDescribeApplicationProviderRequest.Builderto create a request.- Returns:
- Result of the DescribeApplicationProvider operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInstance
default DescribeInstanceResponse describeInstance(DescribeInstanceRequest describeInstanceRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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 ofACTIVE. While the instance is in theCREATE_IN_PROGRESSstate, you can call only DescribeInstance and DeleteInstance operations. -
DELETE_IN_PROGRESS- The instance is being deleted. ReturnsAccessDeniedExceptionafter the delete operation completes. -
ACTIVE- The instance is active.
- Parameters:
describeInstanceRequest-- Returns:
- Result of the DescribeInstance operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeInstance
default DescribeInstanceResponse describeInstance(Consumer<DescribeInstanceRequest.Builder> describeInstanceRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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 ofACTIVE. While the instance is in theCREATE_IN_PROGRESSstate, you can call only DescribeInstance and DeleteInstance operations. -
DELETE_IN_PROGRESS- The instance is being deleted. ReturnsAccessDeniedExceptionafter the delete operation completes. -
ACTIVE- The instance is active.
This is a convenience which creates an instance of the
DescribeInstanceRequest.Builderavoiding the need to create one manually viaDescribeInstanceRequest.builder()- Parameters:
describeInstanceRequest- AConsumerthat will call methods onDescribeInstanceRequest.Builderto create a request.- Returns:
- Result of the DescribeInstance operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeInstanceAccessControlAttributeConfiguration
default DescribeInstanceAccessControlAttributeConfigurationResponse describeInstanceAccessControlAttributeConfiguration(DescribeInstanceAccessControlAttributeConfigurationRequest describeInstanceAccessControlAttributeConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
describeInstanceAccessControlAttributeConfigurationRequest-- Returns:
- Result of the DescribeInstanceAccessControlAttributeConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInstanceAccessControlAttributeConfiguration
default DescribeInstanceAccessControlAttributeConfigurationResponse describeInstanceAccessControlAttributeConfiguration(Consumer<DescribeInstanceAccessControlAttributeConfigurationRequest.Builder> describeInstanceAccessControlAttributeConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
DescribeInstanceAccessControlAttributeConfigurationRequest.Builderavoiding the need to create one manually viaDescribeInstanceAccessControlAttributeConfigurationRequest.builder()- Parameters:
describeInstanceAccessControlAttributeConfigurationRequest- AConsumerthat will call methods onDescribeInstanceAccessControlAttributeConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeInstanceAccessControlAttributeConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePermissionSet
default DescribePermissionSetResponse describePermissionSet(DescribePermissionSetRequest describePermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Gets the details of the permission set.
- Parameters:
describePermissionSetRequest-- Returns:
- Result of the DescribePermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePermissionSet
default DescribePermissionSetResponse describePermissionSet(Consumer<DescribePermissionSetRequest.Builder> describePermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Gets the details of the permission set.
This is a convenience which creates an instance of the
DescribePermissionSetRequest.Builderavoiding the need to create one manually viaDescribePermissionSetRequest.builder()- Parameters:
describePermissionSetRequest- AConsumerthat will call methods onDescribePermissionSetRequest.Builderto create a request.- Returns:
- Result of the DescribePermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePermissionSetProvisioningStatus
default DescribePermissionSetProvisioningStatusResponse describePermissionSetProvisioningStatus(DescribePermissionSetProvisioningStatusRequest describePermissionSetProvisioningStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Describes the status for the given permission set provisioning request.
- Parameters:
describePermissionSetProvisioningStatusRequest-- Returns:
- Result of the DescribePermissionSetProvisioningStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePermissionSetProvisioningStatus
default DescribePermissionSetProvisioningStatusResponse describePermissionSetProvisioningStatus(Consumer<DescribePermissionSetProvisioningStatusRequest.Builder> describePermissionSetProvisioningStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Describes the status for the given permission set provisioning request.
This is a convenience which creates an instance of the
DescribePermissionSetProvisioningStatusRequest.Builderavoiding the need to create one manually viaDescribePermissionSetProvisioningStatusRequest.builder()- Parameters:
describePermissionSetProvisioningStatusRequest- AConsumerthat will call methods onDescribePermissionSetProvisioningStatusRequest.Builderto create a request.- Returns:
- Result of the DescribePermissionSetProvisioningStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTrustedTokenIssuer
default DescribeTrustedTokenIssuerResponse describeTrustedTokenIssuer(DescribeTrustedTokenIssuerRequest describeTrustedTokenIssuerRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
describeTrustedTokenIssuerRequest-- Returns:
- Result of the DescribeTrustedTokenIssuer operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTrustedTokenIssuer
default DescribeTrustedTokenIssuerResponse describeTrustedTokenIssuer(Consumer<DescribeTrustedTokenIssuerRequest.Builder> describeTrustedTokenIssuerRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
DescribeTrustedTokenIssuerRequest.Builderavoiding the need to create one manually viaDescribeTrustedTokenIssuerRequest.builder()- Parameters:
describeTrustedTokenIssuerRequest- AConsumerthat will call methods onDescribeTrustedTokenIssuerRequest.Builderto create a request.- Returns:
- Result of the DescribeTrustedTokenIssuer operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachCustomerManagedPolicyReferenceFromPermissionSet
default DetachCustomerManagedPolicyReferenceFromPermissionSetResponse detachCustomerManagedPolicyReferenceFromPermissionSet(DetachCustomerManagedPolicyReferenceFromPermissionSetRequest detachCustomerManagedPolicyReferenceFromPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Detaches the specified customer managed policy from the specified PermissionSet.
- Parameters:
detachCustomerManagedPolicyReferenceFromPermissionSetRequest-- Returns:
- Result of the DetachCustomerManagedPolicyReferenceFromPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachCustomerManagedPolicyReferenceFromPermissionSet
default DetachCustomerManagedPolicyReferenceFromPermissionSetResponse detachCustomerManagedPolicyReferenceFromPermissionSet(Consumer<DetachCustomerManagedPolicyReferenceFromPermissionSetRequest.Builder> detachCustomerManagedPolicyReferenceFromPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Detaches the specified customer managed policy from the specified PermissionSet.
This is a convenience which creates an instance of the
DetachCustomerManagedPolicyReferenceFromPermissionSetRequest.Builderavoiding the need to create one manually viaDetachCustomerManagedPolicyReferenceFromPermissionSetRequest.builder()- Parameters:
detachCustomerManagedPolicyReferenceFromPermissionSetRequest- AConsumerthat will call methods onDetachCustomerManagedPolicyReferenceFromPermissionSetRequest.Builderto create a request.- Returns:
- Result of the DetachCustomerManagedPolicyReferenceFromPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachManagedPolicyFromPermissionSet
default DetachManagedPolicyFromPermissionSetResponse detachManagedPolicyFromPermissionSet(DetachManagedPolicyFromPermissionSetRequest detachManagedPolicyFromPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
- Parameters:
detachManagedPolicyFromPermissionSetRequest-- Returns:
- Result of the DetachManagedPolicyFromPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachManagedPolicyFromPermissionSet
default DetachManagedPolicyFromPermissionSetResponse detachManagedPolicyFromPermissionSet(Consumer<DetachManagedPolicyFromPermissionSetRequest.Builder> detachManagedPolicyFromPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
This is a convenience which creates an instance of the
DetachManagedPolicyFromPermissionSetRequest.Builderavoiding the need to create one manually viaDetachManagedPolicyFromPermissionSetRequest.builder()- Parameters:
detachManagedPolicyFromPermissionSetRequest- AConsumerthat will call methods onDetachManagedPolicyFromPermissionSetRequest.Builderto create a request.- Returns:
- Result of the DetachManagedPolicyFromPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationAccessScope
default GetApplicationAccessScopeResponse getApplicationAccessScope(GetApplicationAccessScopeRequest getApplicationAccessScopeRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
- Parameters:
getApplicationAccessScopeRequest-- Returns:
- Result of the GetApplicationAccessScope operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationAccessScope
default GetApplicationAccessScopeResponse getApplicationAccessScope(Consumer<GetApplicationAccessScopeRequest.Builder> getApplicationAccessScopeRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
This is a convenience which creates an instance of the
GetApplicationAccessScopeRequest.Builderavoiding the need to create one manually viaGetApplicationAccessScopeRequest.builder()- Parameters:
getApplicationAccessScopeRequest- AConsumerthat will call methods onGetApplicationAccessScopeRequest.Builderto create a request.- Returns:
- Result of the GetApplicationAccessScope operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationAssignmentConfiguration
default GetApplicationAssignmentConfigurationResponse getApplicationAssignmentConfiguration(GetApplicationAssignmentConfigurationRequest getApplicationAssignmentConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves the configuration of PutApplicationAssignmentConfiguration.
- Parameters:
getApplicationAssignmentConfigurationRequest-- Returns:
- Result of the GetApplicationAssignmentConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationAssignmentConfiguration
default GetApplicationAssignmentConfigurationResponse getApplicationAssignmentConfiguration(Consumer<GetApplicationAssignmentConfigurationRequest.Builder> getApplicationAssignmentConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves the configuration of PutApplicationAssignmentConfiguration.
This is a convenience which creates an instance of the
GetApplicationAssignmentConfigurationRequest.Builderavoiding the need to create one manually viaGetApplicationAssignmentConfigurationRequest.builder()- Parameters:
getApplicationAssignmentConfigurationRequest- AConsumerthat will call methods onGetApplicationAssignmentConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetApplicationAssignmentConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationAuthenticationMethod
default GetApplicationAuthenticationMethodResponse getApplicationAuthenticationMethod(GetApplicationAuthenticationMethodRequest getApplicationAuthenticationMethodRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves details about an authentication method used by an application.
- Parameters:
getApplicationAuthenticationMethodRequest-- Returns:
- Result of the GetApplicationAuthenticationMethod operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationAuthenticationMethod
default GetApplicationAuthenticationMethodResponse getApplicationAuthenticationMethod(Consumer<GetApplicationAuthenticationMethodRequest.Builder> getApplicationAuthenticationMethodRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves details about an authentication method used by an application.
This is a convenience which creates an instance of the
GetApplicationAuthenticationMethodRequest.Builderavoiding the need to create one manually viaGetApplicationAuthenticationMethodRequest.builder()- Parameters:
getApplicationAuthenticationMethodRequest- AConsumerthat will call methods onGetApplicationAuthenticationMethodRequest.Builderto create a request.- Returns:
- Result of the GetApplicationAuthenticationMethod operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationGrant
default GetApplicationGrantResponse getApplicationGrant(GetApplicationGrantRequest getApplicationGrantRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves details about an application grant.
- Parameters:
getApplicationGrantRequest-- Returns:
- Result of the GetApplicationGrant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationGrant
default GetApplicationGrantResponse getApplicationGrant(Consumer<GetApplicationGrantRequest.Builder> getApplicationGrantRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves details about an application grant.
This is a convenience which creates an instance of the
GetApplicationGrantRequest.Builderavoiding the need to create one manually viaGetApplicationGrantRequest.builder()- Parameters:
getApplicationGrantRequest- AConsumerthat will call methods onGetApplicationGrantRequest.Builderto create a request.- Returns:
- Result of the GetApplicationGrant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationSessionConfiguration
default GetApplicationSessionConfigurationResponse getApplicationSessionConfiguration(GetApplicationSessionConfigurationRequest getApplicationSessionConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves the session configuration for an application in IAM Identity Center.
The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.
- Parameters:
getApplicationSessionConfigurationRequest-- Returns:
- Result of the GetApplicationSessionConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationSessionConfiguration
default GetApplicationSessionConfigurationResponse getApplicationSessionConfiguration(Consumer<GetApplicationSessionConfigurationRequest.Builder> getApplicationSessionConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves the session configuration for an application in IAM Identity Center.
The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.
This is a convenience which creates an instance of the
GetApplicationSessionConfigurationRequest.Builderavoiding the need to create one manually viaGetApplicationSessionConfigurationRequest.builder()- Parameters:
getApplicationSessionConfigurationRequest- AConsumerthat will call methods onGetApplicationSessionConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetApplicationSessionConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getInlinePolicyForPermissionSet
default GetInlinePolicyForPermissionSetResponse getInlinePolicyForPermissionSet(GetInlinePolicyForPermissionSetRequest getInlinePolicyForPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Obtains the inline policy assigned to the permission set.
- Parameters:
getInlinePolicyForPermissionSetRequest-- Returns:
- Result of the GetInlinePolicyForPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getInlinePolicyForPermissionSet
default GetInlinePolicyForPermissionSetResponse getInlinePolicyForPermissionSet(Consumer<GetInlinePolicyForPermissionSetRequest.Builder> getInlinePolicyForPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Obtains the inline policy assigned to the permission set.
This is a convenience which creates an instance of the
GetInlinePolicyForPermissionSetRequest.Builderavoiding the need to create one manually viaGetInlinePolicyForPermissionSetRequest.builder()- Parameters:
getInlinePolicyForPermissionSetRequest- AConsumerthat will call methods onGetInlinePolicyForPermissionSetRequest.Builderto create a request.- Returns:
- Result of the GetInlinePolicyForPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPermissionsBoundaryForPermissionSet
default GetPermissionsBoundaryForPermissionSetResponse getPermissionsBoundaryForPermissionSet(GetPermissionsBoundaryForPermissionSetRequest getPermissionsBoundaryForPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Obtains the permissions boundary for a specified PermissionSet.
- Parameters:
getPermissionsBoundaryForPermissionSetRequest-- Returns:
- Result of the GetPermissionsBoundaryForPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPermissionsBoundaryForPermissionSet
default GetPermissionsBoundaryForPermissionSetResponse getPermissionsBoundaryForPermissionSet(Consumer<GetPermissionsBoundaryForPermissionSetRequest.Builder> getPermissionsBoundaryForPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Obtains the permissions boundary for a specified PermissionSet.
This is a convenience which creates an instance of the
GetPermissionsBoundaryForPermissionSetRequest.Builderavoiding the need to create one manually viaGetPermissionsBoundaryForPermissionSetRequest.builder()- Parameters:
getPermissionsBoundaryForPermissionSetRequest- AConsumerthat will call methods onGetPermissionsBoundaryForPermissionSetRequest.Builderto create a request.- Returns:
- Result of the GetPermissionsBoundaryForPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentCreationStatus
default ListAccountAssignmentCreationStatusResponse listAccountAssignmentCreationStatus(ListAccountAssignmentCreationStatusRequest listAccountAssignmentCreationStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
- Parameters:
listAccountAssignmentCreationStatusRequest-- Returns:
- Result of the ListAccountAssignmentCreationStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentCreationStatus
default ListAccountAssignmentCreationStatusResponse listAccountAssignmentCreationStatus(Consumer<ListAccountAssignmentCreationStatusRequest.Builder> listAccountAssignmentCreationStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
This is a convenience which creates an instance of the
ListAccountAssignmentCreationStatusRequest.Builderavoiding the need to create one manually viaListAccountAssignmentCreationStatusRequest.builder()- Parameters:
listAccountAssignmentCreationStatusRequest- AConsumerthat will call methods onListAccountAssignmentCreationStatusRequest.Builderto create a request.- Returns:
- Result of the ListAccountAssignmentCreationStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentCreationStatusPaginator
default ListAccountAssignmentCreationStatusIterable listAccountAssignmentCreationStatusPaginator(ListAccountAssignmentCreationStatusRequest listAccountAssignmentCreationStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountAssignmentCreationStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusIterable responses = client.listAccountAssignmentCreationStatusPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusIterable responses = client .listAccountAssignmentCreationStatusPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusIterable responses = client.listAccountAssignmentCreationStatusPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAssignmentCreationStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusRequest)operation.- Parameters:
listAccountAssignmentCreationStatusRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentCreationStatusPaginator
default ListAccountAssignmentCreationStatusIterable listAccountAssignmentCreationStatusPaginator(Consumer<ListAccountAssignmentCreationStatusRequest.Builder> listAccountAssignmentCreationStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountAssignmentCreationStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusIterable responses = client.listAccountAssignmentCreationStatusPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusIterable responses = client .listAccountAssignmentCreationStatusPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusIterable responses = client.listAccountAssignmentCreationStatusPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAssignmentCreationStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusRequest)operation.
This is a convenience which creates an instance of the
ListAccountAssignmentCreationStatusRequest.Builderavoiding the need to create one manually viaListAccountAssignmentCreationStatusRequest.builder()- Parameters:
listAccountAssignmentCreationStatusRequest- AConsumerthat will call methods onListAccountAssignmentCreationStatusRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentDeletionStatus
default ListAccountAssignmentDeletionStatusResponse listAccountAssignmentDeletionStatus(ListAccountAssignmentDeletionStatusRequest listAccountAssignmentDeletionStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
- Parameters:
listAccountAssignmentDeletionStatusRequest-- Returns:
- Result of the ListAccountAssignmentDeletionStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentDeletionStatus
default ListAccountAssignmentDeletionStatusResponse listAccountAssignmentDeletionStatus(Consumer<ListAccountAssignmentDeletionStatusRequest.Builder> listAccountAssignmentDeletionStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
This is a convenience which creates an instance of the
ListAccountAssignmentDeletionStatusRequest.Builderavoiding the need to create one manually viaListAccountAssignmentDeletionStatusRequest.builder()- Parameters:
listAccountAssignmentDeletionStatusRequest- AConsumerthat will call methods onListAccountAssignmentDeletionStatusRequest.Builderto create a request.- Returns:
- Result of the ListAccountAssignmentDeletionStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentDeletionStatusPaginator
default ListAccountAssignmentDeletionStatusIterable listAccountAssignmentDeletionStatusPaginator(ListAccountAssignmentDeletionStatusRequest listAccountAssignmentDeletionStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountAssignmentDeletionStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusIterable responses = client.listAccountAssignmentDeletionStatusPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusIterable responses = client .listAccountAssignmentDeletionStatusPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusIterable responses = client.listAccountAssignmentDeletionStatusPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAssignmentDeletionStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusRequest)operation.- Parameters:
listAccountAssignmentDeletionStatusRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentDeletionStatusPaginator
default ListAccountAssignmentDeletionStatusIterable listAccountAssignmentDeletionStatusPaginator(Consumer<ListAccountAssignmentDeletionStatusRequest.Builder> listAccountAssignmentDeletionStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountAssignmentDeletionStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusIterable responses = client.listAccountAssignmentDeletionStatusPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusIterable responses = client .listAccountAssignmentDeletionStatusPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusIterable responses = client.listAccountAssignmentDeletionStatusPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAssignmentDeletionStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusRequest)operation.
This is a convenience which creates an instance of the
ListAccountAssignmentDeletionStatusRequest.Builderavoiding the need to create one manually viaListAccountAssignmentDeletionStatusRequest.builder()- Parameters:
listAccountAssignmentDeletionStatusRequest- AConsumerthat will call methods onListAccountAssignmentDeletionStatusRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignments
default ListAccountAssignmentsResponse listAccountAssignments(ListAccountAssignmentsRequest listAccountAssignmentsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
- Parameters:
listAccountAssignmentsRequest-- Returns:
- Result of the ListAccountAssignments operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignments
default ListAccountAssignmentsResponse listAccountAssignments(Consumer<ListAccountAssignmentsRequest.Builder> listAccountAssignmentsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
This is a convenience which creates an instance of the
ListAccountAssignmentsRequest.Builderavoiding the need to create one manually viaListAccountAssignmentsRequest.builder()- Parameters:
listAccountAssignmentsRequest- AConsumerthat will call methods onListAccountAssignmentsRequest.Builderto create a request.- Returns:
- Result of the ListAccountAssignments operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentsPaginator
default ListAccountAssignmentsIterable listAccountAssignmentsPaginator(ListAccountAssignmentsRequest listAccountAssignmentsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountAssignments(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsIterable responses = client.listAccountAssignmentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsIterable responses = client .listAccountAssignmentsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsIterable responses = client.listAccountAssignmentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAssignments(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsRequest)operation.- Parameters:
listAccountAssignmentsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentsPaginator
default ListAccountAssignmentsIterable listAccountAssignmentsPaginator(Consumer<ListAccountAssignmentsRequest.Builder> listAccountAssignmentsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountAssignments(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsIterable responses = client.listAccountAssignmentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsIterable responses = client .listAccountAssignmentsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsIterable responses = client.listAccountAssignmentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAssignments(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsRequest)operation.
This is a convenience which creates an instance of the
ListAccountAssignmentsRequest.Builderavoiding the need to create one manually viaListAccountAssignmentsRequest.builder()- Parameters:
listAccountAssignmentsRequest- AConsumerthat will call methods onListAccountAssignmentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentsForPrincipal
default ListAccountAssignmentsForPrincipalResponse listAccountAssignmentsForPrincipal(ListAccountAssignmentsForPrincipalRequest listAccountAssignmentsForPrincipalRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.
- Parameters:
listAccountAssignmentsForPrincipalRequest-- Returns:
- Result of the ListAccountAssignmentsForPrincipal operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentsForPrincipal
default ListAccountAssignmentsForPrincipalResponse listAccountAssignmentsForPrincipal(Consumer<ListAccountAssignmentsForPrincipalRequest.Builder> listAccountAssignmentsForPrincipalRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.
This is a convenience which creates an instance of the
ListAccountAssignmentsForPrincipalRequest.Builderavoiding the need to create one manually viaListAccountAssignmentsForPrincipalRequest.builder()- Parameters:
listAccountAssignmentsForPrincipalRequest- AConsumerthat will call methods onListAccountAssignmentsForPrincipalRequest.Builderto create a request.- Returns:
- Result of the ListAccountAssignmentsForPrincipal operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentsForPrincipalPaginator
default ListAccountAssignmentsForPrincipalIterable listAccountAssignmentsForPrincipalPaginator(ListAccountAssignmentsForPrincipalRequest listAccountAssignmentsForPrincipalRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalIterable responses = client.listAccountAssignmentsForPrincipalPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalIterable responses = client .listAccountAssignmentsForPrincipalPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalIterable responses = client.listAccountAssignmentsForPrincipalPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalRequest)operation.- Parameters:
listAccountAssignmentsForPrincipalRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountAssignmentsForPrincipalPaginator
default ListAccountAssignmentsForPrincipalIterable listAccountAssignmentsForPrincipalPaginator(Consumer<ListAccountAssignmentsForPrincipalRequest.Builder> listAccountAssignmentsForPrincipalRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalIterable responses = client.listAccountAssignmentsForPrincipalPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalIterable responses = client .listAccountAssignmentsForPrincipalPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalIterable responses = client.listAccountAssignmentsForPrincipalPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalRequest)operation.
This is a convenience which creates an instance of the
ListAccountAssignmentsForPrincipalRequest.Builderavoiding the need to create one manually viaListAccountAssignmentsForPrincipalRequest.builder()- Parameters:
listAccountAssignmentsForPrincipalRequest- AConsumerthat will call methods onListAccountAssignmentsForPrincipalRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountsForProvisionedPermissionSet
default ListAccountsForProvisionedPermissionSetResponse listAccountsForProvisionedPermissionSet(ListAccountsForProvisionedPermissionSetRequest listAccountsForProvisionedPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
- Parameters:
listAccountsForProvisionedPermissionSetRequest-- Returns:
- Result of the ListAccountsForProvisionedPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountsForProvisionedPermissionSet
default ListAccountsForProvisionedPermissionSetResponse listAccountsForProvisionedPermissionSet(Consumer<ListAccountsForProvisionedPermissionSetRequest.Builder> listAccountsForProvisionedPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
This is a convenience which creates an instance of the
ListAccountsForProvisionedPermissionSetRequest.Builderavoiding the need to create one manually viaListAccountsForProvisionedPermissionSetRequest.builder()- Parameters:
listAccountsForProvisionedPermissionSetRequest- AConsumerthat will call methods onListAccountsForProvisionedPermissionSetRequest.Builderto create a request.- Returns:
- Result of the ListAccountsForProvisionedPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountsForProvisionedPermissionSetPaginator
default ListAccountsForProvisionedPermissionSetIterable listAccountsForProvisionedPermissionSetPaginator(ListAccountsForProvisionedPermissionSetRequest listAccountsForProvisionedPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountsForProvisionedPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetIterable responses = client.listAccountsForProvisionedPermissionSetPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetIterable responses = client .listAccountsForProvisionedPermissionSetPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetIterable responses = client.listAccountsForProvisionedPermissionSetPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountsForProvisionedPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetRequest)operation.- Parameters:
listAccountsForProvisionedPermissionSetRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccountsForProvisionedPermissionSetPaginator
default ListAccountsForProvisionedPermissionSetIterable listAccountsForProvisionedPermissionSetPaginator(Consumer<ListAccountsForProvisionedPermissionSetRequest.Builder> listAccountsForProvisionedPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listAccountsForProvisionedPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetIterable responses = client.listAccountsForProvisionedPermissionSetPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetIterable responses = client .listAccountsForProvisionedPermissionSetPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetIterable responses = client.listAccountsForProvisionedPermissionSetPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountsForProvisionedPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetRequest)operation.
This is a convenience which creates an instance of the
ListAccountsForProvisionedPermissionSetRequest.Builderavoiding the need to create one manually viaListAccountsForProvisionedPermissionSetRequest.builder()- Parameters:
listAccountsForProvisionedPermissionSetRequest- AConsumerthat will call methods onListAccountsForProvisionedPermissionSetRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAccessScopes
default ListApplicationAccessScopesResponse listApplicationAccessScopes(ListApplicationAccessScopesRequest listApplicationAccessScopesRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the access scopes and authorized targets associated with an application.
- Parameters:
listApplicationAccessScopesRequest-- Returns:
- Result of the ListApplicationAccessScopes operation returned by the service.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAccessScopes
default ListApplicationAccessScopesResponse listApplicationAccessScopes(Consumer<ListApplicationAccessScopesRequest.Builder> listApplicationAccessScopesRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the access scopes and authorized targets associated with an application.
This is a convenience which creates an instance of the
ListApplicationAccessScopesRequest.Builderavoiding the need to create one manually viaListApplicationAccessScopesRequest.builder()- Parameters:
listApplicationAccessScopesRequest- AConsumerthat will call methods onListApplicationAccessScopesRequest.Builderto create a request.- Returns:
- Result of the ListApplicationAccessScopes operation returned by the service.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAccessScopesPaginator
default ListApplicationAccessScopesIterable listApplicationAccessScopesPaginator(ListApplicationAccessScopesRequest listApplicationAccessScopesRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationAccessScopes(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesIterable responses = client.listApplicationAccessScopesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesIterable responses = client .listApplicationAccessScopesPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesIterable responses = client.listApplicationAccessScopesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationAccessScopes(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesRequest)operation.- Parameters:
listApplicationAccessScopesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAccessScopesPaginator
default ListApplicationAccessScopesIterable listApplicationAccessScopesPaginator(Consumer<ListApplicationAccessScopesRequest.Builder> listApplicationAccessScopesRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationAccessScopes(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesIterable responses = client.listApplicationAccessScopesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesIterable responses = client .listApplicationAccessScopesPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesIterable responses = client.listApplicationAccessScopesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationAccessScopes(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesRequest)operation.
This is a convenience which creates an instance of the
ListApplicationAccessScopesRequest.Builderavoiding the need to create one manually viaListApplicationAccessScopesRequest.builder()- Parameters:
listApplicationAccessScopesRequest- AConsumerthat will call methods onListApplicationAccessScopesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAssignments
default ListApplicationAssignmentsResponse listApplicationAssignments(ListApplicationAssignmentsRequest listApplicationAssignmentsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists Amazon Web Services account users that are assigned to an application.
- Parameters:
listApplicationAssignmentsRequest-- Returns:
- Result of the ListApplicationAssignments operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAssignments
default ListApplicationAssignmentsResponse listApplicationAssignments(Consumer<ListApplicationAssignmentsRequest.Builder> listApplicationAssignmentsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists Amazon Web Services account users that are assigned to an application.
This is a convenience which creates an instance of the
ListApplicationAssignmentsRequest.Builderavoiding the need to create one manually viaListApplicationAssignmentsRequest.builder()- Parameters:
listApplicationAssignmentsRequest- AConsumerthat will call methods onListApplicationAssignmentsRequest.Builderto create a request.- Returns:
- Result of the ListApplicationAssignments operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAssignmentsPaginator
default ListApplicationAssignmentsIterable listApplicationAssignmentsPaginator(ListApplicationAssignmentsRequest listApplicationAssignmentsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationAssignments(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsIterable responses = client.listApplicationAssignmentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsIterable responses = client .listApplicationAssignmentsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsIterable responses = client.listApplicationAssignmentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationAssignments(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsRequest)operation.- Parameters:
listApplicationAssignmentsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAssignmentsPaginator
default ListApplicationAssignmentsIterable listApplicationAssignmentsPaginator(Consumer<ListApplicationAssignmentsRequest.Builder> listApplicationAssignmentsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationAssignments(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsIterable responses = client.listApplicationAssignmentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsIterable responses = client .listApplicationAssignmentsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsIterable responses = client.listApplicationAssignmentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationAssignments(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsRequest)operation.
This is a convenience which creates an instance of the
ListApplicationAssignmentsRequest.Builderavoiding the need to create one manually viaListApplicationAssignmentsRequest.builder()- Parameters:
listApplicationAssignmentsRequest- AConsumerthat will call methods onListApplicationAssignmentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAssignmentsForPrincipal
default ListApplicationAssignmentsForPrincipalResponse listApplicationAssignmentsForPrincipal(ListApplicationAssignmentsForPrincipalRequest listApplicationAssignmentsForPrincipalRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.
- Parameters:
listApplicationAssignmentsForPrincipalRequest-- Returns:
- Result of the ListApplicationAssignmentsForPrincipal operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAssignmentsForPrincipal
default ListApplicationAssignmentsForPrincipalResponse listApplicationAssignmentsForPrincipal(Consumer<ListApplicationAssignmentsForPrincipalRequest.Builder> listApplicationAssignmentsForPrincipalRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.
This is a convenience which creates an instance of the
ListApplicationAssignmentsForPrincipalRequest.Builderavoiding the need to create one manually viaListApplicationAssignmentsForPrincipalRequest.builder()- Parameters:
listApplicationAssignmentsForPrincipalRequest- AConsumerthat will call methods onListApplicationAssignmentsForPrincipalRequest.Builderto create a request.- Returns:
- Result of the ListApplicationAssignmentsForPrincipal operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAssignmentsForPrincipalPaginator
default ListApplicationAssignmentsForPrincipalIterable listApplicationAssignmentsForPrincipalPaginator(ListApplicationAssignmentsForPrincipalRequest listApplicationAssignmentsForPrincipalRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalIterable responses = client.listApplicationAssignmentsForPrincipalPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalIterable responses = client .listApplicationAssignmentsForPrincipalPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalIterable responses = client.listApplicationAssignmentsForPrincipalPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalRequest)operation.- Parameters:
listApplicationAssignmentsForPrincipalRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAssignmentsForPrincipalPaginator
default ListApplicationAssignmentsForPrincipalIterable listApplicationAssignmentsForPrincipalPaginator(Consumer<ListApplicationAssignmentsForPrincipalRequest.Builder> listApplicationAssignmentsForPrincipalRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalIterable responses = client.listApplicationAssignmentsForPrincipalPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalIterable responses = client .listApplicationAssignmentsForPrincipalPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalIterable responses = client.listApplicationAssignmentsForPrincipalPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalRequest)operation.
This is a convenience which creates an instance of the
ListApplicationAssignmentsForPrincipalRequest.Builderavoiding the need to create one manually viaListApplicationAssignmentsForPrincipalRequest.builder()- Parameters:
listApplicationAssignmentsForPrincipalRequest- AConsumerthat will call methods onListApplicationAssignmentsForPrincipalRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAuthenticationMethods
default ListApplicationAuthenticationMethodsResponse listApplicationAuthenticationMethods(ListApplicationAuthenticationMethodsRequest listApplicationAuthenticationMethodsRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all of the authentication methods supported by the specified application.
- Parameters:
listApplicationAuthenticationMethodsRequest-- Returns:
- Result of the ListApplicationAuthenticationMethods operation returned by the service.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAuthenticationMethods
default ListApplicationAuthenticationMethodsResponse listApplicationAuthenticationMethods(Consumer<ListApplicationAuthenticationMethodsRequest.Builder> listApplicationAuthenticationMethodsRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all of the authentication methods supported by the specified application.
This is a convenience which creates an instance of the
ListApplicationAuthenticationMethodsRequest.Builderavoiding the need to create one manually viaListApplicationAuthenticationMethodsRequest.builder()- Parameters:
listApplicationAuthenticationMethodsRequest- AConsumerthat will call methods onListApplicationAuthenticationMethodsRequest.Builderto create a request.- Returns:
- Result of the ListApplicationAuthenticationMethods operation returned by the service.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAuthenticationMethodsPaginator
default ListApplicationAuthenticationMethodsIterable listApplicationAuthenticationMethodsPaginator(ListApplicationAuthenticationMethodsRequest listApplicationAuthenticationMethodsRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationAuthenticationMethods(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsIterable responses = client.listApplicationAuthenticationMethodsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsIterable responses = client .listApplicationAuthenticationMethodsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsIterable responses = client.listApplicationAuthenticationMethodsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationAuthenticationMethods(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsRequest)operation.- Parameters:
listApplicationAuthenticationMethodsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationAuthenticationMethodsPaginator
default ListApplicationAuthenticationMethodsIterable listApplicationAuthenticationMethodsPaginator(Consumer<ListApplicationAuthenticationMethodsRequest.Builder> listApplicationAuthenticationMethodsRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationAuthenticationMethods(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsIterable responses = client.listApplicationAuthenticationMethodsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsIterable responses = client .listApplicationAuthenticationMethodsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsIterable responses = client.listApplicationAuthenticationMethodsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationAuthenticationMethods(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsRequest)operation.
This is a convenience which creates an instance of the
ListApplicationAuthenticationMethodsRequest.Builderavoiding the need to create one manually viaListApplicationAuthenticationMethodsRequest.builder()- Parameters:
listApplicationAuthenticationMethodsRequest- AConsumerthat will call methods onListApplicationAuthenticationMethodsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationGrants
default ListApplicationGrantsResponse listApplicationGrants(ListApplicationGrantsRequest listApplicationGrantsRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
List the grants associated with an application.
- Parameters:
listApplicationGrantsRequest-- Returns:
- Result of the ListApplicationGrants operation returned by the service.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationGrants
default ListApplicationGrantsResponse listApplicationGrants(Consumer<ListApplicationGrantsRequest.Builder> listApplicationGrantsRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
List the grants associated with an application.
This is a convenience which creates an instance of the
ListApplicationGrantsRequest.Builderavoiding the need to create one manually viaListApplicationGrantsRequest.builder()- Parameters:
listApplicationGrantsRequest- AConsumerthat will call methods onListApplicationGrantsRequest.Builderto create a request.- Returns:
- Result of the ListApplicationGrants operation returned by the service.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationGrantsPaginator
default ListApplicationGrantsIterable listApplicationGrantsPaginator(ListApplicationGrantsRequest listApplicationGrantsRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationGrants(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsIterable responses = client.listApplicationGrantsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsIterable responses = client .listApplicationGrantsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsIterable responses = client.listApplicationGrantsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationGrants(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsRequest)operation.- Parameters:
listApplicationGrantsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationGrantsPaginator
default ListApplicationGrantsIterable listApplicationGrantsPaginator(Consumer<ListApplicationGrantsRequest.Builder> listApplicationGrantsRequest) throws ThrottlingException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationGrants(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsIterable responses = client.listApplicationGrantsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsIterable responses = client .listApplicationGrantsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsIterable responses = client.listApplicationGrantsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationGrants(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsRequest)operation.
This is a convenience which creates an instance of the
ListApplicationGrantsRequest.Builderavoiding the need to create one manually viaListApplicationGrantsRequest.builder()- Parameters:
listApplicationGrantsRequest- AConsumerthat will call methods onListApplicationGrantsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Indicates that the principal has crossed the throttling limits of the API operations.ResourceNotFoundException- Indicates that a requested resource is not found.InternalServerException- The request processing has failed because of an unknown error, exception, or failure with an internal server.AccessDeniedException- You do not have sufficient access to perform this action.ValidationException- The request failed because it contains a syntax error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationProviders
default ListApplicationProvidersResponse listApplicationProviders(ListApplicationProvidersRequest listApplicationProvidersRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the application providers configured in the IAM Identity Center identity store.
- Parameters:
listApplicationProvidersRequest-- Returns:
- Result of the ListApplicationProviders operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationProviders
default ListApplicationProvidersResponse listApplicationProviders(Consumer<ListApplicationProvidersRequest.Builder> listApplicationProvidersRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the application providers configured in the IAM Identity Center identity store.
This is a convenience which creates an instance of the
ListApplicationProvidersRequest.Builderavoiding the need to create one manually viaListApplicationProvidersRequest.builder()- Parameters:
listApplicationProvidersRequest- AConsumerthat will call methods onListApplicationProvidersRequest.Builderto create a request.- Returns:
- Result of the ListApplicationProviders operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationProvidersPaginator
default ListApplicationProvidersIterable listApplicationProvidersPaginator(ListApplicationProvidersRequest listApplicationProvidersRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationProviders(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersIterable responses = client.listApplicationProvidersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersIterable responses = client .listApplicationProvidersPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersIterable responses = client.listApplicationProvidersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationProviders(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersRequest)operation.- Parameters:
listApplicationProvidersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationProvidersPaginator
default ListApplicationProvidersIterable listApplicationProvidersPaginator(Consumer<ListApplicationProvidersRequest.Builder> listApplicationProvidersRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplicationProviders(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersIterable responses = client.listApplicationProvidersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersIterable responses = client .listApplicationProvidersPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersIterable responses = client.listApplicationProvidersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationProviders(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersRequest)operation.
This is a convenience which creates an instance of the
ListApplicationProvidersRequest.Builderavoiding the need to create one manually viaListApplicationProvidersRequest.builder()- Parameters:
listApplicationProvidersRequest- AConsumerthat will call methods onListApplicationProvidersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the
applicationAccountparameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.- Parameters:
listApplicationsRequest-- Returns:
- Result of the ListApplications operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the
applicationAccountparameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- Returns:
- Result of the ListApplications operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplications(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsRequest)operation.- Parameters:
listApplicationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listApplications(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsRequest)operation.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCustomerManagedPolicyReferencesInPermissionSet
default ListCustomerManagedPolicyReferencesInPermissionSetResponse listCustomerManagedPolicyReferencesInPermissionSet(ListCustomerManagedPolicyReferencesInPermissionSetRequest listCustomerManagedPolicyReferencesInPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all customer managed policies attached to a specified PermissionSet.
- Parameters:
listCustomerManagedPolicyReferencesInPermissionSetRequest-- Returns:
- Result of the ListCustomerManagedPolicyReferencesInPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCustomerManagedPolicyReferencesInPermissionSet
default ListCustomerManagedPolicyReferencesInPermissionSetResponse listCustomerManagedPolicyReferencesInPermissionSet(Consumer<ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder> listCustomerManagedPolicyReferencesInPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all customer managed policies attached to a specified PermissionSet.
This is a convenience which creates an instance of the
ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builderavoiding the need to create one manually viaListCustomerManagedPolicyReferencesInPermissionSetRequest.builder()- Parameters:
listCustomerManagedPolicyReferencesInPermissionSetRequest- AConsumerthat will call methods onListCustomerManagedPolicyReferencesInPermissionSetRequest.Builderto create a request.- Returns:
- Result of the ListCustomerManagedPolicyReferencesInPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCustomerManagedPolicyReferencesInPermissionSetPaginator
default ListCustomerManagedPolicyReferencesInPermissionSetIterable listCustomerManagedPolicyReferencesInPermissionSetPaginator(ListCustomerManagedPolicyReferencesInPermissionSetRequest listCustomerManagedPolicyReferencesInPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listCustomerManagedPolicyReferencesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetIterable responses = client.listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetIterable responses = client .listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetIterable responses = client.listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomerManagedPolicyReferencesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetRequest)operation.- Parameters:
listCustomerManagedPolicyReferencesInPermissionSetRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCustomerManagedPolicyReferencesInPermissionSetPaginator
default ListCustomerManagedPolicyReferencesInPermissionSetIterable listCustomerManagedPolicyReferencesInPermissionSetPaginator(Consumer<ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder> listCustomerManagedPolicyReferencesInPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listCustomerManagedPolicyReferencesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetIterable responses = client.listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetIterable responses = client .listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetIterable responses = client.listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomerManagedPolicyReferencesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetRequest)operation.
This is a convenience which creates an instance of the
ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builderavoiding the need to create one manually viaListCustomerManagedPolicyReferencesInPermissionSetRequest.builder()- Parameters:
listCustomerManagedPolicyReferencesInPermissionSetRequest- AConsumerthat will call methods onListCustomerManagedPolicyReferencesInPermissionSetRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listInstances
default ListInstancesResponse listInstances(ListInstancesRequest listInstancesRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
listInstancesRequest-- Returns:
- Result of the ListInstances operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listInstances
default ListInstancesResponse listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
ListInstancesRequest.Builderavoiding the need to create one manually viaListInstancesRequest.builder()- Parameters:
listInstancesRequest- AConsumerthat will call methods onListInstancesRequest.Builderto create a request.- Returns:
- Result of the ListInstances operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listInstancesPaginator
default ListInstancesIterable listInstancesPaginator(ListInstancesRequest listInstancesRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listInstances(software.amazon.awssdk.services.ssoadmin.model.ListInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstances(software.amazon.awssdk.services.ssoadmin.model.ListInstancesRequest)operation.- Parameters:
listInstancesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listInstancesPaginator
default ListInstancesIterable listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listInstances(software.amazon.awssdk.services.ssoadmin.model.ListInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstances(software.amazon.awssdk.services.ssoadmin.model.ListInstancesRequest)operation.
This is a convenience which creates an instance of the
ListInstancesRequest.Builderavoiding the need to create one manually viaListInstancesRequest.builder()- Parameters:
listInstancesRequest- AConsumerthat will call methods onListInstancesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listManagedPoliciesInPermissionSet
default ListManagedPoliciesInPermissionSetResponse listManagedPoliciesInPermissionSet(ListManagedPoliciesInPermissionSetRequest listManagedPoliciesInPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
- Parameters:
listManagedPoliciesInPermissionSetRequest-- Returns:
- Result of the ListManagedPoliciesInPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listManagedPoliciesInPermissionSet
default ListManagedPoliciesInPermissionSetResponse listManagedPoliciesInPermissionSet(Consumer<ListManagedPoliciesInPermissionSetRequest.Builder> listManagedPoliciesInPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
This is a convenience which creates an instance of the
ListManagedPoliciesInPermissionSetRequest.Builderavoiding the need to create one manually viaListManagedPoliciesInPermissionSetRequest.builder()- Parameters:
listManagedPoliciesInPermissionSetRequest- AConsumerthat will call methods onListManagedPoliciesInPermissionSetRequest.Builderto create a request.- Returns:
- Result of the ListManagedPoliciesInPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listManagedPoliciesInPermissionSetPaginator
default ListManagedPoliciesInPermissionSetIterable listManagedPoliciesInPermissionSetPaginator(ListManagedPoliciesInPermissionSetRequest listManagedPoliciesInPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listManagedPoliciesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetIterable responses = client.listManagedPoliciesInPermissionSetPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetIterable responses = client .listManagedPoliciesInPermissionSetPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetIterable responses = client.listManagedPoliciesInPermissionSetPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedPoliciesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetRequest)operation.- Parameters:
listManagedPoliciesInPermissionSetRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listManagedPoliciesInPermissionSetPaginator
default ListManagedPoliciesInPermissionSetIterable listManagedPoliciesInPermissionSetPaginator(Consumer<ListManagedPoliciesInPermissionSetRequest.Builder> listManagedPoliciesInPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listManagedPoliciesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetIterable responses = client.listManagedPoliciesInPermissionSetPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetIterable responses = client .listManagedPoliciesInPermissionSetPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetIterable responses = client.listManagedPoliciesInPermissionSetPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedPoliciesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetRequest)operation.
This is a convenience which creates an instance of the
ListManagedPoliciesInPermissionSetRequest.Builderavoiding the need to create one manually viaListManagedPoliciesInPermissionSetRequest.builder()- Parameters:
listManagedPoliciesInPermissionSetRequest- AConsumerthat will call methods onListManagedPoliciesInPermissionSetRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetProvisioningStatus
default ListPermissionSetProvisioningStatusResponse listPermissionSetProvisioningStatus(ListPermissionSetProvisioningStatusRequest listPermissionSetProvisioningStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
- Parameters:
listPermissionSetProvisioningStatusRequest-- Returns:
- Result of the ListPermissionSetProvisioningStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetProvisioningStatus
default ListPermissionSetProvisioningStatusResponse listPermissionSetProvisioningStatus(Consumer<ListPermissionSetProvisioningStatusRequest.Builder> listPermissionSetProvisioningStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
This is a convenience which creates an instance of the
ListPermissionSetProvisioningStatusRequest.Builderavoiding the need to create one manually viaListPermissionSetProvisioningStatusRequest.builder()- Parameters:
listPermissionSetProvisioningStatusRequest- AConsumerthat will call methods onListPermissionSetProvisioningStatusRequest.Builderto create a request.- Returns:
- Result of the ListPermissionSetProvisioningStatus operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetProvisioningStatusPaginator
default ListPermissionSetProvisioningStatusIterable listPermissionSetProvisioningStatusPaginator(ListPermissionSetProvisioningStatusRequest listPermissionSetProvisioningStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listPermissionSetProvisioningStatus(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusIterable responses = client.listPermissionSetProvisioningStatusPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusIterable responses = client .listPermissionSetProvisioningStatusPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusIterable responses = client.listPermissionSetProvisioningStatusPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionSetProvisioningStatus(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusRequest)operation.- Parameters:
listPermissionSetProvisioningStatusRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetProvisioningStatusPaginator
default ListPermissionSetProvisioningStatusIterable listPermissionSetProvisioningStatusPaginator(Consumer<ListPermissionSetProvisioningStatusRequest.Builder> listPermissionSetProvisioningStatusRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listPermissionSetProvisioningStatus(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusIterable responses = client.listPermissionSetProvisioningStatusPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusIterable responses = client .listPermissionSetProvisioningStatusPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusIterable responses = client.listPermissionSetProvisioningStatusPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionSetProvisioningStatus(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusRequest)operation.
This is a convenience which creates an instance of the
ListPermissionSetProvisioningStatusRequest.Builderavoiding the need to create one manually viaListPermissionSetProvisioningStatusRequest.builder()- Parameters:
listPermissionSetProvisioningStatusRequest- AConsumerthat will call methods onListPermissionSetProvisioningStatusRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSets
default ListPermissionSetsResponse listPermissionSets(ListPermissionSetsRequest listPermissionSetsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the PermissionSets in an IAM Identity Center instance.
- Parameters:
listPermissionSetsRequest-- Returns:
- Result of the ListPermissionSets operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSets
default ListPermissionSetsResponse listPermissionSets(Consumer<ListPermissionSetsRequest.Builder> listPermissionSetsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the PermissionSets in an IAM Identity Center instance.
This is a convenience which creates an instance of the
ListPermissionSetsRequest.Builderavoiding the need to create one manually viaListPermissionSetsRequest.builder()- Parameters:
listPermissionSetsRequest- AConsumerthat will call methods onListPermissionSetsRequest.Builderto create a request.- Returns:
- Result of the ListPermissionSets operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetsPaginator
default ListPermissionSetsIterable listPermissionSetsPaginator(ListPermissionSetsRequest listPermissionSetsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listPermissionSets(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsIterable responses = client.listPermissionSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsIterable responses = client .listPermissionSetsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsIterable responses = client.listPermissionSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionSets(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsRequest)operation.- Parameters:
listPermissionSetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetsPaginator
default ListPermissionSetsIterable listPermissionSetsPaginator(Consumer<ListPermissionSetsRequest.Builder> listPermissionSetsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listPermissionSets(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsIterable responses = client.listPermissionSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsIterable responses = client .listPermissionSetsPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsIterable responses = client.listPermissionSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionSets(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsRequest)operation.
This is a convenience which creates an instance of the
ListPermissionSetsRequest.Builderavoiding the need to create one manually viaListPermissionSetsRequest.builder()- Parameters:
listPermissionSetsRequest- AConsumerthat will call methods onListPermissionSetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetsProvisionedToAccount
default ListPermissionSetsProvisionedToAccountResponse listPermissionSetsProvisionedToAccount(ListPermissionSetsProvisionedToAccountRequest listPermissionSetsProvisionedToAccountRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
- Parameters:
listPermissionSetsProvisionedToAccountRequest-- Returns:
- Result of the ListPermissionSetsProvisionedToAccount operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetsProvisionedToAccount
default ListPermissionSetsProvisionedToAccountResponse listPermissionSetsProvisionedToAccount(Consumer<ListPermissionSetsProvisionedToAccountRequest.Builder> listPermissionSetsProvisionedToAccountRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
This is a convenience which creates an instance of the
ListPermissionSetsProvisionedToAccountRequest.Builderavoiding the need to create one manually viaListPermissionSetsProvisionedToAccountRequest.builder()- Parameters:
listPermissionSetsProvisionedToAccountRequest- AConsumerthat will call methods onListPermissionSetsProvisionedToAccountRequest.Builderto create a request.- Returns:
- Result of the ListPermissionSetsProvisionedToAccount operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetsProvisionedToAccountPaginator
default ListPermissionSetsProvisionedToAccountIterable listPermissionSetsProvisionedToAccountPaginator(ListPermissionSetsProvisionedToAccountRequest listPermissionSetsProvisionedToAccountRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listPermissionSetsProvisionedToAccount(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountIterable responses = client.listPermissionSetsProvisionedToAccountPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountIterable responses = client .listPermissionSetsProvisionedToAccountPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountIterable responses = client.listPermissionSetsProvisionedToAccountPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionSetsProvisionedToAccount(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountRequest)operation.- Parameters:
listPermissionSetsProvisionedToAccountRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionSetsProvisionedToAccountPaginator
default ListPermissionSetsProvisionedToAccountIterable listPermissionSetsProvisionedToAccountPaginator(Consumer<ListPermissionSetsProvisionedToAccountRequest.Builder> listPermissionSetsProvisionedToAccountRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listPermissionSetsProvisionedToAccount(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountIterable responses = client.listPermissionSetsProvisionedToAccountPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountIterable responses = client .listPermissionSetsProvisionedToAccountPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountIterable responses = client.listPermissionSetsProvisionedToAccountPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionSetsProvisionedToAccount(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountRequest)operation.
This is a convenience which creates an instance of the
ListPermissionSetsProvisionedToAccountRequest.Builderavoiding the need to create one manually viaListPermissionSetsProvisionedToAccountRequest.builder()- Parameters:
listPermissionSetsProvisionedToAccountRequest- AConsumerthat will call methods onListPermissionSetsProvisionedToAccountRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the tags that are attached to a specified resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists the tags that are attached to a specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceRequest)operation.- Parameters:
listTagsForResourceRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceRequest)operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTrustedTokenIssuers
default ListTrustedTokenIssuersResponse listTrustedTokenIssuers(ListTrustedTokenIssuersRequest listTrustedTokenIssuersRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
- Parameters:
listTrustedTokenIssuersRequest-- Returns:
- Result of the ListTrustedTokenIssuers operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTrustedTokenIssuers
default ListTrustedTokenIssuersResponse listTrustedTokenIssuers(Consumer<ListTrustedTokenIssuersRequest.Builder> listTrustedTokenIssuersRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
This is a convenience which creates an instance of the
ListTrustedTokenIssuersRequest.Builderavoiding the need to create one manually viaListTrustedTokenIssuersRequest.builder()- Parameters:
listTrustedTokenIssuersRequest- AConsumerthat will call methods onListTrustedTokenIssuersRequest.Builderto create a request.- Returns:
- Result of the ListTrustedTokenIssuers operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTrustedTokenIssuersPaginator
default ListTrustedTokenIssuersIterable listTrustedTokenIssuersPaginator(ListTrustedTokenIssuersRequest listTrustedTokenIssuersRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listTrustedTokenIssuers(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersIterable responses = client.listTrustedTokenIssuersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersIterable responses = client .listTrustedTokenIssuersPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersIterable responses = client.listTrustedTokenIssuersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrustedTokenIssuers(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersRequest)operation.- Parameters:
listTrustedTokenIssuersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTrustedTokenIssuersPaginator
default ListTrustedTokenIssuersIterable listTrustedTokenIssuersPaginator(Consumer<ListTrustedTokenIssuersRequest.Builder> listTrustedTokenIssuersRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SsoAdminException
This is a variant of
listTrustedTokenIssuers(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersIterable responses = client.listTrustedTokenIssuersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersIterable responses = client .listTrustedTokenIssuersPaginator(request); for (software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersIterable responses = client.listTrustedTokenIssuersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrustedTokenIssuers(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersRequest)operation.
This is a convenience which creates an instance of the
ListTrustedTokenIssuersRequest.Builderavoiding the need to create one manually viaListTrustedTokenIssuersRequest.builder()- Parameters:
listTrustedTokenIssuersRequest- AConsumerthat will call methods onListTrustedTokenIssuersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
provisionPermissionSet
default ProvisionPermissionSetResponse provisionPermissionSet(ProvisionPermissionSetRequest provisionPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
The process by which a specified permission set is provisioned to the specified target.
- Parameters:
provisionPermissionSetRequest-- Returns:
- Result of the ProvisionPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
provisionPermissionSet
default ProvisionPermissionSetResponse provisionPermissionSet(Consumer<ProvisionPermissionSetRequest.Builder> provisionPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
The process by which a specified permission set is provisioned to the specified target.
This is a convenience which creates an instance of the
ProvisionPermissionSetRequest.Builderavoiding the need to create one manually viaProvisionPermissionSetRequest.builder()- Parameters:
provisionPermissionSetRequest- AConsumerthat will call methods onProvisionPermissionSetRequest.Builderto create a request.- Returns:
- Result of the ProvisionPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putApplicationAccessScope
default PutApplicationAccessScopeResponse putApplicationAccessScope(PutApplicationAccessScopeRequest putApplicationAccessScopeRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
- Parameters:
putApplicationAccessScopeRequest-- Returns:
- Result of the PutApplicationAccessScope operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putApplicationAccessScope
default PutApplicationAccessScopeResponse putApplicationAccessScope(Consumer<PutApplicationAccessScopeRequest.Builder> putApplicationAccessScopeRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
This is a convenience which creates an instance of the
PutApplicationAccessScopeRequest.Builderavoiding the need to create one manually viaPutApplicationAccessScopeRequest.builder()- Parameters:
putApplicationAccessScopeRequest- AConsumerthat will call methods onPutApplicationAccessScopeRequest.Builderto create a request.- Returns:
- Result of the PutApplicationAccessScope operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putApplicationAssignmentConfiguration
default PutApplicationAssignmentConfigurationResponse putApplicationAssignmentConfiguration(PutApplicationAssignmentConfigurationRequest putApplicationAssignmentConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Configure how users gain access to an application. If
AssignmentsRequiredistrue(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. Iffalse, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access ifAssignmentsRequiredis set totrue.- Parameters:
putApplicationAssignmentConfigurationRequest-- Returns:
- Result of the PutApplicationAssignmentConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putApplicationAssignmentConfiguration
default PutApplicationAssignmentConfigurationResponse putApplicationAssignmentConfiguration(Consumer<PutApplicationAssignmentConfigurationRequest.Builder> putApplicationAssignmentConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Configure how users gain access to an application. If
AssignmentsRequiredistrue(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. Iffalse, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access ifAssignmentsRequiredis set totrue.
This is a convenience which creates an instance of the
PutApplicationAssignmentConfigurationRequest.Builderavoiding the need to create one manually viaPutApplicationAssignmentConfigurationRequest.builder()- Parameters:
putApplicationAssignmentConfigurationRequest- AConsumerthat will call methods onPutApplicationAssignmentConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutApplicationAssignmentConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putApplicationAuthenticationMethod
default PutApplicationAuthenticationMethodResponse putApplicationAuthenticationMethod(PutApplicationAuthenticationMethodRequest putApplicationAuthenticationMethodRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Adds or updates an authentication method for an application.
- Parameters:
putApplicationAuthenticationMethodRequest-- Returns:
- Result of the PutApplicationAuthenticationMethod operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putApplicationAuthenticationMethod
default PutApplicationAuthenticationMethodResponse putApplicationAuthenticationMethod(Consumer<PutApplicationAuthenticationMethodRequest.Builder> putApplicationAuthenticationMethodRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Adds or updates an authentication method for an application.
This is a convenience which creates an instance of the
PutApplicationAuthenticationMethodRequest.Builderavoiding the need to create one manually viaPutApplicationAuthenticationMethodRequest.builder()- Parameters:
putApplicationAuthenticationMethodRequest- AConsumerthat will call methods onPutApplicationAuthenticationMethodRequest.Builderto create a request.- Returns:
- Result of the PutApplicationAuthenticationMethod operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putApplicationGrant
default PutApplicationGrantResponse putApplicationGrant(PutApplicationGrantRequest putApplicationGrantRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.
A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges:
-
Requester - The application requesting access to Amazon Web Services resources.
-
Subject - Typically the user that is requesting access to Amazon Web Services resources.
-
Grant - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:
-
AuthorizationCode - Allows an application to request authorization through a series of user-agent redirects.
-
JWT bearer - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479.
-
Refresh token - Enables application to request new access tokens to replace expiring or expired access tokens.
-
Exchange token - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693.
-
-
Authorization server - IAM Identity Center requests tokens.
User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479.
Use cases
-
Connecting to custom applications.
-
Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.
- Parameters:
putApplicationGrantRequest-- Returns:
- Result of the PutApplicationGrant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
putApplicationGrant
default PutApplicationGrantResponse putApplicationGrant(Consumer<PutApplicationGrantRequest.Builder> putApplicationGrantRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.
A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges:
-
Requester - The application requesting access to Amazon Web Services resources.
-
Subject - Typically the user that is requesting access to Amazon Web Services resources.
-
Grant - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:
-
AuthorizationCode - Allows an application to request authorization through a series of user-agent redirects.
-
JWT bearer - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479.
-
Refresh token - Enables application to request new access tokens to replace expiring or expired access tokens.
-
Exchange token - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693.
-
-
Authorization server - IAM Identity Center requests tokens.
User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479.
Use cases
-
Connecting to custom applications.
-
Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.
This is a convenience which creates an instance of the
PutApplicationGrantRequest.Builderavoiding the need to create one manually viaPutApplicationGrantRequest.builder()- Parameters:
putApplicationGrantRequest- AConsumerthat will call methods onPutApplicationGrantRequest.Builderto create a request.- Returns:
- Result of the PutApplicationGrant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
putApplicationSessionConfiguration
default PutApplicationSessionConfigurationResponse putApplicationSessionConfiguration(PutApplicationSessionConfigurationRequest putApplicationSessionConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Updates the session configuration for an application in IAM Identity Center.
The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.
- Parameters:
putApplicationSessionConfigurationRequest-- Returns:
- Result of the PutApplicationSessionConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putApplicationSessionConfiguration
default PutApplicationSessionConfigurationResponse putApplicationSessionConfiguration(Consumer<PutApplicationSessionConfigurationRequest.Builder> putApplicationSessionConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Updates the session configuration for an application in IAM Identity Center.
The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.
This is a convenience which creates an instance of the
PutApplicationSessionConfigurationRequest.Builderavoiding the need to create one manually viaPutApplicationSessionConfigurationRequest.builder()- Parameters:
putApplicationSessionConfigurationRequest- AConsumerthat will call methods onPutApplicationSessionConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutApplicationSessionConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putInlinePolicyToPermissionSet
default PutInlinePolicyToPermissionSetResponse putInlinePolicyToPermissionSet(PutInlinePolicyToPermissionSetRequest putInlinePolicyToPermissionSetRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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
ProvisionPermissionSetafter this action to apply the corresponding IAM policy updates to all assigned accounts.- Parameters:
putInlinePolicyToPermissionSetRequest-- Returns:
- Result of the PutInlinePolicyToPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putInlinePolicyToPermissionSet
default PutInlinePolicyToPermissionSetResponse putInlinePolicyToPermissionSet(Consumer<PutInlinePolicyToPermissionSetRequest.Builder> putInlinePolicyToPermissionSetRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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
ProvisionPermissionSetafter this action to apply the corresponding IAM policy updates to all assigned accounts.
This is a convenience which creates an instance of the
PutInlinePolicyToPermissionSetRequest.Builderavoiding the need to create one manually viaPutInlinePolicyToPermissionSetRequest.builder()- Parameters:
putInlinePolicyToPermissionSetRequest- AConsumerthat will call methods onPutInlinePolicyToPermissionSetRequest.Builderto create a request.- Returns:
- Result of the PutInlinePolicyToPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putPermissionsBoundaryToPermissionSet
default PutPermissionsBoundaryToPermissionSetResponse putPermissionsBoundaryToPermissionSet(PutPermissionsBoundaryToPermissionSetRequest putPermissionsBoundaryToPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
- Parameters:
putPermissionsBoundaryToPermissionSetRequest-- Returns:
- Result of the PutPermissionsBoundaryToPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putPermissionsBoundaryToPermissionSet
default PutPermissionsBoundaryToPermissionSetResponse putPermissionsBoundaryToPermissionSet(Consumer<PutPermissionsBoundaryToPermissionSetRequest.Builder> putPermissionsBoundaryToPermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
This is a convenience which creates an instance of the
PutPermissionsBoundaryToPermissionSetRequest.Builderavoiding the need to create one manually viaPutPermissionsBoundaryToPermissionSetRequest.builder()- Parameters:
putPermissionsBoundaryToPermissionSetRequest- AConsumerthat will call methods onPutPermissionsBoundaryToPermissionSetRequest.Builderto create a request.- Returns:
- Result of the PutPermissionsBoundaryToPermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Associates a set of tags with a specified resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Associates a set of tags with a specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Disassociates a set of tags from a specified resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Disassociates a set of tags from a specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplication
default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Updates application properties.
- Parameters:
updateApplicationRequest-- Returns:
- Result of the UpdateApplication operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplication
default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Updates application properties.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builderavoiding the need to create one manually viaUpdateApplicationRequest.builder()- Parameters:
updateApplicationRequest- AConsumerthat will call methods onUpdateApplicationRequest.Builderto create a request.- Returns:
- Result of the UpdateApplication operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateInstance
default UpdateInstanceResponse updateInstance(UpdateInstanceRequest updateInstanceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
- Parameters:
updateInstanceRequest-- Returns:
- Result of the UpdateInstance operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateInstance
default UpdateInstanceResponse updateInstance(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
This is a convenience which creates an instance of the
UpdateInstanceRequest.Builderavoiding the need to create one manually viaUpdateInstanceRequest.builder()- Parameters:
updateInstanceRequest- AConsumerthat will call methods onUpdateInstanceRequest.Builderto create a request.- Returns:
- Result of the UpdateInstance operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateInstanceAccessControlAttributeConfiguration
default UpdateInstanceAccessControlAttributeConfigurationResponse updateInstanceAccessControlAttributeConfiguration(UpdateInstanceAccessControlAttributeConfigurationRequest updateInstanceAccessControlAttributeConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
updateInstanceAccessControlAttributeConfigurationRequest-- Returns:
- Result of the UpdateInstanceAccessControlAttributeConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateInstanceAccessControlAttributeConfiguration
default UpdateInstanceAccessControlAttributeConfigurationResponse updateInstanceAccessControlAttributeConfiguration(Consumer<UpdateInstanceAccessControlAttributeConfigurationRequest.Builder> updateInstanceAccessControlAttributeConfigurationRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
UpdateInstanceAccessControlAttributeConfigurationRequest.Builderavoiding the need to create one manually viaUpdateInstanceAccessControlAttributeConfigurationRequest.builder()- Parameters:
updateInstanceAccessControlAttributeConfigurationRequest- AConsumerthat will call methods onUpdateInstanceAccessControlAttributeConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateInstanceAccessControlAttributeConfiguration operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePermissionSet
default UpdatePermissionSetResponse updatePermissionSet(UpdatePermissionSetRequest updatePermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Updates an existing permission set.
- Parameters:
updatePermissionSetRequest-- Returns:
- Result of the UpdatePermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePermissionSet
default UpdatePermissionSetResponse updatePermissionSet(Consumer<UpdatePermissionSetRequest.Builder> updatePermissionSetRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
Updates an existing permission set.
This is a convenience which creates an instance of the
UpdatePermissionSetRequest.Builderavoiding the need to create one manually viaUpdatePermissionSetRequest.builder()- Parameters:
updatePermissionSetRequest- AConsumerthat will call methods onUpdatePermissionSetRequest.Builderto create a request.- Returns:
- Result of the UpdatePermissionSet operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateTrustedTokenIssuer
default UpdateTrustedTokenIssuerResponse updateTrustedTokenIssuer(UpdateTrustedTokenIssuerRequest updateTrustedTokenIssuerRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
- Parameters:
updateTrustedTokenIssuerRequest-- Returns:
- Result of the UpdateTrustedTokenIssuer operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateTrustedTokenIssuer
default UpdateTrustedTokenIssuerResponse updateTrustedTokenIssuer(Consumer<UpdateTrustedTokenIssuerRequest.Builder> updateTrustedTokenIssuerRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsoAdminException
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.
This is a convenience which creates an instance of the
UpdateTrustedTokenIssuerRequest.Builderavoiding the need to create one manually viaUpdateTrustedTokenIssuerRequest.builder()- Parameters:
updateTrustedTokenIssuerRequest- AConsumerthat will call methods onUpdateTrustedTokenIssuerRequest.Builderto create a request.- Returns:
- Result of the UpdateTrustedTokenIssuer operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsoAdminException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static SsoAdminClient create()
Create aSsoAdminClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SsoAdminClientBuilder builder()
Create a builder that can be used to configure and create aSsoAdminClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SsoAdminServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-