Interface SsoAdminAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size and type.
IAM Identity Center uses the sso
and identitystore
API namespaces.
This reference guide provides information on single sign-on operations which could be used for access management of Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionattachCustomerManagedPolicyReferenceToPermissionSet
(Consumer<AttachCustomerManagedPolicyReferenceToPermissionSetRequest.Builder> attachCustomerManagedPolicyReferenceToPermissionSetRequest) Attaches the specified customer managed policy to the specified PermissionSet.attachCustomerManagedPolicyReferenceToPermissionSet
(AttachCustomerManagedPolicyReferenceToPermissionSetRequest attachCustomerManagedPolicyReferenceToPermissionSetRequest) Attaches the specified customer managed policy to the specified PermissionSet.attachManagedPolicyToPermissionSet
(Consumer<AttachManagedPolicyToPermissionSetRequest.Builder> attachManagedPolicyToPermissionSetRequest) Attaches an Amazon Web Services managed policy ARN to a permission set.attachManagedPolicyToPermissionSet
(AttachManagedPolicyToPermissionSetRequest attachManagedPolicyToPermissionSetRequest) Attaches an Amazon Web Services managed policy ARN to a permission set.static SsoAdminAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aSsoAdminAsyncClient
.static SsoAdminAsyncClient
create()
Create aSsoAdminAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAccountAssignment
(Consumer<CreateAccountAssignmentRequest.Builder> createAccountAssignmentRequest) Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.createAccountAssignment
(CreateAccountAssignmentRequest createAccountAssignmentRequest) Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application in IAM Identity Center for the given application provider.createApplication
(CreateApplicationRequest createApplicationRequest) Creates an application in IAM Identity Center for the given application provider.createApplicationAssignment
(Consumer<CreateApplicationAssignmentRequest.Builder> createApplicationAssignmentRequest) Grant application access to a user or group.createApplicationAssignment
(CreateApplicationAssignmentRequest createApplicationAssignmentRequest) Grant application access to a user or group.default CompletableFuture
<CreateInstanceResponse> createInstance
(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) 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.default CompletableFuture
<CreateInstanceResponse> createInstance
(CreateInstanceRequest createInstanceRequest) 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.createInstanceAccessControlAttributeConfiguration
(Consumer<CreateInstanceAccessControlAttributeConfigurationRequest.Builder> createInstanceAccessControlAttributeConfigurationRequest) Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance.createInstanceAccessControlAttributeConfiguration
(CreateInstanceAccessControlAttributeConfigurationRequest createInstanceAccessControlAttributeConfigurationRequest) Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance.createPermissionSet
(Consumer<CreatePermissionSetRequest.Builder> createPermissionSetRequest) Creates a permission set within a specified IAM Identity Center instance.createPermissionSet
(CreatePermissionSetRequest createPermissionSetRequest) Creates a permission set within a specified IAM Identity Center instance.createTrustedTokenIssuer
(Consumer<CreateTrustedTokenIssuerRequest.Builder> createTrustedTokenIssuerRequest) Creates a connection to a trusted token issuer in an instance of IAM Identity Center.createTrustedTokenIssuer
(CreateTrustedTokenIssuerRequest createTrustedTokenIssuerRequest) Creates a connection to a trusted token issuer in an instance of IAM Identity Center.deleteAccountAssignment
(Consumer<DeleteAccountAssignmentRequest.Builder> deleteAccountAssignmentRequest) Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.deleteAccountAssignment
(DeleteAccountAssignmentRequest deleteAccountAssignmentRequest) Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes the association with the application.deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes the association with the application.deleteApplicationAccessScope
(Consumer<DeleteApplicationAccessScopeRequest.Builder> deleteApplicationAccessScopeRequest) Deletes an IAM Identity Center access scope from an application.deleteApplicationAccessScope
(DeleteApplicationAccessScopeRequest deleteApplicationAccessScopeRequest) Deletes an IAM Identity Center access scope from an application.deleteApplicationAssignment
(Consumer<DeleteApplicationAssignmentRequest.Builder> deleteApplicationAssignmentRequest) Revoke application access to an application by deleting application assignments for a user or group.deleteApplicationAssignment
(DeleteApplicationAssignmentRequest deleteApplicationAssignmentRequest) Revoke application access to an application by deleting application assignments for a user or group.deleteApplicationAuthenticationMethod
(Consumer<DeleteApplicationAuthenticationMethodRequest.Builder> deleteApplicationAuthenticationMethodRequest) Deletes an authentication method from an application.deleteApplicationAuthenticationMethod
(DeleteApplicationAuthenticationMethodRequest deleteApplicationAuthenticationMethodRequest) Deletes an authentication method from an application.deleteApplicationGrant
(Consumer<DeleteApplicationGrantRequest.Builder> deleteApplicationGrantRequest) Deletes a grant from an application.deleteApplicationGrant
(DeleteApplicationGrantRequest deleteApplicationGrantRequest) Deletes a grant from an application.deleteInlinePolicyFromPermissionSet
(Consumer<DeleteInlinePolicyFromPermissionSetRequest.Builder> deleteInlinePolicyFromPermissionSetRequest) Deletes the inline policy from a specified permission set.deleteInlinePolicyFromPermissionSet
(DeleteInlinePolicyFromPermissionSetRequest deleteInlinePolicyFromPermissionSetRequest) Deletes the inline policy from a specified permission set.default CompletableFuture
<DeleteInstanceResponse> deleteInstance
(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) Deletes the instance of IAM Identity Center.default CompletableFuture
<DeleteInstanceResponse> deleteInstance
(DeleteInstanceRequest deleteInstanceRequest) Deletes the instance of IAM Identity Center.deleteInstanceAccessControlAttributeConfiguration
(Consumer<DeleteInstanceAccessControlAttributeConfigurationRequest.Builder> deleteInstanceAccessControlAttributeConfigurationRequest) Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured.deleteInstanceAccessControlAttributeConfiguration
(DeleteInstanceAccessControlAttributeConfigurationRequest deleteInstanceAccessControlAttributeConfigurationRequest) Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured.deletePermissionsBoundaryFromPermissionSet
(Consumer<DeletePermissionsBoundaryFromPermissionSetRequest.Builder> deletePermissionsBoundaryFromPermissionSetRequest) Deletes the permissions boundary from a specified PermissionSet.deletePermissionsBoundaryFromPermissionSet
(DeletePermissionsBoundaryFromPermissionSetRequest deletePermissionsBoundaryFromPermissionSetRequest) Deletes the permissions boundary from a specified PermissionSet.deletePermissionSet
(Consumer<DeletePermissionSetRequest.Builder> deletePermissionSetRequest) Deletes the specified permission set.deletePermissionSet
(DeletePermissionSetRequest deletePermissionSetRequest) Deletes the specified permission set.deleteTrustedTokenIssuer
(Consumer<DeleteTrustedTokenIssuerRequest.Builder> deleteTrustedTokenIssuerRequest) Deletes a trusted token issuer configuration from an instance of IAM Identity Center.deleteTrustedTokenIssuer
(DeleteTrustedTokenIssuerRequest deleteTrustedTokenIssuerRequest) Deletes a trusted token issuer configuration from an instance of IAM Identity Center.describeAccountAssignmentCreationStatus
(Consumer<DescribeAccountAssignmentCreationStatusRequest.Builder> describeAccountAssignmentCreationStatusRequest) Describes the status of the assignment creation request.describeAccountAssignmentCreationStatus
(DescribeAccountAssignmentCreationStatusRequest describeAccountAssignmentCreationStatusRequest) Describes the status of the assignment creation request.describeAccountAssignmentDeletionStatus
(Consumer<DescribeAccountAssignmentDeletionStatusRequest.Builder> describeAccountAssignmentDeletionStatusRequest) Describes the status of the assignment deletion request.describeAccountAssignmentDeletionStatus
(DescribeAccountAssignmentDeletionStatusRequest describeAccountAssignmentDeletionStatusRequest) Describes the status of the assignment deletion request.describeApplication
(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest) Retrieves the details of an application associated with an instance of IAM Identity Center.describeApplication
(DescribeApplicationRequest describeApplicationRequest) Retrieves the details of an application associated with an instance of IAM Identity Center.describeApplicationAssignment
(Consumer<DescribeApplicationAssignmentRequest.Builder> describeApplicationAssignmentRequest) Retrieves a direct assignment of a user or group to an application.describeApplicationAssignment
(DescribeApplicationAssignmentRequest describeApplicationAssignmentRequest) Retrieves a direct assignment of a user or group to an application.describeApplicationProvider
(Consumer<DescribeApplicationProviderRequest.Builder> describeApplicationProviderRequest) Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.describeApplicationProvider
(DescribeApplicationProviderRequest describeApplicationProviderRequest) 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.describeInstance
(Consumer<DescribeInstanceRequest.Builder> describeInstanceRequest) Returns the details of an instance of IAM Identity Center.describeInstance
(DescribeInstanceRequest describeInstanceRequest) Returns the details of an instance of IAM Identity Center.describeInstanceAccessControlAttributeConfiguration
(Consumer<DescribeInstanceAccessControlAttributeConfigurationRequest.Builder> describeInstanceAccessControlAttributeConfigurationRequest) Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance.describeInstanceAccessControlAttributeConfiguration
(DescribeInstanceAccessControlAttributeConfigurationRequest describeInstanceAccessControlAttributeConfigurationRequest) Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance.describePermissionSet
(Consumer<DescribePermissionSetRequest.Builder> describePermissionSetRequest) Gets the details of the permission set.describePermissionSet
(DescribePermissionSetRequest describePermissionSetRequest) Gets the details of the permission set.describePermissionSetProvisioningStatus
(Consumer<DescribePermissionSetProvisioningStatusRequest.Builder> describePermissionSetProvisioningStatusRequest) Describes the status for the given permission set provisioning request.describePermissionSetProvisioningStatus
(DescribePermissionSetProvisioningStatusRequest describePermissionSetProvisioningStatusRequest) Describes the status for the given permission set provisioning request.describeTrustedTokenIssuer
(Consumer<DescribeTrustedTokenIssuerRequest.Builder> describeTrustedTokenIssuerRequest) Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center.describeTrustedTokenIssuer
(DescribeTrustedTokenIssuerRequest describeTrustedTokenIssuerRequest) Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center.detachCustomerManagedPolicyReferenceFromPermissionSet
(Consumer<DetachCustomerManagedPolicyReferenceFromPermissionSetRequest.Builder> detachCustomerManagedPolicyReferenceFromPermissionSetRequest) Detaches the specified customer managed policy from the specified PermissionSet.detachCustomerManagedPolicyReferenceFromPermissionSet
(DetachCustomerManagedPolicyReferenceFromPermissionSetRequest detachCustomerManagedPolicyReferenceFromPermissionSetRequest) Detaches the specified customer managed policy from the specified PermissionSet.detachManagedPolicyFromPermissionSet
(Consumer<DetachManagedPolicyFromPermissionSetRequest.Builder> detachManagedPolicyFromPermissionSetRequest) Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.detachManagedPolicyFromPermissionSet
(DetachManagedPolicyFromPermissionSetRequest detachManagedPolicyFromPermissionSetRequest) Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.getApplicationAccessScope
(Consumer<GetApplicationAccessScopeRequest.Builder> getApplicationAccessScopeRequest) Retrieves the authorized targets for an IAM Identity Center access scope for an application.getApplicationAccessScope
(GetApplicationAccessScopeRequest getApplicationAccessScopeRequest) Retrieves the authorized targets for an IAM Identity Center access scope for an application.getApplicationAssignmentConfiguration
(Consumer<GetApplicationAssignmentConfigurationRequest.Builder> getApplicationAssignmentConfigurationRequest) Retrieves the configuration of PutApplicationAssignmentConfiguration.getApplicationAssignmentConfiguration
(GetApplicationAssignmentConfigurationRequest getApplicationAssignmentConfigurationRequest) Retrieves the configuration of PutApplicationAssignmentConfiguration.getApplicationAuthenticationMethod
(Consumer<GetApplicationAuthenticationMethodRequest.Builder> getApplicationAuthenticationMethodRequest) Retrieves details about an authentication method used by an application.getApplicationAuthenticationMethod
(GetApplicationAuthenticationMethodRequest getApplicationAuthenticationMethodRequest) Retrieves details about an authentication method used by an application.getApplicationGrant
(Consumer<GetApplicationGrantRequest.Builder> getApplicationGrantRequest) Retrieves details about an application grant.getApplicationGrant
(GetApplicationGrantRequest getApplicationGrantRequest) Retrieves details about an application grant.getInlinePolicyForPermissionSet
(Consumer<GetInlinePolicyForPermissionSetRequest.Builder> getInlinePolicyForPermissionSetRequest) Obtains the inline policy assigned to the permission set.getInlinePolicyForPermissionSet
(GetInlinePolicyForPermissionSetRequest getInlinePolicyForPermissionSetRequest) Obtains the inline policy assigned to the permission set.getPermissionsBoundaryForPermissionSet
(Consumer<GetPermissionsBoundaryForPermissionSetRequest.Builder> getPermissionsBoundaryForPermissionSetRequest) Obtains the permissions boundary for a specified PermissionSet.getPermissionsBoundaryForPermissionSet
(GetPermissionsBoundaryForPermissionSetRequest getPermissionsBoundaryForPermissionSetRequest) Obtains the permissions boundary for a specified PermissionSet.listAccountAssignmentCreationStatus
(Consumer<ListAccountAssignmentCreationStatusRequest.Builder> listAccountAssignmentCreationStatusRequest) Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.listAccountAssignmentCreationStatus
(ListAccountAssignmentCreationStatusRequest listAccountAssignmentCreationStatusRequest) Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.listAccountAssignmentCreationStatusPaginator
(Consumer<ListAccountAssignmentCreationStatusRequest.Builder> listAccountAssignmentCreationStatusRequest) This is a variant oflistAccountAssignmentCreationStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusRequest)
operation.listAccountAssignmentCreationStatusPaginator
(ListAccountAssignmentCreationStatusRequest listAccountAssignmentCreationStatusRequest) This is a variant oflistAccountAssignmentCreationStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusRequest)
operation.listAccountAssignmentDeletionStatus
(Consumer<ListAccountAssignmentDeletionStatusRequest.Builder> listAccountAssignmentDeletionStatusRequest) Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.listAccountAssignmentDeletionStatus
(ListAccountAssignmentDeletionStatusRequest listAccountAssignmentDeletionStatusRequest) Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.listAccountAssignmentDeletionStatusPaginator
(Consumer<ListAccountAssignmentDeletionStatusRequest.Builder> listAccountAssignmentDeletionStatusRequest) This is a variant oflistAccountAssignmentDeletionStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusRequest)
operation.listAccountAssignmentDeletionStatusPaginator
(ListAccountAssignmentDeletionStatusRequest listAccountAssignmentDeletionStatusRequest) This is a variant oflistAccountAssignmentDeletionStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusRequest)
operation.listAccountAssignments
(Consumer<ListAccountAssignmentsRequest.Builder> listAccountAssignmentsRequest) Lists the assignee of the specified Amazon Web Services account with the specified permission set.listAccountAssignments
(ListAccountAssignmentsRequest listAccountAssignmentsRequest) Lists the assignee of the specified Amazon Web Services account with the specified permission set.listAccountAssignmentsForPrincipal
(Consumer<ListAccountAssignmentsForPrincipalRequest.Builder> listAccountAssignmentsForPrincipalRequest) Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.listAccountAssignmentsForPrincipal
(ListAccountAssignmentsForPrincipalRequest listAccountAssignmentsForPrincipalRequest) Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.listAccountAssignmentsForPrincipalPaginator
(Consumer<ListAccountAssignmentsForPrincipalRequest.Builder> listAccountAssignmentsForPrincipalRequest) This is a variant oflistAccountAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalRequest)
operation.listAccountAssignmentsForPrincipalPaginator
(ListAccountAssignmentsForPrincipalRequest listAccountAssignmentsForPrincipalRequest) This is a variant oflistAccountAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalRequest)
operation.default ListAccountAssignmentsPublisher
listAccountAssignmentsPaginator
(Consumer<ListAccountAssignmentsRequest.Builder> listAccountAssignmentsRequest) This is a variant oflistAccountAssignments(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsRequest)
operation.default ListAccountAssignmentsPublisher
listAccountAssignmentsPaginator
(ListAccountAssignmentsRequest listAccountAssignmentsRequest) This is a variant oflistAccountAssignments(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsRequest)
operation.listAccountsForProvisionedPermissionSet
(Consumer<ListAccountsForProvisionedPermissionSetRequest.Builder> listAccountsForProvisionedPermissionSetRequest) Lists all the Amazon Web Services accounts where the specified permission set is provisioned.listAccountsForProvisionedPermissionSet
(ListAccountsForProvisionedPermissionSetRequest listAccountsForProvisionedPermissionSetRequest) Lists all the Amazon Web Services accounts where the specified permission set is provisioned.listAccountsForProvisionedPermissionSetPaginator
(Consumer<ListAccountsForProvisionedPermissionSetRequest.Builder> listAccountsForProvisionedPermissionSetRequest) listAccountsForProvisionedPermissionSetPaginator
(ListAccountsForProvisionedPermissionSetRequest listAccountsForProvisionedPermissionSetRequest) listApplicationAccessScopes
(Consumer<ListApplicationAccessScopesRequest.Builder> listApplicationAccessScopesRequest) Lists the access scopes and authorized targets associated with an application.listApplicationAccessScopes
(ListApplicationAccessScopesRequest listApplicationAccessScopesRequest) Lists the access scopes and authorized targets associated with an application.listApplicationAccessScopesPaginator
(Consumer<ListApplicationAccessScopesRequest.Builder> listApplicationAccessScopesRequest) This is a variant oflistApplicationAccessScopes(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesRequest)
operation.listApplicationAccessScopesPaginator
(ListApplicationAccessScopesRequest listApplicationAccessScopesRequest) This is a variant oflistApplicationAccessScopes(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesRequest)
operation.listApplicationAssignments
(Consumer<ListApplicationAssignmentsRequest.Builder> listApplicationAssignmentsRequest) Lists Amazon Web Services account users that are assigned to an application.listApplicationAssignments
(ListApplicationAssignmentsRequest listApplicationAssignmentsRequest) Lists Amazon Web Services account users that are assigned to an application.listApplicationAssignmentsForPrincipal
(Consumer<ListApplicationAssignmentsForPrincipalRequest.Builder> listApplicationAssignmentsForPrincipalRequest) Lists the applications to which a specified principal is assigned.listApplicationAssignmentsForPrincipal
(ListApplicationAssignmentsForPrincipalRequest listApplicationAssignmentsForPrincipalRequest) Lists the applications to which a specified principal is assigned.listApplicationAssignmentsForPrincipalPaginator
(Consumer<ListApplicationAssignmentsForPrincipalRequest.Builder> listApplicationAssignmentsForPrincipalRequest) listApplicationAssignmentsForPrincipalPaginator
(ListApplicationAssignmentsForPrincipalRequest listApplicationAssignmentsForPrincipalRequest) listApplicationAssignmentsPaginator
(Consumer<ListApplicationAssignmentsRequest.Builder> listApplicationAssignmentsRequest) This is a variant oflistApplicationAssignments(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsRequest)
operation.listApplicationAssignmentsPaginator
(ListApplicationAssignmentsRequest listApplicationAssignmentsRequest) This is a variant oflistApplicationAssignments(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsRequest)
operation.listApplicationAuthenticationMethods
(Consumer<ListApplicationAuthenticationMethodsRequest.Builder> listApplicationAuthenticationMethodsRequest) Lists all of the authentication methods supported by the specified application.listApplicationAuthenticationMethods
(ListApplicationAuthenticationMethodsRequest listApplicationAuthenticationMethodsRequest) Lists all of the authentication methods supported by the specified application.listApplicationAuthenticationMethodsPaginator
(Consumer<ListApplicationAuthenticationMethodsRequest.Builder> listApplicationAuthenticationMethodsRequest) This is a variant oflistApplicationAuthenticationMethods(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsRequest)
operation.listApplicationAuthenticationMethodsPaginator
(ListApplicationAuthenticationMethodsRequest listApplicationAuthenticationMethodsRequest) This is a variant oflistApplicationAuthenticationMethods(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsRequest)
operation.listApplicationGrants
(Consumer<ListApplicationGrantsRequest.Builder> listApplicationGrantsRequest) List the grants associated with an application.listApplicationGrants
(ListApplicationGrantsRequest listApplicationGrantsRequest) List the grants associated with an application.default ListApplicationGrantsPublisher
listApplicationGrantsPaginator
(Consumer<ListApplicationGrantsRequest.Builder> listApplicationGrantsRequest) This is a variant oflistApplicationGrants(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsRequest)
operation.default ListApplicationGrantsPublisher
listApplicationGrantsPaginator
(ListApplicationGrantsRequest listApplicationGrantsRequest) This is a variant oflistApplicationGrants(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsRequest)
operation.listApplicationProviders
(Consumer<ListApplicationProvidersRequest.Builder> listApplicationProvidersRequest) Lists the application providers configured in the IAM Identity Center identity store.listApplicationProviders
(ListApplicationProvidersRequest listApplicationProvidersRequest) Lists the application providers configured in the IAM Identity Center identity store.listApplicationProvidersPaginator
(Consumer<ListApplicationProvidersRequest.Builder> listApplicationProvidersRequest) This is a variant oflistApplicationProviders(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersRequest)
operation.listApplicationProvidersPaginator
(ListApplicationProvidersRequest listApplicationProvidersRequest) This is a variant oflistApplicationProviders(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersRequest)
operation.listApplications
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists all applications associated with the instance of IAM Identity Center.listApplications
(ListApplicationsRequest listApplicationsRequest) Lists all applications associated with the instance of IAM Identity Center.default ListApplicationsPublisher
listApplicationsPaginator
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsRequest)
operation.default ListApplicationsPublisher
listApplicationsPaginator
(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsRequest)
operation.listCustomerManagedPolicyReferencesInPermissionSet
(Consumer<ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder> listCustomerManagedPolicyReferencesInPermissionSetRequest) Lists all customer managed policies attached to a specified PermissionSet.listCustomerManagedPolicyReferencesInPermissionSet
(ListCustomerManagedPolicyReferencesInPermissionSetRequest listCustomerManagedPolicyReferencesInPermissionSetRequest) Lists all customer managed policies attached to a specified PermissionSet.listCustomerManagedPolicyReferencesInPermissionSetPaginator
(Consumer<ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder> listCustomerManagedPolicyReferencesInPermissionSetRequest) listCustomerManagedPolicyReferencesInPermissionSetPaginator
(ListCustomerManagedPolicyReferencesInPermissionSetRequest listCustomerManagedPolicyReferencesInPermissionSetRequest) default CompletableFuture
<ListInstancesResponse> listInstances
(Consumer<ListInstancesRequest.Builder> listInstancesRequest) 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.default CompletableFuture
<ListInstancesResponse> listInstances
(ListInstancesRequest listInstancesRequest) 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.default ListInstancesPublisher
listInstancesPaginator
(Consumer<ListInstancesRequest.Builder> listInstancesRequest) This is a variant oflistInstances(software.amazon.awssdk.services.ssoadmin.model.ListInstancesRequest)
operation.default ListInstancesPublisher
listInstancesPaginator
(ListInstancesRequest listInstancesRequest) This is a variant oflistInstances(software.amazon.awssdk.services.ssoadmin.model.ListInstancesRequest)
operation.listManagedPoliciesInPermissionSet
(Consumer<ListManagedPoliciesInPermissionSetRequest.Builder> listManagedPoliciesInPermissionSetRequest) Lists the Amazon Web Services managed policy that is attached to a specified permission set.listManagedPoliciesInPermissionSet
(ListManagedPoliciesInPermissionSetRequest listManagedPoliciesInPermissionSetRequest) Lists the Amazon Web Services managed policy that is attached to a specified permission set.listManagedPoliciesInPermissionSetPaginator
(Consumer<ListManagedPoliciesInPermissionSetRequest.Builder> listManagedPoliciesInPermissionSetRequest) This is a variant oflistManagedPoliciesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetRequest)
operation.listManagedPoliciesInPermissionSetPaginator
(ListManagedPoliciesInPermissionSetRequest listManagedPoliciesInPermissionSetRequest) This is a variant oflistManagedPoliciesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetRequest)
operation.listPermissionSetProvisioningStatus
(Consumer<ListPermissionSetProvisioningStatusRequest.Builder> listPermissionSetProvisioningStatusRequest) Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.listPermissionSetProvisioningStatus
(ListPermissionSetProvisioningStatusRequest listPermissionSetProvisioningStatusRequest) Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.listPermissionSetProvisioningStatusPaginator
(Consumer<ListPermissionSetProvisioningStatusRequest.Builder> listPermissionSetProvisioningStatusRequest) This is a variant oflistPermissionSetProvisioningStatus(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusRequest)
operation.listPermissionSetProvisioningStatusPaginator
(ListPermissionSetProvisioningStatusRequest listPermissionSetProvisioningStatusRequest) This is a variant oflistPermissionSetProvisioningStatus(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusRequest)
operation.listPermissionSets
(Consumer<ListPermissionSetsRequest.Builder> listPermissionSetsRequest) Lists the PermissionSets in an IAM Identity Center instance.listPermissionSets
(ListPermissionSetsRequest listPermissionSetsRequest) Lists the PermissionSets in an IAM Identity Center instance.default ListPermissionSetsPublisher
listPermissionSetsPaginator
(Consumer<ListPermissionSetsRequest.Builder> listPermissionSetsRequest) This is a variant oflistPermissionSets(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsRequest)
operation.default ListPermissionSetsPublisher
listPermissionSetsPaginator
(ListPermissionSetsRequest listPermissionSetsRequest) This is a variant oflistPermissionSets(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsRequest)
operation.listPermissionSetsProvisionedToAccount
(Consumer<ListPermissionSetsProvisionedToAccountRequest.Builder> listPermissionSetsProvisionedToAccountRequest) Lists all the permission sets that are provisioned to a specified Amazon Web Services account.listPermissionSetsProvisionedToAccount
(ListPermissionSetsProvisionedToAccountRequest listPermissionSetsProvisionedToAccountRequest) Lists all the permission sets that are provisioned to a specified Amazon Web Services account.listPermissionSetsProvisionedToAccountPaginator
(Consumer<ListPermissionSetsProvisionedToAccountRequest.Builder> listPermissionSetsProvisionedToAccountRequest) listPermissionSetsProvisionedToAccountPaginator
(ListPermissionSetsProvisionedToAccountRequest listPermissionSetsProvisionedToAccountRequest) listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags that are attached to a specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are attached to a specified resource.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceRequest)
operation.listTrustedTokenIssuers
(Consumer<ListTrustedTokenIssuersRequest.Builder> listTrustedTokenIssuersRequest) Lists all the trusted token issuers configured in an instance of IAM Identity Center.listTrustedTokenIssuers
(ListTrustedTokenIssuersRequest listTrustedTokenIssuersRequest) Lists all the trusted token issuers configured in an instance of IAM Identity Center.default ListTrustedTokenIssuersPublisher
listTrustedTokenIssuersPaginator
(Consumer<ListTrustedTokenIssuersRequest.Builder> listTrustedTokenIssuersRequest) This is a variant oflistTrustedTokenIssuers(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersRequest)
operation.default ListTrustedTokenIssuersPublisher
listTrustedTokenIssuersPaginator
(ListTrustedTokenIssuersRequest listTrustedTokenIssuersRequest) This is a variant oflistTrustedTokenIssuers(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersRequest)
operation.provisionPermissionSet
(Consumer<ProvisionPermissionSetRequest.Builder> provisionPermissionSetRequest) The process by which a specified permission set is provisioned to the specified target.provisionPermissionSet
(ProvisionPermissionSetRequest provisionPermissionSetRequest) The process by which a specified permission set is provisioned to the specified target.putApplicationAccessScope
(Consumer<PutApplicationAccessScopeRequest.Builder> putApplicationAccessScopeRequest) Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.putApplicationAccessScope
(PutApplicationAccessScopeRequest putApplicationAccessScopeRequest) Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.putApplicationAssignmentConfiguration
(Consumer<PutApplicationAssignmentConfigurationRequest.Builder> putApplicationAssignmentConfigurationRequest) Configure how users gain access to an application.putApplicationAssignmentConfiguration
(PutApplicationAssignmentConfigurationRequest putApplicationAssignmentConfigurationRequest) Configure how users gain access to an application.putApplicationAuthenticationMethod
(Consumer<PutApplicationAuthenticationMethodRequest.Builder> putApplicationAuthenticationMethodRequest) Adds or updates an authentication method for an application.putApplicationAuthenticationMethod
(PutApplicationAuthenticationMethodRequest putApplicationAuthenticationMethodRequest) Adds or updates an authentication method for an application.putApplicationGrant
(Consumer<PutApplicationGrantRequest.Builder> putApplicationGrantRequest) Adds a grant to an application.putApplicationGrant
(PutApplicationGrantRequest putApplicationGrantRequest) Adds a grant to an application.putInlinePolicyToPermissionSet
(Consumer<PutInlinePolicyToPermissionSetRequest.Builder> putInlinePolicyToPermissionSetRequest) Attaches an inline policy to a permission set.putInlinePolicyToPermissionSet
(PutInlinePolicyToPermissionSetRequest putInlinePolicyToPermissionSetRequest) Attaches an inline policy to a permission set.putPermissionsBoundaryToPermissionSet
(Consumer<PutPermissionsBoundaryToPermissionSetRequest.Builder> putPermissionsBoundaryToPermissionSetRequest) Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.putPermissionsBoundaryToPermissionSet
(PutPermissionsBoundaryToPermissionSetRequest putPermissionsBoundaryToPermissionSetRequest) Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates a set of tags with a specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Associates a set of tags with a specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Disassociates a set of tags from a specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Disassociates a set of tags from a specified resource.updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates application properties.updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates application properties.default CompletableFuture
<UpdateInstanceResponse> updateInstance
(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest) Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.default CompletableFuture
<UpdateInstanceResponse> updateInstance
(UpdateInstanceRequest updateInstanceRequest) Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.updateInstanceAccessControlAttributeConfiguration
(Consumer<UpdateInstanceAccessControlAttributeConfigurationRequest.Builder> updateInstanceAccessControlAttributeConfigurationRequest) Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC).updateInstanceAccessControlAttributeConfiguration
(UpdateInstanceAccessControlAttributeConfigurationRequest updateInstanceAccessControlAttributeConfigurationRequest) Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC).updatePermissionSet
(Consumer<UpdatePermissionSetRequest.Builder> updatePermissionSetRequest) Updates an existing permission set.updatePermissionSet
(UpdatePermissionSetRequest updatePermissionSetRequest) Updates an existing permission set.updateTrustedTokenIssuer
(Consumer<UpdateTrustedTokenIssuerRequest.Builder> updateTrustedTokenIssuerRequest) Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.updateTrustedTokenIssuer
(UpdateTrustedTokenIssuerRequest updateTrustedTokenIssuerRequest) Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
attachCustomerManagedPolicyReferenceToPermissionSet
default CompletableFuture<AttachCustomerManagedPolicyReferenceToPermissionSetResponse> attachCustomerManagedPolicyReferenceToPermissionSet(AttachCustomerManagedPolicyReferenceToPermissionSetRequest attachCustomerManagedPolicyReferenceToPermissionSetRequest) Attaches the specified customer managed policy to the specified PermissionSet.
- Parameters:
attachCustomerManagedPolicyReferenceToPermissionSetRequest
-- Returns:
- A Java Future containing the result of the AttachCustomerManagedPolicyReferenceToPermissionSet operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachCustomerManagedPolicyReferenceToPermissionSet
default CompletableFuture<AttachCustomerManagedPolicyReferenceToPermissionSetResponse> attachCustomerManagedPolicyReferenceToPermissionSet(Consumer<AttachCustomerManagedPolicyReferenceToPermissionSetRequest.Builder> attachCustomerManagedPolicyReferenceToPermissionSetRequest) Attaches the specified customer managed policy to the specified PermissionSet.
This is a convenience which creates an instance of the
AttachCustomerManagedPolicyReferenceToPermissionSetRequest.Builder
avoiding the need to create one manually viaAttachCustomerManagedPolicyReferenceToPermissionSetRequest.builder()
- Parameters:
attachCustomerManagedPolicyReferenceToPermissionSetRequest
- AConsumer
that will call methods onAttachCustomerManagedPolicyReferenceToPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AttachCustomerManagedPolicyReferenceToPermissionSet operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachManagedPolicyToPermissionSet
default CompletableFuture<AttachManagedPolicyToPermissionSetResponse> attachManagedPolicyToPermissionSet(AttachManagedPolicyToPermissionSetRequest attachManagedPolicyToPermissionSetRequest) Attaches an Amazon Web Services managed policy ARN to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet
after this operation. CallingProvisionPermissionSet
applies the corresponding IAM policy updates to all assigned accounts.- Parameters:
attachManagedPolicyToPermissionSetRequest
-- Returns:
- A Java Future containing the result of the AttachManagedPolicyToPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
attachManagedPolicyToPermissionSet
default CompletableFuture<AttachManagedPolicyToPermissionSetResponse> attachManagedPolicyToPermissionSet(Consumer<AttachManagedPolicyToPermissionSetRequest.Builder> attachManagedPolicyToPermissionSetRequest) Attaches an Amazon Web Services managed policy ARN to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet
after this operation. CallingProvisionPermissionSet
applies the corresponding IAM policy updates to all assigned accounts.
This is a convenience which creates an instance of the
AttachManagedPolicyToPermissionSetRequest.Builder
avoiding the need to create one manually viaAttachManagedPolicyToPermissionSetRequest.builder()
- Parameters:
attachManagedPolicyToPermissionSetRequest
- AConsumer
that will call methods onAttachManagedPolicyToPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AttachManagedPolicyToPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccountAssignment
default CompletableFuture<CreateAccountAssignmentResponse> createAccountAssignment(CreateAccountAssignmentRequest createAccountAssignmentRequest) Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
The term principal here refers to a user or group that is defined in IAM Identity Center.
As part of a successful
CreateAccountAssignment
call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must callProvisionPermissionSet
to make these updates.After a successful response, call
DescribeAccountAssignmentCreationStatus
to describe the status of an assignment creation request.- Parameters:
createAccountAssignmentRequest
-- Returns:
- A Java Future containing the result of the CreateAccountAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccountAssignment
default CompletableFuture<CreateAccountAssignmentResponse> createAccountAssignment(Consumer<CreateAccountAssignmentRequest.Builder> createAccountAssignmentRequest) Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
The term principal here refers to a user or group that is defined in IAM Identity Center.
As part of a successful
CreateAccountAssignment
call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must callProvisionPermissionSet
to make these updates.After a successful response, call
DescribeAccountAssignmentCreationStatus
to describe the status of an assignment creation request.
This is a convenience which creates an instance of the
CreateAccountAssignmentRequest.Builder
avoiding the need to create one manually viaCreateAccountAssignmentRequest.builder()
- Parameters:
createAccountAssignmentRequest
- AConsumer
that will call methods onCreateAccountAssignmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccountAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest) Creates an application in IAM Identity Center for the given application provider.
- Parameters:
createApplicationRequest
-- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application in IAM Identity Center for the given application provider.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createApplicationAssignment
default CompletableFuture<CreateApplicationAssignmentResponse> createApplicationAssignment(CreateApplicationAssignmentRequest createApplicationAssignmentRequest) Grant application access to a user or group.
- Parameters:
createApplicationAssignmentRequest
-- Returns:
- A Java Future containing the result of the CreateApplicationAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createApplicationAssignment
default CompletableFuture<CreateApplicationAssignmentResponse> createApplicationAssignment(Consumer<CreateApplicationAssignmentRequest.Builder> createApplicationAssignmentRequest) Grant application access to a user or group.
This is a convenience which creates an instance of the
CreateApplicationAssignmentRequest.Builder
avoiding the need to create one manually viaCreateApplicationAssignmentRequest.builder()
- Parameters:
createApplicationAssignmentRequest
- AConsumer
that will call methods onCreateApplicationAssignmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateApplicationAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createInstance
default CompletableFuture<CreateInstanceResponse> createInstance(CreateInstanceRequest createInstanceRequest) 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:
- A Java Future containing the result of the CreateInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
createInstance
default CompletableFuture<CreateInstanceResponse> createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) 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.Builder
avoiding the need to create one manually viaCreateInstanceRequest.builder()
- Parameters:
createInstanceRequest
- AConsumer
that will call methods onCreateInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
createInstanceAccessControlAttributeConfiguration
default CompletableFuture<CreateInstanceAccessControlAttributeConfigurationResponse> createInstanceAccessControlAttributeConfiguration(CreateInstanceAccessControlAttributeConfigurationRequest createInstanceAccessControlAttributeConfigurationRequest) Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
After a successful response, call
DescribeInstanceAccessControlAttributeConfiguration
to validate thatInstanceAccessControlAttributeConfiguration
was created.- Parameters:
createInstanceAccessControlAttributeConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateInstanceAccessControlAttributeConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createInstanceAccessControlAttributeConfiguration
default CompletableFuture<CreateInstanceAccessControlAttributeConfigurationResponse> createInstanceAccessControlAttributeConfiguration(Consumer<CreateInstanceAccessControlAttributeConfigurationRequest.Builder> createInstanceAccessControlAttributeConfigurationRequest) Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
After a successful response, call
DescribeInstanceAccessControlAttributeConfiguration
to validate thatInstanceAccessControlAttributeConfiguration
was created.
This is a convenience which creates an instance of the
CreateInstanceAccessControlAttributeConfigurationRequest.Builder
avoiding the need to create one manually viaCreateInstanceAccessControlAttributeConfigurationRequest.builder()
- Parameters:
createInstanceAccessControlAttributeConfigurationRequest
- AConsumer
that will call methods onCreateInstanceAccessControlAttributeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateInstanceAccessControlAttributeConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createPermissionSet
default CompletableFuture<CreatePermissionSetResponse> createPermissionSet(CreatePermissionSetRequest createPermissionSetRequest) 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:
- A Java Future containing the result of the CreatePermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createPermissionSet
default CompletableFuture<CreatePermissionSetResponse> createPermissionSet(Consumer<CreatePermissionSetRequest.Builder> createPermissionSetRequest) 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.Builder
avoiding the need to create one manually viaCreatePermissionSetRequest.builder()
- Parameters:
createPermissionSetRequest
- AConsumer
that will call methods onCreatePermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createTrustedTokenIssuer
default CompletableFuture<CreateTrustedTokenIssuerResponse> createTrustedTokenIssuer(CreateTrustedTokenIssuerRequest createTrustedTokenIssuerRequest) 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:
- A Java Future containing the result of the CreateTrustedTokenIssuer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createTrustedTokenIssuer
default CompletableFuture<CreateTrustedTokenIssuerResponse> createTrustedTokenIssuer(Consumer<CreateTrustedTokenIssuerRequest.Builder> createTrustedTokenIssuerRequest) 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.Builder
avoiding the need to create one manually viaCreateTrustedTokenIssuerRequest.builder()
- Parameters:
createTrustedTokenIssuerRequest
- AConsumer
that will call methods onCreateTrustedTokenIssuerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTrustedTokenIssuer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccountAssignment
default CompletableFuture<DeleteAccountAssignmentResponse> deleteAccountAssignment(DeleteAccountAssignmentRequest deleteAccountAssignmentRequest) Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
After a successful response, call
DescribeAccountAssignmentDeletionStatus
to describe the status of an assignment deletion request.- Parameters:
deleteAccountAssignmentRequest
-- Returns:
- A Java Future containing the result of the DeleteAccountAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccountAssignment
default CompletableFuture<DeleteAccountAssignmentResponse> deleteAccountAssignment(Consumer<DeleteAccountAssignmentRequest.Builder> deleteAccountAssignmentRequest) Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
After a successful response, call
DescribeAccountAssignmentDeletionStatus
to describe the status of an assignment deletion request.
This is a convenience which creates an instance of the
DeleteAccountAssignmentRequest.Builder
avoiding the need to create one manually viaDeleteAccountAssignmentRequest.builder()
- Parameters:
deleteAccountAssignmentRequest
- AConsumer
that will call methods onDeleteAccountAssignmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccountAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes the association with the application. The connected service resource still exists.
- Parameters:
deleteApplicationRequest
-- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes the association with the application. The connected service resource still exists.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builder
avoiding the need to create one manually viaDeleteApplicationRequest.builder()
- Parameters:
deleteApplicationRequest
- AConsumer
that will call methods onDeleteApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplicationAccessScope
default CompletableFuture<DeleteApplicationAccessScopeResponse> deleteApplicationAccessScope(DeleteApplicationAccessScopeRequest deleteApplicationAccessScopeRequest) Deletes an IAM Identity Center access scope from an application.
- Parameters:
deleteApplicationAccessScopeRequest
-- Returns:
- A Java Future containing the result of the DeleteApplicationAccessScope operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplicationAccessScope
default CompletableFuture<DeleteApplicationAccessScopeResponse> deleteApplicationAccessScope(Consumer<DeleteApplicationAccessScopeRequest.Builder> deleteApplicationAccessScopeRequest) Deletes an IAM Identity Center access scope from an application.
This is a convenience which creates an instance of the
DeleteApplicationAccessScopeRequest.Builder
avoiding the need to create one manually viaDeleteApplicationAccessScopeRequest.builder()
- Parameters:
deleteApplicationAccessScopeRequest
- AConsumer
that will call methods onDeleteApplicationAccessScopeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplicationAccessScope operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplicationAssignment
default CompletableFuture<DeleteApplicationAssignmentResponse> deleteApplicationAssignment(DeleteApplicationAssignmentRequest deleteApplicationAssignmentRequest) Revoke application access to an application by deleting application assignments for a user or group.
- Parameters:
deleteApplicationAssignmentRequest
-- Returns:
- A Java Future containing the result of the DeleteApplicationAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplicationAssignment
default CompletableFuture<DeleteApplicationAssignmentResponse> deleteApplicationAssignment(Consumer<DeleteApplicationAssignmentRequest.Builder> deleteApplicationAssignmentRequest) 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.Builder
avoiding the need to create one manually viaDeleteApplicationAssignmentRequest.builder()
- Parameters:
deleteApplicationAssignmentRequest
- AConsumer
that will call methods onDeleteApplicationAssignmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplicationAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplicationAuthenticationMethod
default CompletableFuture<DeleteApplicationAuthenticationMethodResponse> deleteApplicationAuthenticationMethod(DeleteApplicationAuthenticationMethodRequest deleteApplicationAuthenticationMethodRequest) Deletes an authentication method from an application.
- Parameters:
deleteApplicationAuthenticationMethodRequest
-- Returns:
- A Java Future containing the result of the DeleteApplicationAuthenticationMethod operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplicationAuthenticationMethod
default CompletableFuture<DeleteApplicationAuthenticationMethodResponse> deleteApplicationAuthenticationMethod(Consumer<DeleteApplicationAuthenticationMethodRequest.Builder> deleteApplicationAuthenticationMethodRequest) Deletes an authentication method from an application.
This is a convenience which creates an instance of the
DeleteApplicationAuthenticationMethodRequest.Builder
avoiding the need to create one manually viaDeleteApplicationAuthenticationMethodRequest.builder()
- Parameters:
deleteApplicationAuthenticationMethodRequest
- AConsumer
that will call methods onDeleteApplicationAuthenticationMethodRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplicationAuthenticationMethod operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplicationGrant
default CompletableFuture<DeleteApplicationGrantResponse> deleteApplicationGrant(DeleteApplicationGrantRequest deleteApplicationGrantRequest) Deletes a grant from an application.
- Parameters:
deleteApplicationGrantRequest
-- Returns:
- A Java Future containing the result of the DeleteApplicationGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteApplicationGrant
default CompletableFuture<DeleteApplicationGrantResponse> deleteApplicationGrant(Consumer<DeleteApplicationGrantRequest.Builder> deleteApplicationGrantRequest) Deletes a grant from an application.
This is a convenience which creates an instance of the
DeleteApplicationGrantRequest.Builder
avoiding the need to create one manually viaDeleteApplicationGrantRequest.builder()
- Parameters:
deleteApplicationGrantRequest
- AConsumer
that will call methods onDeleteApplicationGrantRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplicationGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteInlinePolicyFromPermissionSet
default CompletableFuture<DeleteInlinePolicyFromPermissionSetResponse> deleteInlinePolicyFromPermissionSet(DeleteInlinePolicyFromPermissionSetRequest deleteInlinePolicyFromPermissionSetRequest) Deletes the inline policy from a specified permission set.
- Parameters:
deleteInlinePolicyFromPermissionSetRequest
-- Returns:
- A Java Future containing the result of the DeleteInlinePolicyFromPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteInlinePolicyFromPermissionSet
default CompletableFuture<DeleteInlinePolicyFromPermissionSetResponse> deleteInlinePolicyFromPermissionSet(Consumer<DeleteInlinePolicyFromPermissionSetRequest.Builder> deleteInlinePolicyFromPermissionSetRequest) Deletes the inline policy from a specified permission set.
This is a convenience which creates an instance of the
DeleteInlinePolicyFromPermissionSetRequest.Builder
avoiding the need to create one manually viaDeleteInlinePolicyFromPermissionSetRequest.builder()
- Parameters:
deleteInlinePolicyFromPermissionSetRequest
- AConsumer
that will call methods onDeleteInlinePolicyFromPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteInlinePolicyFromPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteInstance
default CompletableFuture<DeleteInstanceResponse> deleteInstance(DeleteInstanceRequest deleteInstanceRequest) 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:
- A Java Future containing the result of the DeleteInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteInstance
default CompletableFuture<DeleteInstanceResponse> deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) 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.Builder
avoiding the need to create one manually viaDeleteInstanceRequest.builder()
- Parameters:
deleteInstanceRequest
- AConsumer
that will call methods onDeleteInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteInstanceAccessControlAttributeConfiguration
default CompletableFuture<DeleteInstanceAccessControlAttributeConfigurationResponse> deleteInstanceAccessControlAttributeConfiguration(DeleteInstanceAccessControlAttributeConfigurationRequest deleteInstanceAccessControlAttributeConfigurationRequest) Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
- Parameters:
deleteInstanceAccessControlAttributeConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteInstanceAccessControlAttributeConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteInstanceAccessControlAttributeConfiguration
default CompletableFuture<DeleteInstanceAccessControlAttributeConfigurationResponse> deleteInstanceAccessControlAttributeConfiguration(Consumer<DeleteInstanceAccessControlAttributeConfigurationRequest.Builder> deleteInstanceAccessControlAttributeConfigurationRequest) Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
This is a convenience which creates an instance of the
DeleteInstanceAccessControlAttributeConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteInstanceAccessControlAttributeConfigurationRequest.builder()
- Parameters:
deleteInstanceAccessControlAttributeConfigurationRequest
- AConsumer
that will call methods onDeleteInstanceAccessControlAttributeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteInstanceAccessControlAttributeConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deletePermissionSet
default CompletableFuture<DeletePermissionSetResponse> deletePermissionSet(DeletePermissionSetRequest deletePermissionSetRequest) Deletes the specified permission set.
- Parameters:
deletePermissionSetRequest
-- Returns:
- A Java Future containing the result of the DeletePermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deletePermissionSet
default CompletableFuture<DeletePermissionSetResponse> deletePermissionSet(Consumer<DeletePermissionSetRequest.Builder> deletePermissionSetRequest) Deletes the specified permission set.
This is a convenience which creates an instance of the
DeletePermissionSetRequest.Builder
avoiding the need to create one manually viaDeletePermissionSetRequest.builder()
- Parameters:
deletePermissionSetRequest
- AConsumer
that will call methods onDeletePermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deletePermissionsBoundaryFromPermissionSet
default CompletableFuture<DeletePermissionsBoundaryFromPermissionSetResponse> deletePermissionsBoundaryFromPermissionSet(DeletePermissionsBoundaryFromPermissionSetRequest deletePermissionsBoundaryFromPermissionSetRequest) Deletes the permissions boundary from a specified PermissionSet.
- Parameters:
deletePermissionsBoundaryFromPermissionSetRequest
-- Returns:
- A Java Future containing the result of the DeletePermissionsBoundaryFromPermissionSet operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deletePermissionsBoundaryFromPermissionSet
default CompletableFuture<DeletePermissionsBoundaryFromPermissionSetResponse> deletePermissionsBoundaryFromPermissionSet(Consumer<DeletePermissionsBoundaryFromPermissionSetRequest.Builder> deletePermissionsBoundaryFromPermissionSetRequest) Deletes the permissions boundary from a specified PermissionSet.
This is a convenience which creates an instance of the
DeletePermissionsBoundaryFromPermissionSetRequest.Builder
avoiding the need to create one manually viaDeletePermissionsBoundaryFromPermissionSetRequest.builder()
- Parameters:
deletePermissionsBoundaryFromPermissionSetRequest
- AConsumer
that will call methods onDeletePermissionsBoundaryFromPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePermissionsBoundaryFromPermissionSet operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteTrustedTokenIssuer
default CompletableFuture<DeleteTrustedTokenIssuerResponse> deleteTrustedTokenIssuer(DeleteTrustedTokenIssuerRequest deleteTrustedTokenIssuerRequest) 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:
- A Java Future containing the result of the DeleteTrustedTokenIssuer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteTrustedTokenIssuer
default CompletableFuture<DeleteTrustedTokenIssuerResponse> deleteTrustedTokenIssuer(Consumer<DeleteTrustedTokenIssuerRequest.Builder> deleteTrustedTokenIssuerRequest) 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.Builder
avoiding the need to create one manually viaDeleteTrustedTokenIssuerRequest.builder()
- Parameters:
deleteTrustedTokenIssuerRequest
- AConsumer
that will call methods onDeleteTrustedTokenIssuerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTrustedTokenIssuer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAccountAssignmentCreationStatus
default CompletableFuture<DescribeAccountAssignmentCreationStatusResponse> describeAccountAssignmentCreationStatus(DescribeAccountAssignmentCreationStatusRequest describeAccountAssignmentCreationStatusRequest) Describes the status of the assignment creation request.
- Parameters:
describeAccountAssignmentCreationStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountAssignmentCreationStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAccountAssignmentCreationStatus
default CompletableFuture<DescribeAccountAssignmentCreationStatusResponse> describeAccountAssignmentCreationStatus(Consumer<DescribeAccountAssignmentCreationStatusRequest.Builder> describeAccountAssignmentCreationStatusRequest) Describes the status of the assignment creation request.
This is a convenience which creates an instance of the
DescribeAccountAssignmentCreationStatusRequest.Builder
avoiding the need to create one manually viaDescribeAccountAssignmentCreationStatusRequest.builder()
- Parameters:
describeAccountAssignmentCreationStatusRequest
- AConsumer
that will call methods onDescribeAccountAssignmentCreationStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccountAssignmentCreationStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAccountAssignmentDeletionStatus
default CompletableFuture<DescribeAccountAssignmentDeletionStatusResponse> describeAccountAssignmentDeletionStatus(DescribeAccountAssignmentDeletionStatusRequest describeAccountAssignmentDeletionStatusRequest) Describes the status of the assignment deletion request.
- Parameters:
describeAccountAssignmentDeletionStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountAssignmentDeletionStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAccountAssignmentDeletionStatus
default CompletableFuture<DescribeAccountAssignmentDeletionStatusResponse> describeAccountAssignmentDeletionStatus(Consumer<DescribeAccountAssignmentDeletionStatusRequest.Builder> describeAccountAssignmentDeletionStatusRequest) Describes the status of the assignment deletion request.
This is a convenience which creates an instance of the
DescribeAccountAssignmentDeletionStatusRequest.Builder
avoiding the need to create one manually viaDescribeAccountAssignmentDeletionStatusRequest.builder()
- Parameters:
describeAccountAssignmentDeletionStatusRequest
- AConsumer
that will call methods onDescribeAccountAssignmentDeletionStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccountAssignmentDeletionStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeApplication
default CompletableFuture<DescribeApplicationResponse> describeApplication(DescribeApplicationRequest describeApplicationRequest) Retrieves the details of an application associated with an instance of IAM Identity Center.
- Parameters:
describeApplicationRequest
-- Returns:
- A Java Future containing the result of the DescribeApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeApplication
default CompletableFuture<DescribeApplicationResponse> describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest) 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.Builder
avoiding the need to create one manually viaDescribeApplicationRequest.builder()
- Parameters:
describeApplicationRequest
- AConsumer
that will call methods onDescribeApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeApplicationAssignment
default CompletableFuture<DescribeApplicationAssignmentResponse> describeApplicationAssignment(DescribeApplicationAssignmentRequest describeApplicationAssignmentRequest) 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:
- A Java Future containing the result of the DescribeApplicationAssignment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeApplicationAssignment
default CompletableFuture<DescribeApplicationAssignmentResponse> describeApplicationAssignment(Consumer<DescribeApplicationAssignmentRequest.Builder> describeApplicationAssignmentRequest) 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.Builder
avoiding the need to create one manually viaDescribeApplicationAssignmentRequest.builder()
- Parameters:
describeApplicationAssignmentRequest
- AConsumer
that will call methods onDescribeApplicationAssignmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeApplicationAssignment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeApplicationProvider
default CompletableFuture<DescribeApplicationProviderResponse> describeApplicationProvider(DescribeApplicationProviderRequest describeApplicationProviderRequest) 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:
- A Java Future containing the result of the DescribeApplicationProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeApplicationProvider
default CompletableFuture<DescribeApplicationProviderResponse> describeApplicationProvider(Consumer<DescribeApplicationProviderRequest.Builder> describeApplicationProviderRequest) 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.Builder
avoiding the need to create one manually viaDescribeApplicationProviderRequest.builder()
- Parameters:
describeApplicationProviderRequest
- AConsumer
that will call methods onDescribeApplicationProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeApplicationProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeInstance
default CompletableFuture<DescribeInstanceResponse> describeInstance(DescribeInstanceRequest describeInstanceRequest) 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_PROGRESS
state, you can call only DescribeInstance and DeleteInstance operations. -
DELETE_IN_PROGRESS
- The instance is being deleted. ReturnsAccessDeniedException
after the delete operation completes. -
ACTIVE
- The instance is active.
- Parameters:
describeInstanceRequest
-- Returns:
- A Java Future containing the result of the DescribeInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
describeInstance
default CompletableFuture<DescribeInstanceResponse> describeInstance(Consumer<DescribeInstanceRequest.Builder> describeInstanceRequest) 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_PROGRESS
state, you can call only DescribeInstance and DeleteInstance operations. -
DELETE_IN_PROGRESS
- The instance is being deleted. ReturnsAccessDeniedException
after the delete operation completes. -
ACTIVE
- The instance is active.
This is a convenience which creates an instance of the
DescribeInstanceRequest.Builder
avoiding the need to create one manually viaDescribeInstanceRequest.builder()
- Parameters:
describeInstanceRequest
- AConsumer
that will call methods onDescribeInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
describeInstanceAccessControlAttributeConfiguration
default CompletableFuture<DescribeInstanceAccessControlAttributeConfigurationResponse> describeInstanceAccessControlAttributeConfiguration(DescribeInstanceAccessControlAttributeConfigurationRequest describeInstanceAccessControlAttributeConfigurationRequest) Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
- Parameters:
describeInstanceAccessControlAttributeConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeInstanceAccessControlAttributeConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeInstanceAccessControlAttributeConfiguration
default CompletableFuture<DescribeInstanceAccessControlAttributeConfigurationResponse> describeInstanceAccessControlAttributeConfiguration(Consumer<DescribeInstanceAccessControlAttributeConfigurationRequest.Builder> describeInstanceAccessControlAttributeConfigurationRequest) Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
This is a convenience which creates an instance of the
DescribeInstanceAccessControlAttributeConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeInstanceAccessControlAttributeConfigurationRequest.builder()
- Parameters:
describeInstanceAccessControlAttributeConfigurationRequest
- AConsumer
that will call methods onDescribeInstanceAccessControlAttributeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeInstanceAccessControlAttributeConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePermissionSet
default CompletableFuture<DescribePermissionSetResponse> describePermissionSet(DescribePermissionSetRequest describePermissionSetRequest) Gets the details of the permission set.
- Parameters:
describePermissionSetRequest
-- Returns:
- A Java Future containing the result of the DescribePermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePermissionSet
default CompletableFuture<DescribePermissionSetResponse> describePermissionSet(Consumer<DescribePermissionSetRequest.Builder> describePermissionSetRequest) Gets the details of the permission set.
This is a convenience which creates an instance of the
DescribePermissionSetRequest.Builder
avoiding the need to create one manually viaDescribePermissionSetRequest.builder()
- Parameters:
describePermissionSetRequest
- AConsumer
that will call methods onDescribePermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePermissionSetProvisioningStatus
default CompletableFuture<DescribePermissionSetProvisioningStatusResponse> describePermissionSetProvisioningStatus(DescribePermissionSetProvisioningStatusRequest describePermissionSetProvisioningStatusRequest) Describes the status for the given permission set provisioning request.
- Parameters:
describePermissionSetProvisioningStatusRequest
-- Returns:
- A Java Future containing the result of the DescribePermissionSetProvisioningStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describePermissionSetProvisioningStatus
default CompletableFuture<DescribePermissionSetProvisioningStatusResponse> describePermissionSetProvisioningStatus(Consumer<DescribePermissionSetProvisioningStatusRequest.Builder> describePermissionSetProvisioningStatusRequest) Describes the status for the given permission set provisioning request.
This is a convenience which creates an instance of the
DescribePermissionSetProvisioningStatusRequest.Builder
avoiding the need to create one manually viaDescribePermissionSetProvisioningStatusRequest.builder()
- Parameters:
describePermissionSetProvisioningStatusRequest
- AConsumer
that will call methods onDescribePermissionSetProvisioningStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePermissionSetProvisioningStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeTrustedTokenIssuer
default CompletableFuture<DescribeTrustedTokenIssuerResponse> describeTrustedTokenIssuer(DescribeTrustedTokenIssuerRequest describeTrustedTokenIssuerRequest) 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:
- A Java Future containing the result of the DescribeTrustedTokenIssuer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeTrustedTokenIssuer
default CompletableFuture<DescribeTrustedTokenIssuerResponse> describeTrustedTokenIssuer(Consumer<DescribeTrustedTokenIssuerRequest.Builder> describeTrustedTokenIssuerRequest) 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.Builder
avoiding the need to create one manually viaDescribeTrustedTokenIssuerRequest.builder()
- Parameters:
describeTrustedTokenIssuerRequest
- AConsumer
that will call methods onDescribeTrustedTokenIssuerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTrustedTokenIssuer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachCustomerManagedPolicyReferenceFromPermissionSet
default CompletableFuture<DetachCustomerManagedPolicyReferenceFromPermissionSetResponse> detachCustomerManagedPolicyReferenceFromPermissionSet(DetachCustomerManagedPolicyReferenceFromPermissionSetRequest detachCustomerManagedPolicyReferenceFromPermissionSetRequest) Detaches the specified customer managed policy from the specified PermissionSet.
- Parameters:
detachCustomerManagedPolicyReferenceFromPermissionSetRequest
-- Returns:
- A Java Future containing the result of the DetachCustomerManagedPolicyReferenceFromPermissionSet
operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachCustomerManagedPolicyReferenceFromPermissionSet
default CompletableFuture<DetachCustomerManagedPolicyReferenceFromPermissionSetResponse> detachCustomerManagedPolicyReferenceFromPermissionSet(Consumer<DetachCustomerManagedPolicyReferenceFromPermissionSetRequest.Builder> detachCustomerManagedPolicyReferenceFromPermissionSetRequest) Detaches the specified customer managed policy from the specified PermissionSet.
This is a convenience which creates an instance of the
DetachCustomerManagedPolicyReferenceFromPermissionSetRequest.Builder
avoiding the need to create one manually viaDetachCustomerManagedPolicyReferenceFromPermissionSetRequest.builder()
- Parameters:
detachCustomerManagedPolicyReferenceFromPermissionSetRequest
- AConsumer
that will call methods onDetachCustomerManagedPolicyReferenceFromPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetachCustomerManagedPolicyReferenceFromPermissionSet
operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachManagedPolicyFromPermissionSet
default CompletableFuture<DetachManagedPolicyFromPermissionSetResponse> detachManagedPolicyFromPermissionSet(DetachManagedPolicyFromPermissionSetRequest detachManagedPolicyFromPermissionSetRequest) Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
- Parameters:
detachManagedPolicyFromPermissionSetRequest
-- Returns:
- A Java Future containing the result of the DetachManagedPolicyFromPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
detachManagedPolicyFromPermissionSet
default CompletableFuture<DetachManagedPolicyFromPermissionSetResponse> detachManagedPolicyFromPermissionSet(Consumer<DetachManagedPolicyFromPermissionSetRequest.Builder> detachManagedPolicyFromPermissionSetRequest) 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.Builder
avoiding the need to create one manually viaDetachManagedPolicyFromPermissionSetRequest.builder()
- Parameters:
detachManagedPolicyFromPermissionSetRequest
- AConsumer
that will call methods onDetachManagedPolicyFromPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetachManagedPolicyFromPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getApplicationAccessScope
default CompletableFuture<GetApplicationAccessScopeResponse> getApplicationAccessScope(GetApplicationAccessScopeRequest getApplicationAccessScopeRequest) Retrieves the authorized targets for an IAM Identity Center access scope for an application.
- Parameters:
getApplicationAccessScopeRequest
-- Returns:
- A Java Future containing the result of the GetApplicationAccessScope operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getApplicationAccessScope
default CompletableFuture<GetApplicationAccessScopeResponse> getApplicationAccessScope(Consumer<GetApplicationAccessScopeRequest.Builder> getApplicationAccessScopeRequest) 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.Builder
avoiding the need to create one manually viaGetApplicationAccessScopeRequest.builder()
- Parameters:
getApplicationAccessScopeRequest
- AConsumer
that will call methods onGetApplicationAccessScopeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApplicationAccessScope operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getApplicationAssignmentConfiguration
default CompletableFuture<GetApplicationAssignmentConfigurationResponse> getApplicationAssignmentConfiguration(GetApplicationAssignmentConfigurationRequest getApplicationAssignmentConfigurationRequest) Retrieves the configuration of PutApplicationAssignmentConfiguration.
- Parameters:
getApplicationAssignmentConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetApplicationAssignmentConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getApplicationAssignmentConfiguration
default CompletableFuture<GetApplicationAssignmentConfigurationResponse> getApplicationAssignmentConfiguration(Consumer<GetApplicationAssignmentConfigurationRequest.Builder> getApplicationAssignmentConfigurationRequest) Retrieves the configuration of PutApplicationAssignmentConfiguration.
This is a convenience which creates an instance of the
GetApplicationAssignmentConfigurationRequest.Builder
avoiding the need to create one manually viaGetApplicationAssignmentConfigurationRequest.builder()
- Parameters:
getApplicationAssignmentConfigurationRequest
- AConsumer
that will call methods onGetApplicationAssignmentConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApplicationAssignmentConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getApplicationAuthenticationMethod
default CompletableFuture<GetApplicationAuthenticationMethodResponse> getApplicationAuthenticationMethod(GetApplicationAuthenticationMethodRequest getApplicationAuthenticationMethodRequest) Retrieves details about an authentication method used by an application.
- Parameters:
getApplicationAuthenticationMethodRequest
-- Returns:
- A Java Future containing the result of the GetApplicationAuthenticationMethod operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getApplicationAuthenticationMethod
default CompletableFuture<GetApplicationAuthenticationMethodResponse> getApplicationAuthenticationMethod(Consumer<GetApplicationAuthenticationMethodRequest.Builder> getApplicationAuthenticationMethodRequest) Retrieves details about an authentication method used by an application.
This is a convenience which creates an instance of the
GetApplicationAuthenticationMethodRequest.Builder
avoiding the need to create one manually viaGetApplicationAuthenticationMethodRequest.builder()
- Parameters:
getApplicationAuthenticationMethodRequest
- AConsumer
that will call methods onGetApplicationAuthenticationMethodRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApplicationAuthenticationMethod operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getApplicationGrant
default CompletableFuture<GetApplicationGrantResponse> getApplicationGrant(GetApplicationGrantRequest getApplicationGrantRequest) Retrieves details about an application grant.
- Parameters:
getApplicationGrantRequest
-- Returns:
- A Java Future containing the result of the GetApplicationGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getApplicationGrant
default CompletableFuture<GetApplicationGrantResponse> getApplicationGrant(Consumer<GetApplicationGrantRequest.Builder> getApplicationGrantRequest) Retrieves details about an application grant.
This is a convenience which creates an instance of the
GetApplicationGrantRequest.Builder
avoiding the need to create one manually viaGetApplicationGrantRequest.builder()
- Parameters:
getApplicationGrantRequest
- AConsumer
that will call methods onGetApplicationGrantRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApplicationGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getInlinePolicyForPermissionSet
default CompletableFuture<GetInlinePolicyForPermissionSetResponse> getInlinePolicyForPermissionSet(GetInlinePolicyForPermissionSetRequest getInlinePolicyForPermissionSetRequest) Obtains the inline policy assigned to the permission set.
- Parameters:
getInlinePolicyForPermissionSetRequest
-- Returns:
- A Java Future containing the result of the GetInlinePolicyForPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getInlinePolicyForPermissionSet
default CompletableFuture<GetInlinePolicyForPermissionSetResponse> getInlinePolicyForPermissionSet(Consumer<GetInlinePolicyForPermissionSetRequest.Builder> getInlinePolicyForPermissionSetRequest) Obtains the inline policy assigned to the permission set.
This is a convenience which creates an instance of the
GetInlinePolicyForPermissionSetRequest.Builder
avoiding the need to create one manually viaGetInlinePolicyForPermissionSetRequest.builder()
- Parameters:
getInlinePolicyForPermissionSetRequest
- AConsumer
that will call methods onGetInlinePolicyForPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInlinePolicyForPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPermissionsBoundaryForPermissionSet
default CompletableFuture<GetPermissionsBoundaryForPermissionSetResponse> getPermissionsBoundaryForPermissionSet(GetPermissionsBoundaryForPermissionSetRequest getPermissionsBoundaryForPermissionSetRequest) Obtains the permissions boundary for a specified PermissionSet.
- Parameters:
getPermissionsBoundaryForPermissionSetRequest
-- Returns:
- A Java Future containing the result of the GetPermissionsBoundaryForPermissionSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPermissionsBoundaryForPermissionSet
default CompletableFuture<GetPermissionsBoundaryForPermissionSetResponse> getPermissionsBoundaryForPermissionSet(Consumer<GetPermissionsBoundaryForPermissionSetRequest.Builder> getPermissionsBoundaryForPermissionSetRequest) Obtains the permissions boundary for a specified PermissionSet.
This is a convenience which creates an instance of the
GetPermissionsBoundaryForPermissionSetRequest.Builder
avoiding the need to create one manually viaGetPermissionsBoundaryForPermissionSetRequest.builder()
- Parameters:
getPermissionsBoundaryForPermissionSetRequest
- AConsumer
that will call methods onGetPermissionsBoundaryForPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPermissionsBoundaryForPermissionSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentCreationStatus
default CompletableFuture<ListAccountAssignmentCreationStatusResponse> listAccountAssignmentCreationStatus(ListAccountAssignmentCreationStatusRequest listAccountAssignmentCreationStatusRequest) Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
- Parameters:
listAccountAssignmentCreationStatusRequest
-- Returns:
- A Java Future containing the result of the ListAccountAssignmentCreationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentCreationStatus
default CompletableFuture<ListAccountAssignmentCreationStatusResponse> listAccountAssignmentCreationStatus(Consumer<ListAccountAssignmentCreationStatusRequest.Builder> listAccountAssignmentCreationStatusRequest) 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.Builder
avoiding the need to create one manually viaListAccountAssignmentCreationStatusRequest.builder()
- Parameters:
listAccountAssignmentCreationStatusRequest
- AConsumer
that will call methods onListAccountAssignmentCreationStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccountAssignmentCreationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentCreationStatusPaginator
default ListAccountAssignmentCreationStatusPublisher listAccountAssignmentCreationStatusPaginator(ListAccountAssignmentCreationStatusRequest listAccountAssignmentCreationStatusRequest) This is a variant of
listAccountAssignmentCreationStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusPublisher publisher = client.listAccountAssignmentCreationStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusPublisher publisher = client.listAccountAssignmentCreationStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentCreationStatusPaginator
default ListAccountAssignmentCreationStatusPublisher listAccountAssignmentCreationStatusPaginator(Consumer<ListAccountAssignmentCreationStatusRequest.Builder> listAccountAssignmentCreationStatusRequest) This is a variant of
listAccountAssignmentCreationStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusPublisher publisher = client.listAccountAssignmentCreationStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentCreationStatusPublisher publisher = client.listAccountAssignmentCreationStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentCreationStatusResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListAccountAssignmentCreationStatusRequest.builder()
- Parameters:
listAccountAssignmentCreationStatusRequest
- AConsumer
that will call methods onListAccountAssignmentCreationStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentDeletionStatus
default CompletableFuture<ListAccountAssignmentDeletionStatusResponse> listAccountAssignmentDeletionStatus(ListAccountAssignmentDeletionStatusRequest listAccountAssignmentDeletionStatusRequest) Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
- Parameters:
listAccountAssignmentDeletionStatusRequest
-- Returns:
- A Java Future containing the result of the ListAccountAssignmentDeletionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentDeletionStatus
default CompletableFuture<ListAccountAssignmentDeletionStatusResponse> listAccountAssignmentDeletionStatus(Consumer<ListAccountAssignmentDeletionStatusRequest.Builder> listAccountAssignmentDeletionStatusRequest) 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.Builder
avoiding the need to create one manually viaListAccountAssignmentDeletionStatusRequest.builder()
- Parameters:
listAccountAssignmentDeletionStatusRequest
- AConsumer
that will call methods onListAccountAssignmentDeletionStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccountAssignmentDeletionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentDeletionStatusPaginator
default ListAccountAssignmentDeletionStatusPublisher listAccountAssignmentDeletionStatusPaginator(ListAccountAssignmentDeletionStatusRequest listAccountAssignmentDeletionStatusRequest) This is a variant of
listAccountAssignmentDeletionStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusPublisher publisher = client.listAccountAssignmentDeletionStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusPublisher publisher = client.listAccountAssignmentDeletionStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentDeletionStatusPaginator
default ListAccountAssignmentDeletionStatusPublisher listAccountAssignmentDeletionStatusPaginator(Consumer<ListAccountAssignmentDeletionStatusRequest.Builder> listAccountAssignmentDeletionStatusRequest) This is a variant of
listAccountAssignmentDeletionStatus(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusPublisher publisher = client.listAccountAssignmentDeletionStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentDeletionStatusPublisher publisher = client.listAccountAssignmentDeletionStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentDeletionStatusResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListAccountAssignmentDeletionStatusRequest.builder()
- Parameters:
listAccountAssignmentDeletionStatusRequest
- AConsumer
that will call methods onListAccountAssignmentDeletionStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignments
default CompletableFuture<ListAccountAssignmentsResponse> listAccountAssignments(ListAccountAssignmentsRequest listAccountAssignmentsRequest) Lists the assignee of the specified Amazon Web Services account with the specified permission set.
- Parameters:
listAccountAssignmentsRequest
-- Returns:
- A Java Future containing the result of the ListAccountAssignments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignments
default CompletableFuture<ListAccountAssignmentsResponse> listAccountAssignments(Consumer<ListAccountAssignmentsRequest.Builder> listAccountAssignmentsRequest) 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.Builder
avoiding the need to create one manually viaListAccountAssignmentsRequest.builder()
- Parameters:
listAccountAssignmentsRequest
- AConsumer
that will call methods onListAccountAssignmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccountAssignments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentsForPrincipal
default CompletableFuture<ListAccountAssignmentsForPrincipalResponse> listAccountAssignmentsForPrincipal(ListAccountAssignmentsForPrincipalRequest listAccountAssignmentsForPrincipalRequest) Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
- Parameters:
listAccountAssignmentsForPrincipalRequest
-- Returns:
- A Java Future containing the result of the ListAccountAssignmentsForPrincipal operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentsForPrincipal
default CompletableFuture<ListAccountAssignmentsForPrincipalResponse> listAccountAssignmentsForPrincipal(Consumer<ListAccountAssignmentsForPrincipalRequest.Builder> listAccountAssignmentsForPrincipalRequest) Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
This is a convenience which creates an instance of the
ListAccountAssignmentsForPrincipalRequest.Builder
avoiding the need to create one manually viaListAccountAssignmentsForPrincipalRequest.builder()
- Parameters:
listAccountAssignmentsForPrincipalRequest
- AConsumer
that will call methods onListAccountAssignmentsForPrincipalRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccountAssignmentsForPrincipal operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentsForPrincipalPaginator
default ListAccountAssignmentsForPrincipalPublisher listAccountAssignmentsForPrincipalPaginator(ListAccountAssignmentsForPrincipalRequest listAccountAssignmentsForPrincipalRequest) This is a variant of
listAccountAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalPublisher publisher = client.listAccountAssignmentsForPrincipalPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalPublisher publisher = client.listAccountAssignmentsForPrincipalPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentsForPrincipalPaginator
default ListAccountAssignmentsForPrincipalPublisher listAccountAssignmentsForPrincipalPaginator(Consumer<ListAccountAssignmentsForPrincipalRequest.Builder> listAccountAssignmentsForPrincipalRequest) This is a variant of
listAccountAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalPublisher publisher = client.listAccountAssignmentsForPrincipalPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsForPrincipalPublisher publisher = client.listAccountAssignmentsForPrincipalPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsForPrincipalResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListAccountAssignmentsForPrincipalRequest.builder()
- Parameters:
listAccountAssignmentsForPrincipalRequest
- AConsumer
that will call methods onListAccountAssignmentsForPrincipalRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentsPaginator
default ListAccountAssignmentsPublisher listAccountAssignmentsPaginator(ListAccountAssignmentsRequest listAccountAssignmentsRequest) This is a variant of
listAccountAssignments(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsPublisher publisher = client.listAccountAssignmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsPublisher publisher = client.listAccountAssignmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountAssignmentsPaginator
default ListAccountAssignmentsPublisher listAccountAssignmentsPaginator(Consumer<ListAccountAssignmentsRequest.Builder> listAccountAssignmentsRequest) This is a variant of
listAccountAssignments(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsPublisher publisher = client.listAccountAssignmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountAssignmentsPublisher publisher = client.listAccountAssignmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountAssignmentsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListAccountAssignmentsRequest.builder()
- Parameters:
listAccountAssignmentsRequest
- AConsumer
that will call methods onListAccountAssignmentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountsForProvisionedPermissionSet
default CompletableFuture<ListAccountsForProvisionedPermissionSetResponse> listAccountsForProvisionedPermissionSet(ListAccountsForProvisionedPermissionSetRequest listAccountsForProvisionedPermissionSetRequest) Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
- Parameters:
listAccountsForProvisionedPermissionSetRequest
-- Returns:
- A Java Future containing the result of the ListAccountsForProvisionedPermissionSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountsForProvisionedPermissionSet
default CompletableFuture<ListAccountsForProvisionedPermissionSetResponse> listAccountsForProvisionedPermissionSet(Consumer<ListAccountsForProvisionedPermissionSetRequest.Builder> listAccountsForProvisionedPermissionSetRequest) 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.Builder
avoiding the need to create one manually viaListAccountsForProvisionedPermissionSetRequest.builder()
- Parameters:
listAccountsForProvisionedPermissionSetRequest
- AConsumer
that will call methods onListAccountsForProvisionedPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccountsForProvisionedPermissionSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountsForProvisionedPermissionSetPaginator
default ListAccountsForProvisionedPermissionSetPublisher listAccountsForProvisionedPermissionSetPaginator(ListAccountsForProvisionedPermissionSetRequest listAccountsForProvisionedPermissionSetRequest) This is a variant of
listAccountsForProvisionedPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetPublisher publisher = client.listAccountsForProvisionedPermissionSetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetPublisher publisher = client.listAccountsForProvisionedPermissionSetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountsForProvisionedPermissionSetPaginator
default ListAccountsForProvisionedPermissionSetPublisher listAccountsForProvisionedPermissionSetPaginator(Consumer<ListAccountsForProvisionedPermissionSetRequest.Builder> listAccountsForProvisionedPermissionSetRequest) This is a variant of
listAccountsForProvisionedPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetPublisher publisher = client.listAccountsForProvisionedPermissionSetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListAccountsForProvisionedPermissionSetPublisher publisher = client.listAccountsForProvisionedPermissionSetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListAccountsForProvisionedPermissionSetResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListAccountsForProvisionedPermissionSetRequest.builder()
- Parameters:
listAccountsForProvisionedPermissionSetRequest
- AConsumer
that will call methods onListAccountsForProvisionedPermissionSetRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAccessScopes
default CompletableFuture<ListApplicationAccessScopesResponse> listApplicationAccessScopes(ListApplicationAccessScopesRequest listApplicationAccessScopesRequest) Lists the access scopes and authorized targets associated with an application.
- Parameters:
listApplicationAccessScopesRequest
-- Returns:
- A Java Future containing the result of the ListApplicationAccessScopes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAccessScopes
default CompletableFuture<ListApplicationAccessScopesResponse> listApplicationAccessScopes(Consumer<ListApplicationAccessScopesRequest.Builder> listApplicationAccessScopesRequest) Lists the access scopes and authorized targets associated with an application.
This is a convenience which creates an instance of the
ListApplicationAccessScopesRequest.Builder
avoiding the need to create one manually viaListApplicationAccessScopesRequest.builder()
- Parameters:
listApplicationAccessScopesRequest
- AConsumer
that will call methods onListApplicationAccessScopesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationAccessScopes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAccessScopesPaginator
default ListApplicationAccessScopesPublisher listApplicationAccessScopesPaginator(ListApplicationAccessScopesRequest listApplicationAccessScopesRequest) This is a variant of
listApplicationAccessScopes(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesPublisher publisher = client.listApplicationAccessScopesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesPublisher publisher = client.listApplicationAccessScopesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAccessScopesPaginator
default ListApplicationAccessScopesPublisher listApplicationAccessScopesPaginator(Consumer<ListApplicationAccessScopesRequest.Builder> listApplicationAccessScopesRequest) This is a variant of
listApplicationAccessScopes(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesPublisher publisher = client.listApplicationAccessScopesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAccessScopesPublisher publisher = client.listApplicationAccessScopesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAccessScopesResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListApplicationAccessScopesRequest.builder()
- Parameters:
listApplicationAccessScopesRequest
- AConsumer
that will call methods onListApplicationAccessScopesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAssignments
default CompletableFuture<ListApplicationAssignmentsResponse> listApplicationAssignments(ListApplicationAssignmentsRequest listApplicationAssignmentsRequest) Lists Amazon Web Services account users that are assigned to an application.
- Parameters:
listApplicationAssignmentsRequest
-- Returns:
- A Java Future containing the result of the ListApplicationAssignments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAssignments
default CompletableFuture<ListApplicationAssignmentsResponse> listApplicationAssignments(Consumer<ListApplicationAssignmentsRequest.Builder> listApplicationAssignmentsRequest) Lists Amazon Web Services account users that are assigned to an application.
This is a convenience which creates an instance of the
ListApplicationAssignmentsRequest.Builder
avoiding the need to create one manually viaListApplicationAssignmentsRequest.builder()
- Parameters:
listApplicationAssignmentsRequest
- AConsumer
that will call methods onListApplicationAssignmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationAssignments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAssignmentsForPrincipal
default CompletableFuture<ListApplicationAssignmentsForPrincipalResponse> listApplicationAssignmentsForPrincipal(ListApplicationAssignmentsForPrincipalRequest listApplicationAssignmentsForPrincipalRequest) Lists the applications to which a specified principal is assigned.
- Parameters:
listApplicationAssignmentsForPrincipalRequest
-- Returns:
- A Java Future containing the result of the ListApplicationAssignmentsForPrincipal operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAssignmentsForPrincipal
default CompletableFuture<ListApplicationAssignmentsForPrincipalResponse> listApplicationAssignmentsForPrincipal(Consumer<ListApplicationAssignmentsForPrincipalRequest.Builder> listApplicationAssignmentsForPrincipalRequest) Lists the applications to which a specified principal is assigned.
This is a convenience which creates an instance of the
ListApplicationAssignmentsForPrincipalRequest.Builder
avoiding the need to create one manually viaListApplicationAssignmentsForPrincipalRequest.builder()
- Parameters:
listApplicationAssignmentsForPrincipalRequest
- AConsumer
that will call methods onListApplicationAssignmentsForPrincipalRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationAssignmentsForPrincipal operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAssignmentsForPrincipalPaginator
default ListApplicationAssignmentsForPrincipalPublisher listApplicationAssignmentsForPrincipalPaginator(ListApplicationAssignmentsForPrincipalRequest listApplicationAssignmentsForPrincipalRequest) This is a variant of
listApplicationAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalPublisher publisher = client.listApplicationAssignmentsForPrincipalPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalPublisher publisher = client.listApplicationAssignmentsForPrincipalPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAssignmentsForPrincipalPaginator
default ListApplicationAssignmentsForPrincipalPublisher listApplicationAssignmentsForPrincipalPaginator(Consumer<ListApplicationAssignmentsForPrincipalRequest.Builder> listApplicationAssignmentsForPrincipalRequest) This is a variant of
listApplicationAssignmentsForPrincipal(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalPublisher publisher = client.listApplicationAssignmentsForPrincipalPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsForPrincipalPublisher publisher = client.listApplicationAssignmentsForPrincipalPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsForPrincipalResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListApplicationAssignmentsForPrincipalRequest.builder()
- Parameters:
listApplicationAssignmentsForPrincipalRequest
- AConsumer
that will call methods onListApplicationAssignmentsForPrincipalRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAssignmentsPaginator
default ListApplicationAssignmentsPublisher listApplicationAssignmentsPaginator(ListApplicationAssignmentsRequest listApplicationAssignmentsRequest) This is a variant of
listApplicationAssignments(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsPublisher publisher = client.listApplicationAssignmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsPublisher publisher = client.listApplicationAssignmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAssignmentsPaginator
default ListApplicationAssignmentsPublisher listApplicationAssignmentsPaginator(Consumer<ListApplicationAssignmentsRequest.Builder> listApplicationAssignmentsRequest) This is a variant of
listApplicationAssignments(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsPublisher publisher = client.listApplicationAssignmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAssignmentsPublisher publisher = client.listApplicationAssignmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAssignmentsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListApplicationAssignmentsRequest.builder()
- Parameters:
listApplicationAssignmentsRequest
- AConsumer
that will call methods onListApplicationAssignmentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAuthenticationMethods
default CompletableFuture<ListApplicationAuthenticationMethodsResponse> listApplicationAuthenticationMethods(ListApplicationAuthenticationMethodsRequest listApplicationAuthenticationMethodsRequest) Lists all of the authentication methods supported by the specified application.
- Parameters:
listApplicationAuthenticationMethodsRequest
-- Returns:
- A Java Future containing the result of the ListApplicationAuthenticationMethods operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAuthenticationMethods
default CompletableFuture<ListApplicationAuthenticationMethodsResponse> listApplicationAuthenticationMethods(Consumer<ListApplicationAuthenticationMethodsRequest.Builder> listApplicationAuthenticationMethodsRequest) Lists all of the authentication methods supported by the specified application.
This is a convenience which creates an instance of the
ListApplicationAuthenticationMethodsRequest.Builder
avoiding the need to create one manually viaListApplicationAuthenticationMethodsRequest.builder()
- Parameters:
listApplicationAuthenticationMethodsRequest
- AConsumer
that will call methods onListApplicationAuthenticationMethodsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationAuthenticationMethods operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAuthenticationMethodsPaginator
default ListApplicationAuthenticationMethodsPublisher listApplicationAuthenticationMethodsPaginator(ListApplicationAuthenticationMethodsRequest listApplicationAuthenticationMethodsRequest) This is a variant of
listApplicationAuthenticationMethods(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsPublisher publisher = client.listApplicationAuthenticationMethodsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsPublisher publisher = client.listApplicationAuthenticationMethodsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationAuthenticationMethodsPaginator
default ListApplicationAuthenticationMethodsPublisher listApplicationAuthenticationMethodsPaginator(Consumer<ListApplicationAuthenticationMethodsRequest.Builder> listApplicationAuthenticationMethodsRequest) This is a variant of
listApplicationAuthenticationMethods(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsPublisher publisher = client.listApplicationAuthenticationMethodsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationAuthenticationMethodsPublisher publisher = client.listApplicationAuthenticationMethodsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationAuthenticationMethodsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListApplicationAuthenticationMethodsRequest.builder()
- Parameters:
listApplicationAuthenticationMethodsRequest
- AConsumer
that will call methods onListApplicationAuthenticationMethodsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationGrants
default CompletableFuture<ListApplicationGrantsResponse> listApplicationGrants(ListApplicationGrantsRequest listApplicationGrantsRequest) List the grants associated with an application.
- Parameters:
listApplicationGrantsRequest
-- Returns:
- A Java Future containing the result of the ListApplicationGrants operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationGrants
default CompletableFuture<ListApplicationGrantsResponse> listApplicationGrants(Consumer<ListApplicationGrantsRequest.Builder> listApplicationGrantsRequest) List the grants associated with an application.
This is a convenience which creates an instance of the
ListApplicationGrantsRequest.Builder
avoiding the need to create one manually viaListApplicationGrantsRequest.builder()
- Parameters:
listApplicationGrantsRequest
- AConsumer
that will call methods onListApplicationGrantsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationGrants operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationGrantsPaginator
default ListApplicationGrantsPublisher listApplicationGrantsPaginator(ListApplicationGrantsRequest listApplicationGrantsRequest) This is a variant of
listApplicationGrants(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsPublisher publisher = client.listApplicationGrantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsPublisher publisher = client.listApplicationGrantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationGrantsPaginator
default ListApplicationGrantsPublisher listApplicationGrantsPaginator(Consumer<ListApplicationGrantsRequest.Builder> listApplicationGrantsRequest) This is a variant of
listApplicationGrants(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsPublisher publisher = client.listApplicationGrantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationGrantsPublisher publisher = client.listApplicationGrantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationGrantsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListApplicationGrantsRequest.builder()
- Parameters:
listApplicationGrantsRequest
- AConsumer
that will call methods onListApplicationGrantsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationProviders
default CompletableFuture<ListApplicationProvidersResponse> listApplicationProviders(ListApplicationProvidersRequest listApplicationProvidersRequest) Lists the application providers configured in the IAM Identity Center identity store.
- Parameters:
listApplicationProvidersRequest
-- Returns:
- A Java Future containing the result of the ListApplicationProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationProviders
default CompletableFuture<ListApplicationProvidersResponse> listApplicationProviders(Consumer<ListApplicationProvidersRequest.Builder> listApplicationProvidersRequest) Lists the application providers configured in the IAM Identity Center identity store.
This is a convenience which creates an instance of the
ListApplicationProvidersRequest.Builder
avoiding the need to create one manually viaListApplicationProvidersRequest.builder()
- Parameters:
listApplicationProvidersRequest
- AConsumer
that will call methods onListApplicationProvidersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationProvidersPaginator
default ListApplicationProvidersPublisher listApplicationProvidersPaginator(ListApplicationProvidersRequest listApplicationProvidersRequest) This is a variant of
listApplicationProviders(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersPublisher publisher = client.listApplicationProvidersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersPublisher publisher = client.listApplicationProvidersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationProvidersPaginator
default ListApplicationProvidersPublisher listApplicationProvidersPaginator(Consumer<ListApplicationProvidersRequest.Builder> listApplicationProvidersRequest) This is a variant of
listApplicationProviders(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersPublisher publisher = client.listApplicationProvidersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationProvidersPublisher publisher = client.listApplicationProvidersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationProvidersResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListApplicationProvidersRequest.builder()
- Parameters:
listApplicationProvidersRequest
- AConsumer
that will call methods onListApplicationProvidersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest) Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance in the management account, member accounts must use the
applicationAccount
parameter to filter the list to only applications created from that account.- Parameters:
listApplicationsRequest
-- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance in the management account, member accounts must use the
applicationAccount
parameter to filter the list to only applications created from that account.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListApplicationsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listCustomerManagedPolicyReferencesInPermissionSet
default CompletableFuture<ListCustomerManagedPolicyReferencesInPermissionSetResponse> listCustomerManagedPolicyReferencesInPermissionSet(ListCustomerManagedPolicyReferencesInPermissionSetRequest listCustomerManagedPolicyReferencesInPermissionSetRequest) Lists all customer managed policies attached to a specified PermissionSet.
- Parameters:
listCustomerManagedPolicyReferencesInPermissionSetRequest
-- Returns:
- A Java Future containing the result of the ListCustomerManagedPolicyReferencesInPermissionSet operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listCustomerManagedPolicyReferencesInPermissionSet
default CompletableFuture<ListCustomerManagedPolicyReferencesInPermissionSetResponse> listCustomerManagedPolicyReferencesInPermissionSet(Consumer<ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder> listCustomerManagedPolicyReferencesInPermissionSetRequest) Lists all customer managed policies attached to a specified PermissionSet.
This is a convenience which creates an instance of the
ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder
avoiding the need to create one manually viaListCustomerManagedPolicyReferencesInPermissionSetRequest.builder()
- Parameters:
listCustomerManagedPolicyReferencesInPermissionSetRequest
- AConsumer
that will call methods onListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCustomerManagedPolicyReferencesInPermissionSet operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listCustomerManagedPolicyReferencesInPermissionSetPaginator
default ListCustomerManagedPolicyReferencesInPermissionSetPublisher listCustomerManagedPolicyReferencesInPermissionSetPaginator(ListCustomerManagedPolicyReferencesInPermissionSetRequest listCustomerManagedPolicyReferencesInPermissionSetRequest) This is a variant of
listCustomerManagedPolicyReferencesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetPublisher publisher = client.listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetPublisher publisher = client.listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listCustomerManagedPolicyReferencesInPermissionSetPaginator
default ListCustomerManagedPolicyReferencesInPermissionSetPublisher listCustomerManagedPolicyReferencesInPermissionSetPaginator(Consumer<ListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder> listCustomerManagedPolicyReferencesInPermissionSetRequest) This is a variant of
listCustomerManagedPolicyReferencesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetPublisher publisher = client.listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListCustomerManagedPolicyReferencesInPermissionSetPublisher publisher = client.listCustomerManagedPolicyReferencesInPermissionSetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListCustomerManagedPolicyReferencesInPermissionSetResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListCustomerManagedPolicyReferencesInPermissionSetRequest.builder()
- Parameters:
listCustomerManagedPolicyReferencesInPermissionSetRequest
- AConsumer
that will call methods onListCustomerManagedPolicyReferencesInPermissionSetRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstances
default CompletableFuture<ListInstancesResponse> listInstances(ListInstancesRequest listInstancesRequest) 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:
- A Java Future containing the result of the ListInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstances
default CompletableFuture<ListInstancesResponse> listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest) 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.Builder
avoiding the need to create one manually viaListInstancesRequest.builder()
- Parameters:
listInstancesRequest
- AConsumer
that will call methods onListInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstancesPaginator
This is a variant of
listInstances(software.amazon.awssdk.services.ssoadmin.model.ListInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListInstancesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listInstancesPaginator
default ListInstancesPublisher listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest) This is a variant of
listInstances(software.amazon.awssdk.services.ssoadmin.model.ListInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListInstancesResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListInstancesRequest.builder()
- Parameters:
listInstancesRequest
- AConsumer
that will call methods onListInstancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listManagedPoliciesInPermissionSet
default CompletableFuture<ListManagedPoliciesInPermissionSetResponse> listManagedPoliciesInPermissionSet(ListManagedPoliciesInPermissionSetRequest listManagedPoliciesInPermissionSetRequest) Lists the Amazon Web Services managed policy that is attached to a specified permission set.
- Parameters:
listManagedPoliciesInPermissionSetRequest
-- Returns:
- A Java Future containing the result of the ListManagedPoliciesInPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listManagedPoliciesInPermissionSet
default CompletableFuture<ListManagedPoliciesInPermissionSetResponse> listManagedPoliciesInPermissionSet(Consumer<ListManagedPoliciesInPermissionSetRequest.Builder> listManagedPoliciesInPermissionSetRequest) 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.Builder
avoiding the need to create one manually viaListManagedPoliciesInPermissionSetRequest.builder()
- Parameters:
listManagedPoliciesInPermissionSetRequest
- AConsumer
that will call methods onListManagedPoliciesInPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListManagedPoliciesInPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listManagedPoliciesInPermissionSetPaginator
default ListManagedPoliciesInPermissionSetPublisher listManagedPoliciesInPermissionSetPaginator(ListManagedPoliciesInPermissionSetRequest listManagedPoliciesInPermissionSetRequest) This is a variant of
listManagedPoliciesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetPublisher publisher = client.listManagedPoliciesInPermissionSetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetPublisher publisher = client.listManagedPoliciesInPermissionSetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listManagedPoliciesInPermissionSetPaginator
default ListManagedPoliciesInPermissionSetPublisher listManagedPoliciesInPermissionSetPaginator(Consumer<ListManagedPoliciesInPermissionSetRequest.Builder> listManagedPoliciesInPermissionSetRequest) This is a variant of
listManagedPoliciesInPermissionSet(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetPublisher publisher = client.listManagedPoliciesInPermissionSetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListManagedPoliciesInPermissionSetPublisher publisher = client.listManagedPoliciesInPermissionSetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListManagedPoliciesInPermissionSetResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListManagedPoliciesInPermissionSetRequest.builder()
- Parameters:
listManagedPoliciesInPermissionSetRequest
- AConsumer
that will call methods onListManagedPoliciesInPermissionSetRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetProvisioningStatus
default CompletableFuture<ListPermissionSetProvisioningStatusResponse> listPermissionSetProvisioningStatus(ListPermissionSetProvisioningStatusRequest listPermissionSetProvisioningStatusRequest) Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
- Parameters:
listPermissionSetProvisioningStatusRequest
-- Returns:
- A Java Future containing the result of the ListPermissionSetProvisioningStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetProvisioningStatus
default CompletableFuture<ListPermissionSetProvisioningStatusResponse> listPermissionSetProvisioningStatus(Consumer<ListPermissionSetProvisioningStatusRequest.Builder> listPermissionSetProvisioningStatusRequest) 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.Builder
avoiding the need to create one manually viaListPermissionSetProvisioningStatusRequest.builder()
- Parameters:
listPermissionSetProvisioningStatusRequest
- AConsumer
that will call methods onListPermissionSetProvisioningStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPermissionSetProvisioningStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetProvisioningStatusPaginator
default ListPermissionSetProvisioningStatusPublisher listPermissionSetProvisioningStatusPaginator(ListPermissionSetProvisioningStatusRequest listPermissionSetProvisioningStatusRequest) This is a variant of
listPermissionSetProvisioningStatus(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusPublisher publisher = client.listPermissionSetProvisioningStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusPublisher publisher = client.listPermissionSetProvisioningStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetProvisioningStatusPaginator
default ListPermissionSetProvisioningStatusPublisher listPermissionSetProvisioningStatusPaginator(Consumer<ListPermissionSetProvisioningStatusRequest.Builder> listPermissionSetProvisioningStatusRequest) This is a variant of
listPermissionSetProvisioningStatus(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusPublisher publisher = client.listPermissionSetProvisioningStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetProvisioningStatusPublisher publisher = client.listPermissionSetProvisioningStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetProvisioningStatusResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListPermissionSetProvisioningStatusRequest.builder()
- Parameters:
listPermissionSetProvisioningStatusRequest
- AConsumer
that will call methods onListPermissionSetProvisioningStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSets
default CompletableFuture<ListPermissionSetsResponse> listPermissionSets(ListPermissionSetsRequest listPermissionSetsRequest) Lists the PermissionSets in an IAM Identity Center instance.
- Parameters:
listPermissionSetsRequest
-- Returns:
- A Java Future containing the result of the ListPermissionSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSets
default CompletableFuture<ListPermissionSetsResponse> listPermissionSets(Consumer<ListPermissionSetsRequest.Builder> listPermissionSetsRequest) Lists the PermissionSets in an IAM Identity Center instance.
This is a convenience which creates an instance of the
ListPermissionSetsRequest.Builder
avoiding the need to create one manually viaListPermissionSetsRequest.builder()
- Parameters:
listPermissionSetsRequest
- AConsumer
that will call methods onListPermissionSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPermissionSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetsPaginator
default ListPermissionSetsPublisher listPermissionSetsPaginator(ListPermissionSetsRequest listPermissionSetsRequest) This is a variant of
listPermissionSets(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsPublisher publisher = client.listPermissionSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsPublisher publisher = client.listPermissionSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetsPaginator
default ListPermissionSetsPublisher listPermissionSetsPaginator(Consumer<ListPermissionSetsRequest.Builder> listPermissionSetsRequest) This is a variant of
listPermissionSets(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsPublisher publisher = client.listPermissionSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsPublisher publisher = client.listPermissionSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListPermissionSetsRequest.builder()
- Parameters:
listPermissionSetsRequest
- AConsumer
that will call methods onListPermissionSetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetsProvisionedToAccount
default CompletableFuture<ListPermissionSetsProvisionedToAccountResponse> listPermissionSetsProvisionedToAccount(ListPermissionSetsProvisionedToAccountRequest listPermissionSetsProvisionedToAccountRequest) Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
- Parameters:
listPermissionSetsProvisionedToAccountRequest
-- Returns:
- A Java Future containing the result of the ListPermissionSetsProvisionedToAccount operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetsProvisionedToAccount
default CompletableFuture<ListPermissionSetsProvisionedToAccountResponse> listPermissionSetsProvisionedToAccount(Consumer<ListPermissionSetsProvisionedToAccountRequest.Builder> listPermissionSetsProvisionedToAccountRequest) 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.Builder
avoiding the need to create one manually viaListPermissionSetsProvisionedToAccountRequest.builder()
- Parameters:
listPermissionSetsProvisionedToAccountRequest
- AConsumer
that will call methods onListPermissionSetsProvisionedToAccountRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPermissionSetsProvisionedToAccount operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetsProvisionedToAccountPaginator
default ListPermissionSetsProvisionedToAccountPublisher listPermissionSetsProvisionedToAccountPaginator(ListPermissionSetsProvisionedToAccountRequest listPermissionSetsProvisionedToAccountRequest) This is a variant of
listPermissionSetsProvisionedToAccount(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountPublisher publisher = client.listPermissionSetsProvisionedToAccountPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountPublisher publisher = client.listPermissionSetsProvisionedToAccountPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPermissionSetsProvisionedToAccountPaginator
default ListPermissionSetsProvisionedToAccountPublisher listPermissionSetsProvisionedToAccountPaginator(Consumer<ListPermissionSetsProvisionedToAccountRequest.Builder> listPermissionSetsProvisionedToAccountRequest) This is a variant of
listPermissionSetsProvisionedToAccount(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountPublisher publisher = client.listPermissionSetsProvisionedToAccountPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListPermissionSetsProvisionedToAccountPublisher publisher = client.listPermissionSetsProvisionedToAccountPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListPermissionSetsProvisionedToAccountResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListPermissionSetsProvisionedToAccountRequest.builder()
- Parameters:
listPermissionSetsProvisionedToAccountRequest
- AConsumer
that will call methods onListPermissionSetsProvisionedToAccountRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are attached to a specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags that are attached to a specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListTagsForResourceResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTrustedTokenIssuers
default CompletableFuture<ListTrustedTokenIssuersResponse> listTrustedTokenIssuers(ListTrustedTokenIssuersRequest listTrustedTokenIssuersRequest) Lists all the trusted token issuers configured in an instance of IAM Identity Center.
- Parameters:
listTrustedTokenIssuersRequest
-- Returns:
- A Java Future containing the result of the ListTrustedTokenIssuers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTrustedTokenIssuers
default CompletableFuture<ListTrustedTokenIssuersResponse> listTrustedTokenIssuers(Consumer<ListTrustedTokenIssuersRequest.Builder> listTrustedTokenIssuersRequest) 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.Builder
avoiding the need to create one manually viaListTrustedTokenIssuersRequest.builder()
- Parameters:
listTrustedTokenIssuersRequest
- AConsumer
that will call methods onListTrustedTokenIssuersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTrustedTokenIssuers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTrustedTokenIssuersPaginator
default ListTrustedTokenIssuersPublisher listTrustedTokenIssuersPaginator(ListTrustedTokenIssuersRequest listTrustedTokenIssuersRequest) This is a variant of
listTrustedTokenIssuers(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersPublisher publisher = client.listTrustedTokenIssuersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersPublisher publisher = client.listTrustedTokenIssuersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTrustedTokenIssuersPaginator
default ListTrustedTokenIssuersPublisher listTrustedTokenIssuersPaginator(Consumer<ListTrustedTokenIssuersRequest.Builder> listTrustedTokenIssuersRequest) This is a variant of
listTrustedTokenIssuers(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersPublisher publisher = client.listTrustedTokenIssuersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssoadmin.paginators.ListTrustedTokenIssuersPublisher publisher = client.listTrustedTokenIssuersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssoadmin.model.ListTrustedTokenIssuersResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListTrustedTokenIssuersRequest.builder()
- Parameters:
listTrustedTokenIssuersRequest
- AConsumer
that will call methods onListTrustedTokenIssuersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
provisionPermissionSet
default CompletableFuture<ProvisionPermissionSetResponse> provisionPermissionSet(ProvisionPermissionSetRequest provisionPermissionSetRequest) The process by which a specified permission set is provisioned to the specified target.
- Parameters:
provisionPermissionSetRequest
-- Returns:
- A Java Future containing the result of the ProvisionPermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
provisionPermissionSet
default CompletableFuture<ProvisionPermissionSetResponse> provisionPermissionSet(Consumer<ProvisionPermissionSetRequest.Builder> provisionPermissionSetRequest) 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.Builder
avoiding the need to create one manually viaProvisionPermissionSetRequest.builder()
- Parameters:
provisionPermissionSetRequest
- AConsumer
that will call methods onProvisionPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ProvisionPermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putApplicationAccessScope
default CompletableFuture<PutApplicationAccessScopeResponse> putApplicationAccessScope(PutApplicationAccessScopeRequest putApplicationAccessScopeRequest) Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
- Parameters:
putApplicationAccessScopeRequest
-- Returns:
- A Java Future containing the result of the PutApplicationAccessScope operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putApplicationAccessScope
default CompletableFuture<PutApplicationAccessScopeResponse> putApplicationAccessScope(Consumer<PutApplicationAccessScopeRequest.Builder> putApplicationAccessScopeRequest) 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.Builder
avoiding the need to create one manually viaPutApplicationAccessScopeRequest.builder()
- Parameters:
putApplicationAccessScopeRequest
- AConsumer
that will call methods onPutApplicationAccessScopeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutApplicationAccessScope operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putApplicationAssignmentConfiguration
default CompletableFuture<PutApplicationAssignmentConfigurationResponse> putApplicationAssignmentConfiguration(PutApplicationAssignmentConfigurationRequest putApplicationAssignmentConfigurationRequest) Configure how users gain access to an application. If
AssignmentsRequired
istrue
(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 ifAssignmentsRequired
is set totrue
.- Parameters:
putApplicationAssignmentConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutApplicationAssignmentConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putApplicationAssignmentConfiguration
default CompletableFuture<PutApplicationAssignmentConfigurationResponse> putApplicationAssignmentConfiguration(Consumer<PutApplicationAssignmentConfigurationRequest.Builder> putApplicationAssignmentConfigurationRequest) Configure how users gain access to an application. If
AssignmentsRequired
istrue
(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 ifAssignmentsRequired
is set totrue
.
This is a convenience which creates an instance of the
PutApplicationAssignmentConfigurationRequest.Builder
avoiding the need to create one manually viaPutApplicationAssignmentConfigurationRequest.builder()
- Parameters:
putApplicationAssignmentConfigurationRequest
- AConsumer
that will call methods onPutApplicationAssignmentConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutApplicationAssignmentConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putApplicationAuthenticationMethod
default CompletableFuture<PutApplicationAuthenticationMethodResponse> putApplicationAuthenticationMethod(PutApplicationAuthenticationMethodRequest putApplicationAuthenticationMethodRequest) Adds or updates an authentication method for an application.
- Parameters:
putApplicationAuthenticationMethodRequest
-- Returns:
- A Java Future containing the result of the PutApplicationAuthenticationMethod operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putApplicationAuthenticationMethod
default CompletableFuture<PutApplicationAuthenticationMethodResponse> putApplicationAuthenticationMethod(Consumer<PutApplicationAuthenticationMethodRequest.Builder> putApplicationAuthenticationMethodRequest) Adds or updates an authentication method for an application.
This is a convenience which creates an instance of the
PutApplicationAuthenticationMethodRequest.Builder
avoiding the need to create one manually viaPutApplicationAuthenticationMethodRequest.builder()
- Parameters:
putApplicationAuthenticationMethodRequest
- AConsumer
that will call methods onPutApplicationAuthenticationMethodRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutApplicationAuthenticationMethod operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putApplicationGrant
default CompletableFuture<PutApplicationGrantResponse> putApplicationGrant(PutApplicationGrantRequest putApplicationGrantRequest) Adds a grant to an application.
- Parameters:
putApplicationGrantRequest
-- Returns:
- A Java Future containing the result of the PutApplicationGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putApplicationGrant
default CompletableFuture<PutApplicationGrantResponse> putApplicationGrant(Consumer<PutApplicationGrantRequest.Builder> putApplicationGrantRequest) Adds a grant to an application.
This is a convenience which creates an instance of the
PutApplicationGrantRequest.Builder
avoiding the need to create one manually viaPutApplicationGrantRequest.builder()
- Parameters:
putApplicationGrantRequest
- AConsumer
that will call methods onPutApplicationGrantRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutApplicationGrant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putInlinePolicyToPermissionSet
default CompletableFuture<PutInlinePolicyToPermissionSetResponse> putInlinePolicyToPermissionSet(PutInlinePolicyToPermissionSetRequest putInlinePolicyToPermissionSetRequest) Attaches an inline policy to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet
after this action to apply the corresponding IAM policy updates to all assigned accounts.- Parameters:
putInlinePolicyToPermissionSetRequest
-- Returns:
- A Java Future containing the result of the PutInlinePolicyToPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putInlinePolicyToPermissionSet
default CompletableFuture<PutInlinePolicyToPermissionSetResponse> putInlinePolicyToPermissionSet(Consumer<PutInlinePolicyToPermissionSetRequest.Builder> putInlinePolicyToPermissionSetRequest) Attaches an inline policy to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet
after this action to apply the corresponding IAM policy updates to all assigned accounts.
This is a convenience which creates an instance of the
PutInlinePolicyToPermissionSetRequest.Builder
avoiding the need to create one manually viaPutInlinePolicyToPermissionSetRequest.builder()
- Parameters:
putInlinePolicyToPermissionSetRequest
- AConsumer
that will call methods onPutInlinePolicyToPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutInlinePolicyToPermissionSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putPermissionsBoundaryToPermissionSet
default CompletableFuture<PutPermissionsBoundaryToPermissionSetResponse> putPermissionsBoundaryToPermissionSet(PutPermissionsBoundaryToPermissionSetRequest putPermissionsBoundaryToPermissionSetRequest) Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
- Parameters:
putPermissionsBoundaryToPermissionSetRequest
-- Returns:
- A Java Future containing the result of the PutPermissionsBoundaryToPermissionSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putPermissionsBoundaryToPermissionSet
default CompletableFuture<PutPermissionsBoundaryToPermissionSetResponse> putPermissionsBoundaryToPermissionSet(Consumer<PutPermissionsBoundaryToPermissionSetRequest.Builder> putPermissionsBoundaryToPermissionSetRequest) 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.Builder
avoiding the need to create one manually viaPutPermissionsBoundaryToPermissionSetRequest.builder()
- Parameters:
putPermissionsBoundaryToPermissionSetRequest
- AConsumer
that will call methods onPutPermissionsBoundaryToPermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutPermissionsBoundaryToPermissionSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagResource
Associates a set of tags with a specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates a set of tags with a specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Disassociates a set of tags from a specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Disassociates a set of tags from a specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates application properties.
- Parameters:
updateApplicationRequest
-- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates application properties.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateInstance
default CompletableFuture<UpdateInstanceResponse> updateInstance(UpdateInstanceRequest updateInstanceRequest) Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
- Parameters:
updateInstanceRequest
-- Returns:
- A Java Future containing the result of the UpdateInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateInstance
default CompletableFuture<UpdateInstanceResponse> updateInstance(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest) 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.Builder
avoiding the need to create one manually viaUpdateInstanceRequest.builder()
- Parameters:
updateInstanceRequest
- AConsumer
that will call methods onUpdateInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateInstanceAccessControlAttributeConfiguration
default CompletableFuture<UpdateInstanceAccessControlAttributeConfigurationResponse> updateInstanceAccessControlAttributeConfiguration(UpdateInstanceAccessControlAttributeConfigurationRequest updateInstanceAccessControlAttributeConfigurationRequest) Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
- Parameters:
updateInstanceAccessControlAttributeConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateInstanceAccessControlAttributeConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateInstanceAccessControlAttributeConfiguration
default CompletableFuture<UpdateInstanceAccessControlAttributeConfigurationResponse> updateInstanceAccessControlAttributeConfiguration(Consumer<UpdateInstanceAccessControlAttributeConfigurationRequest.Builder> updateInstanceAccessControlAttributeConfigurationRequest) Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
This is a convenience which creates an instance of the
UpdateInstanceAccessControlAttributeConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateInstanceAccessControlAttributeConfigurationRequest.builder()
- Parameters:
updateInstanceAccessControlAttributeConfigurationRequest
- AConsumer
that will call methods onUpdateInstanceAccessControlAttributeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateInstanceAccessControlAttributeConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updatePermissionSet
default CompletableFuture<UpdatePermissionSetResponse> updatePermissionSet(UpdatePermissionSetRequest updatePermissionSetRequest) Updates an existing permission set.
- Parameters:
updatePermissionSetRequest
-- Returns:
- A Java Future containing the result of the UpdatePermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updatePermissionSet
default CompletableFuture<UpdatePermissionSetResponse> updatePermissionSet(Consumer<UpdatePermissionSetRequest.Builder> updatePermissionSetRequest) Updates an existing permission set.
This is a convenience which creates an instance of the
UpdatePermissionSetRequest.Builder
avoiding the need to create one manually viaUpdatePermissionSetRequest.builder()
- Parameters:
updatePermissionSetRequest
- AConsumer
that will call methods onUpdatePermissionSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePermissionSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateTrustedTokenIssuer
default CompletableFuture<UpdateTrustedTokenIssuerResponse> updateTrustedTokenIssuer(UpdateTrustedTokenIssuerRequest updateTrustedTokenIssuerRequest) 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:
- A Java Future containing the result of the UpdateTrustedTokenIssuer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateTrustedTokenIssuer
default CompletableFuture<UpdateTrustedTokenIssuerResponse> updateTrustedTokenIssuer(Consumer<UpdateTrustedTokenIssuerRequest.Builder> updateTrustedTokenIssuerRequest) 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.Builder
avoiding the need to create one manually viaUpdateTrustedTokenIssuerRequest.builder()
- Parameters:
updateTrustedTokenIssuerRequest
- AConsumer
that will call methods onUpdateTrustedTokenIssuerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTrustedTokenIssuer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSsoAdminAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSsoAdminAsyncClient
.
-