Package software.amazon.awssdk.services.licensemanagerusersubscriptions

Interface LicenseManagerUserSubscriptionsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface LicenseManagerUserSubscriptionsClient
extends AwsClient

Service client for accessing AWS License Manager User Subscriptions. This can be created using the static builder() method.

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateUserResponse	associateUser(Consumer<AssociateUserRequest.Builder> associateUserRequest)	Associates the user to an EC2 instance to utilize user-based subscriptions.
default AssociateUserResponse	associateUser(AssociateUserRequest associateUserRequest)	Associates the user to an EC2 instance to utilize user-based subscriptions.
static LicenseManagerUserSubscriptionsClientBuilder	builder()	Create a builder that can be used to configure and create a LicenseManagerUserSubscriptionsClient.
static LicenseManagerUserSubscriptionsClient	create()	Create a LicenseManagerUserSubscriptionsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeregisterIdentityProviderResponse	deregisterIdentityProvider(Consumer<DeregisterIdentityProviderRequest.Builder> deregisterIdentityProviderRequest)	Deregisters the identity provider from providing user-based subscriptions.
default DeregisterIdentityProviderResponse	deregisterIdentityProvider(DeregisterIdentityProviderRequest deregisterIdentityProviderRequest)	Deregisters the identity provider from providing user-based subscriptions.
default DisassociateUserResponse	disassociateUser(Consumer<DisassociateUserRequest.Builder> disassociateUserRequest)	Disassociates the user from an EC2 instance providing user-based subscriptions.
default DisassociateUserResponse	disassociateUser(DisassociateUserRequest disassociateUserRequest)	Disassociates the user from an EC2 instance providing user-based subscriptions.
default ListIdentityProvidersResponse	listIdentityProviders(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)	Lists the identity providers for user-based subscriptions.
default ListIdentityProvidersResponse	listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)	Lists the identity providers for user-based subscriptions.
default ListIdentityProvidersIterable	listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)	Lists the identity providers for user-based subscriptions.
default ListIdentityProvidersIterable	listIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest)	Lists the identity providers for user-based subscriptions.
default ListInstancesResponse	listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest)	Lists the EC2 instances providing user-based subscriptions.
default ListInstancesResponse	listInstances(ListInstancesRequest listInstancesRequest)	Lists the EC2 instances providing user-based subscriptions.
default ListInstancesIterable	listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest)	Lists the EC2 instances providing user-based subscriptions.
default ListInstancesIterable	listInstancesPaginator(ListInstancesRequest listInstancesRequest)	Lists the EC2 instances providing user-based subscriptions.
default ListProductSubscriptionsResponse	listProductSubscriptions(Consumer<ListProductSubscriptionsRequest.Builder> listProductSubscriptionsRequest)	Lists the user-based subscription products available from an identity provider.
default ListProductSubscriptionsResponse	listProductSubscriptions(ListProductSubscriptionsRequest listProductSubscriptionsRequest)	Lists the user-based subscription products available from an identity provider.
default ListProductSubscriptionsIterable	listProductSubscriptionsPaginator(Consumer<ListProductSubscriptionsRequest.Builder> listProductSubscriptionsRequest)	Lists the user-based subscription products available from an identity provider.
default ListProductSubscriptionsIterable	listProductSubscriptionsPaginator(ListProductSubscriptionsRequest listProductSubscriptionsRequest)	Lists the user-based subscription products available from an identity provider.
default ListUserAssociationsResponse	listUserAssociations(Consumer<ListUserAssociationsRequest.Builder> listUserAssociationsRequest)	Lists user associations for an identity provider.
default ListUserAssociationsResponse	listUserAssociations(ListUserAssociationsRequest listUserAssociationsRequest)	Lists user associations for an identity provider.
default ListUserAssociationsIterable	listUserAssociationsPaginator(Consumer<ListUserAssociationsRequest.Builder> listUserAssociationsRequest)	Lists user associations for an identity provider.
default ListUserAssociationsIterable	listUserAssociationsPaginator(ListUserAssociationsRequest listUserAssociationsRequest)	Lists user associations for an identity provider.
default RegisterIdentityProviderResponse	registerIdentityProvider(Consumer<RegisterIdentityProviderRequest.Builder> registerIdentityProviderRequest)	Registers an identity provider for user-based subscriptions.
default RegisterIdentityProviderResponse	registerIdentityProvider(RegisterIdentityProviderRequest registerIdentityProviderRequest)	Registers an identity provider for user-based subscriptions.
default LicenseManagerUserSubscriptionsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartProductSubscriptionResponse	startProductSubscription(Consumer<StartProductSubscriptionRequest.Builder> startProductSubscriptionRequest)	Starts a product subscription for a user with the specified identity provider.
default StartProductSubscriptionResponse	startProductSubscription(StartProductSubscriptionRequest startProductSubscriptionRequest)	Starts a product subscription for a user with the specified identity provider.
default StopProductSubscriptionResponse	stopProductSubscription(Consumer<StopProductSubscriptionRequest.Builder> stopProductSubscriptionRequest)	Stops a product subscription for a user with the specified identity provider.
default StopProductSubscriptionResponse	stopProductSubscription(StopProductSubscriptionRequest stopProductSubscriptionRequest)	Stops a product subscription for a user with the specified identity provider.
default UpdateIdentityProviderSettingsResponse	updateIdentityProviderSettings(Consumer<UpdateIdentityProviderSettingsRequest.Builder> updateIdentityProviderSettingsRequest)	Updates additional product configuration settings for the registered identity provider.
default UpdateIdentityProviderSettingsResponse	updateIdentityProviderSettings(UpdateIdentityProviderSettingsRequest updateIdentityProviderSettingsRequest)	Updates additional product configuration settings for the registered identity provider.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

associateUser

default AssociateUserResponse associateUser(AssociateUserRequest associateUserRequest)
                                     throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Associates the user to an EC2 instance to utilize user-based subscriptions.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

Parameters:

associateUserRequest -

Returns:

Result of the AssociateUser operation returned by the service.

See Also:

• AWS API Documentation

associateUser

default AssociateUserResponse associateUser(Consumer<AssociateUserRequest.Builder> associateUserRequest)
                                     throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Associates the user to an EC2 instance to utilize user-based subscriptions.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

This is a convenience which creates an instance of the AssociateUserRequest.Builder avoiding the need to create one manually via AssociateUserRequest.builder()

Parameters:

associateUserRequest - A Consumer that will call methods on AssociateUserRequest.Builder to create a request.

Returns:

Result of the AssociateUser operation returned by the service.

See Also:

• AWS API Documentation

deregisterIdentityProvider

default DeregisterIdentityProviderResponse deregisterIdentityProvider(DeregisterIdentityProviderRequest deregisterIdentityProviderRequest)
                                                               throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Deregisters the identity provider from providing user-based subscriptions.

Parameters:

deregisterIdentityProviderRequest -

Returns:

Result of the DeregisterIdentityProvider operation returned by the service.

See Also:

• AWS API Documentation

deregisterIdentityProvider

default DeregisterIdentityProviderResponse deregisterIdentityProvider(Consumer<DeregisterIdentityProviderRequest.Builder> deregisterIdentityProviderRequest)
                                                               throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Deregisters the identity provider from providing user-based subscriptions.

This is a convenience which creates an instance of the DeregisterIdentityProviderRequest.Builder avoiding the need to create one manually via DeregisterIdentityProviderRequest.builder()

Parameters:

deregisterIdentityProviderRequest - A Consumer that will call methods on DeregisterIdentityProviderRequest.Builder to create a request.

Returns:

Result of the DeregisterIdentityProvider operation returned by the service.

See Also:

• AWS API Documentation

disassociateUser

default DisassociateUserResponse disassociateUser(DisassociateUserRequest disassociateUserRequest)
                                           throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Disassociates the user from an EC2 instance providing user-based subscriptions.

Parameters:

disassociateUserRequest -

Returns:

Result of the DisassociateUser operation returned by the service.

See Also:

• AWS API Documentation

disassociateUser

default DisassociateUserResponse disassociateUser(Consumer<DisassociateUserRequest.Builder> disassociateUserRequest)
                                           throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Disassociates the user from an EC2 instance providing user-based subscriptions.

This is a convenience which creates an instance of the DisassociateUserRequest.Builder avoiding the need to create one manually via DisassociateUserRequest.builder()

Parameters:

disassociateUserRequest - A Consumer that will call methods on DisassociateUserRequest.Builder to create a request.

Returns:

Result of the DisassociateUser operation returned by the service.

See Also:

• AWS API Documentation

listIdentityProviders

default ListIdentityProvidersResponse listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
                                                     throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the identity providers for user-based subscriptions.

Parameters:

listIdentityProvidersRequest -

Returns:

Result of the ListIdentityProviders operation returned by the service.

See Also:

• AWS API Documentation

listIdentityProviders

default ListIdentityProvidersResponse listIdentityProviders(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)
                                                     throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the identity providers for user-based subscriptions.

This is a convenience which creates an instance of the ListIdentityProvidersRequest.Builder avoiding the need to create one manually via ListIdentityProvidersRequest.builder()

Parameters:

listIdentityProvidersRequest - A Consumer that will call methods on ListIdentityProvidersRequest.Builder to create a request.

Returns:

Result of the ListIdentityProviders operation returned by the service.

See Also:

• AWS API Documentation

listIdentityProvidersPaginator

default ListIdentityProvidersIterable listIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest)
                                                              throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the identity providers for user-based subscriptions.

This is a variant of listIdentityProviders(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListIdentityProvidersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListIdentityProvidersIterable responses = client
             .listIdentityProvidersPaginator(request);
     for (software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListIdentityProvidersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listIdentityProviders(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListIdentityProvidersRequest) operation.

Parameters:

listIdentityProvidersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIdentityProvidersPaginator

default ListIdentityProvidersIterable listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)
                                                              throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the identity providers for user-based subscriptions.

This is a variant of listIdentityProviders(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListIdentityProvidersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListIdentityProvidersIterable responses = client
             .listIdentityProvidersPaginator(request);
     for (software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListIdentityProvidersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listIdentityProviders(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListIdentityProvidersRequest) operation.

This is a convenience which creates an instance of the ListIdentityProvidersRequest.Builder avoiding the need to create one manually via ListIdentityProvidersRequest.builder()

Parameters:

listIdentityProvidersRequest - A Consumer that will call methods on ListIdentityProvidersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInstances

default ListInstancesResponse listInstances(ListInstancesRequest listInstancesRequest)
                                     throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the EC2 instances providing user-based subscriptions.

Parameters:

listInstancesRequest -

Returns:

Result of the ListInstances operation returned by the service.

See Also:

• AWS API Documentation

listInstances

default ListInstancesResponse listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest)
                                     throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the EC2 instances providing user-based subscriptions.

This is a convenience which creates an instance of the ListInstancesRequest.Builder avoiding the need to create one manually via ListInstancesRequest.builder()

Parameters:

listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.

Returns:

Result of the ListInstances operation returned by the service.

See Also:

• AWS API Documentation

listInstancesPaginator

default ListInstancesIterable listInstancesPaginator(ListInstancesRequest listInstancesRequest)
                                              throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the EC2 instances providing user-based subscriptions.

This is a variant of listInstances(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListInstancesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListInstancesIterable responses = client
             .listInstancesPaginator(request);
     for (software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInstances(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListInstancesRequest) operation.

Parameters:

listInstancesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInstancesPaginator

default ListInstancesIterable listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest)
                                              throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the EC2 instances providing user-based subscriptions.

This is a variant of listInstances(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListInstancesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListInstancesIterable responses = client
             .listInstancesPaginator(request);
     for (software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInstances(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListInstancesRequest) operation.

This is a convenience which creates an instance of the ListInstancesRequest.Builder avoiding the need to create one manually via ListInstancesRequest.builder()

Parameters:

listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProductSubscriptions

default ListProductSubscriptionsResponse listProductSubscriptions(ListProductSubscriptionsRequest listProductSubscriptionsRequest)
                                                           throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the user-based subscription products available from an identity provider.

Parameters:

listProductSubscriptionsRequest -

Returns:

Result of the ListProductSubscriptions operation returned by the service.

See Also:

• AWS API Documentation

listProductSubscriptions

default ListProductSubscriptionsResponse listProductSubscriptions(Consumer<ListProductSubscriptionsRequest.Builder> listProductSubscriptionsRequest)
                                                           throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the user-based subscription products available from an identity provider.

This is a convenience which creates an instance of the ListProductSubscriptionsRequest.Builder avoiding the need to create one manually via ListProductSubscriptionsRequest.builder()

Parameters:

listProductSubscriptionsRequest - A Consumer that will call methods on ListProductSubscriptionsRequest.Builder to create a request.

Returns:

Result of the ListProductSubscriptions operation returned by the service.

See Also:

• AWS API Documentation

listProductSubscriptionsPaginator

default ListProductSubscriptionsIterable listProductSubscriptionsPaginator(ListProductSubscriptionsRequest listProductSubscriptionsRequest)
                                                                    throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the user-based subscription products available from an identity provider.

This is a variant of listProductSubscriptions(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListProductSubscriptionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListProductSubscriptionsIterable responses = client.listProductSubscriptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListProductSubscriptionsIterable responses = client
             .listProductSubscriptionsPaginator(request);
     for (software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListProductSubscriptionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListProductSubscriptionsIterable responses = client.listProductSubscriptionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProductSubscriptions(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListProductSubscriptionsRequest) operation.

Parameters:

listProductSubscriptionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProductSubscriptionsPaginator

default ListProductSubscriptionsIterable listProductSubscriptionsPaginator(Consumer<ListProductSubscriptionsRequest.Builder> listProductSubscriptionsRequest)
                                                                    throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists the user-based subscription products available from an identity provider.

This is a variant of listProductSubscriptions(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListProductSubscriptionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListProductSubscriptionsIterable responses = client.listProductSubscriptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListProductSubscriptionsIterable responses = client
             .listProductSubscriptionsPaginator(request);
     for (software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListProductSubscriptionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListProductSubscriptionsIterable responses = client.listProductSubscriptionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProductSubscriptions(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListProductSubscriptionsRequest) operation.

This is a convenience which creates an instance of the ListProductSubscriptionsRequest.Builder avoiding the need to create one manually via ListProductSubscriptionsRequest.builder()

Parameters:

listProductSubscriptionsRequest - A Consumer that will call methods on ListProductSubscriptionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUserAssociations

default ListUserAssociationsResponse listUserAssociations(ListUserAssociationsRequest listUserAssociationsRequest)
                                                   throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists user associations for an identity provider.

Parameters:

listUserAssociationsRequest -

Returns:

Result of the ListUserAssociations operation returned by the service.

See Also:

• AWS API Documentation

listUserAssociations

default ListUserAssociationsResponse listUserAssociations(Consumer<ListUserAssociationsRequest.Builder> listUserAssociationsRequest)
                                                   throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists user associations for an identity provider.

This is a convenience which creates an instance of the ListUserAssociationsRequest.Builder avoiding the need to create one manually via ListUserAssociationsRequest.builder()

Parameters:

listUserAssociationsRequest - A Consumer that will call methods on ListUserAssociationsRequest.Builder to create a request.

Returns:

Result of the ListUserAssociations operation returned by the service.

See Also:

• AWS API Documentation

listUserAssociationsPaginator

default ListUserAssociationsIterable listUserAssociationsPaginator(ListUserAssociationsRequest listUserAssociationsRequest)
                                                            throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists user associations for an identity provider.

This is a variant of listUserAssociations(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListUserAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListUserAssociationsIterable responses = client.listUserAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListUserAssociationsIterable responses = client
             .listUserAssociationsPaginator(request);
     for (software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListUserAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListUserAssociationsIterable responses = client.listUserAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUserAssociations(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListUserAssociationsRequest) operation.

Parameters:

listUserAssociationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUserAssociationsPaginator

default ListUserAssociationsIterable listUserAssociationsPaginator(Consumer<ListUserAssociationsRequest.Builder> listUserAssociationsRequest)
                                                            throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Lists user associations for an identity provider.

This is a variant of listUserAssociations(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListUserAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListUserAssociationsIterable responses = client.listUserAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListUserAssociationsIterable responses = client
             .listUserAssociationsPaginator(request);
     for (software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListUserAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.licensemanagerusersubscriptions.paginators.ListUserAssociationsIterable responses = client.listUserAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUserAssociations(software.amazon.awssdk.services.licensemanagerusersubscriptions.model.ListUserAssociationsRequest) operation.

This is a convenience which creates an instance of the ListUserAssociationsRequest.Builder avoiding the need to create one manually via ListUserAssociationsRequest.builder()

Parameters:

listUserAssociationsRequest - A Consumer that will call methods on ListUserAssociationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

registerIdentityProvider

default RegisterIdentityProviderResponse registerIdentityProvider(RegisterIdentityProviderRequest registerIdentityProviderRequest)
                                                           throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Registers an identity provider for user-based subscriptions.

Parameters:

registerIdentityProviderRequest -

Returns:

Result of the RegisterIdentityProvider operation returned by the service.

See Also:

• AWS API Documentation

registerIdentityProvider

default RegisterIdentityProviderResponse registerIdentityProvider(Consumer<RegisterIdentityProviderRequest.Builder> registerIdentityProviderRequest)
                                                           throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Registers an identity provider for user-based subscriptions.

This is a convenience which creates an instance of the RegisterIdentityProviderRequest.Builder avoiding the need to create one manually via RegisterIdentityProviderRequest.builder()

Parameters:

registerIdentityProviderRequest - A Consumer that will call methods on RegisterIdentityProviderRequest.Builder to create a request.

Returns:

Result of the RegisterIdentityProvider operation returned by the service.

See Also:

• AWS API Documentation

startProductSubscription

default StartProductSubscriptionResponse startProductSubscription(StartProductSubscriptionRequest startProductSubscriptionRequest)
                                                           throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Starts a product subscription for a user with the specified identity provider.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

Parameters:

startProductSubscriptionRequest -

Returns:

Result of the StartProductSubscription operation returned by the service.

See Also:

• AWS API Documentation

startProductSubscription

default StartProductSubscriptionResponse startProductSubscription(Consumer<StartProductSubscriptionRequest.Builder> startProductSubscriptionRequest)
                                                           throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Starts a product subscription for a user with the specified identity provider.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

This is a convenience which creates an instance of the StartProductSubscriptionRequest.Builder avoiding the need to create one manually via StartProductSubscriptionRequest.builder()

Parameters:

startProductSubscriptionRequest - A Consumer that will call methods on StartProductSubscriptionRequest.Builder to create a request.

Returns:

Result of the StartProductSubscription operation returned by the service.

See Also:

• AWS API Documentation

stopProductSubscription

default StopProductSubscriptionResponse stopProductSubscription(StopProductSubscriptionRequest stopProductSubscriptionRequest)
                                                         throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Stops a product subscription for a user with the specified identity provider.

Parameters:

stopProductSubscriptionRequest -

Returns:

Result of the StopProductSubscription operation returned by the service.

See Also:

• AWS API Documentation

stopProductSubscription

default StopProductSubscriptionResponse stopProductSubscription(Consumer<StopProductSubscriptionRequest.Builder> stopProductSubscriptionRequest)
                                                         throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Stops a product subscription for a user with the specified identity provider.

This is a convenience which creates an instance of the StopProductSubscriptionRequest.Builder avoiding the need to create one manually via StopProductSubscriptionRequest.builder()

Parameters:

stopProductSubscriptionRequest - A Consumer that will call methods on StopProductSubscriptionRequest.Builder to create a request.

Returns:

Result of the StopProductSubscription operation returned by the service.

See Also:

• AWS API Documentation

updateIdentityProviderSettings

default UpdateIdentityProviderSettingsResponse updateIdentityProviderSettings(UpdateIdentityProviderSettingsRequest updateIdentityProviderSettingsRequest)
                                                                       throws ValidationException,
ThrottlingException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Updates additional product configuration settings for the registered identity provider.

Parameters:

updateIdentityProviderSettingsRequest -

Returns:

Result of the UpdateIdentityProviderSettings operation returned by the service.

See Also:

• AWS API Documentation

updateIdentityProviderSettings

default UpdateIdentityProviderSettingsResponse updateIdentityProviderSettings(Consumer<UpdateIdentityProviderSettingsRequest.Builder> updateIdentityProviderSettingsRequest)
                                                                       throws ValidationException,
ThrottlingException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
LicenseManagerUserSubscriptionsException

Updates additional product configuration settings for the registered identity provider.

This is a convenience which creates an instance of the UpdateIdentityProviderSettingsRequest.Builder avoiding the need to create one manually via UpdateIdentityProviderSettingsRequest.builder()

Parameters:

updateIdentityProviderSettingsRequest - A Consumer that will call methods on UpdateIdentityProviderSettingsRequest.Builder to create a request.

Returns:

Result of the UpdateIdentityProviderSettings operation returned by the service.

See Also:

• AWS API Documentation

create

static LicenseManagerUserSubscriptionsClient create()

Create a LicenseManagerUserSubscriptionsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static LicenseManagerUserSubscriptionsClientBuilder builder()

Create a builder that can be used to configure and create a LicenseManagerUserSubscriptionsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default LicenseManagerUserSubscriptionsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration