Interface PartnerCentralBenefitsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing PartnerCentral Benefits. This can be created using the static builder() method.

AWS Partner Central Benefits Service provides APIs for managing partner benefits, applications, and allocations within the AWS Partner Network ecosystem.

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 AmendBenefitApplicationResponse	amendBenefitApplication(Consumer<AmendBenefitApplicationRequest.Builder> amendBenefitApplicationRequest)	Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.
default AmendBenefitApplicationResponse	amendBenefitApplication(AmendBenefitApplicationRequest amendBenefitApplicationRequest)	Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.
default AssociateBenefitApplicationResourceResponse	associateBenefitApplicationResource(Consumer<AssociateBenefitApplicationResourceRequest.Builder> associateBenefitApplicationResourceRequest)	Links an AWS resource to an existing benefit application for tracking and management purposes.
default AssociateBenefitApplicationResourceResponse	associateBenefitApplicationResource(AssociateBenefitApplicationResourceRequest associateBenefitApplicationResourceRequest)	Links an AWS resource to an existing benefit application for tracking and management purposes.
static PartnerCentralBenefitsClientBuilder	builder()	Create a builder that can be used to configure and create a PartnerCentralBenefitsClient.
default CancelBenefitApplicationResponse	cancelBenefitApplication(Consumer<CancelBenefitApplicationRequest.Builder> cancelBenefitApplicationRequest)	Cancels a benefit application that is currently in progress, preventing further processing.
default CancelBenefitApplicationResponse	cancelBenefitApplication(CancelBenefitApplicationRequest cancelBenefitApplicationRequest)	Cancels a benefit application that is currently in progress, preventing further processing.
static PartnerCentralBenefitsClient	create()	Create a PartnerCentralBenefitsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateBenefitApplicationResponse	createBenefitApplication(Consumer<CreateBenefitApplicationRequest.Builder> createBenefitApplicationRequest)	Creates a new benefit application for a partner to request access to AWS benefits and programs.
default CreateBenefitApplicationResponse	createBenefitApplication(CreateBenefitApplicationRequest createBenefitApplicationRequest)	Creates a new benefit application for a partner to request access to AWS benefits and programs.
default DisassociateBenefitApplicationResourceResponse	disassociateBenefitApplicationResource(Consumer<DisassociateBenefitApplicationResourceRequest.Builder> disassociateBenefitApplicationResourceRequest)	Removes the association between an AWS resource and a benefit application.
default DisassociateBenefitApplicationResourceResponse	disassociateBenefitApplicationResource(DisassociateBenefitApplicationResourceRequest disassociateBenefitApplicationResourceRequest)	Removes the association between an AWS resource and a benefit application.
default GetBenefitResponse	getBenefit(Consumer<GetBenefitRequest.Builder> getBenefitRequest)	Retrieves detailed information about a specific benefit available in the partner catalog.
default GetBenefitResponse	getBenefit(GetBenefitRequest getBenefitRequest)	Retrieves detailed information about a specific benefit available in the partner catalog.
default GetBenefitAllocationResponse	getBenefitAllocation(Consumer<GetBenefitAllocationRequest.Builder> getBenefitAllocationRequest)	Retrieves detailed information about a specific benefit allocation that has been granted to a partner.
default GetBenefitAllocationResponse	getBenefitAllocation(GetBenefitAllocationRequest getBenefitAllocationRequest)	Retrieves detailed information about a specific benefit allocation that has been granted to a partner.
default GetBenefitApplicationResponse	getBenefitApplication(Consumer<GetBenefitApplicationRequest.Builder> getBenefitApplicationRequest)	Retrieves detailed information about a specific benefit application.
default GetBenefitApplicationResponse	getBenefitApplication(GetBenefitApplicationRequest getBenefitApplicationRequest)	Retrieves detailed information about a specific benefit application.
default ListBenefitAllocationsResponse	listBenefitAllocations(Consumer<ListBenefitAllocationsRequest.Builder> listBenefitAllocationsRequest)	Retrieves a paginated list of benefit allocations based on specified filter criteria.
default ListBenefitAllocationsResponse	listBenefitAllocations(ListBenefitAllocationsRequest listBenefitAllocationsRequest)	Retrieves a paginated list of benefit allocations based on specified filter criteria.
default ListBenefitAllocationsIterable	listBenefitAllocationsPaginator(Consumer<ListBenefitAllocationsRequest.Builder> listBenefitAllocationsRequest)	This is a variant of listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) operation.
default ListBenefitAllocationsIterable	listBenefitAllocationsPaginator(ListBenefitAllocationsRequest listBenefitAllocationsRequest)	This is a variant of listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) operation.
default ListBenefitApplicationsResponse	listBenefitApplications(Consumer<ListBenefitApplicationsRequest.Builder> listBenefitApplicationsRequest)	Retrieves a paginated list of benefit applications based on specified filter criteria.
default ListBenefitApplicationsResponse	listBenefitApplications(ListBenefitApplicationsRequest listBenefitApplicationsRequest)	Retrieves a paginated list of benefit applications based on specified filter criteria.
default ListBenefitApplicationsIterable	listBenefitApplicationsPaginator(Consumer<ListBenefitApplicationsRequest.Builder> listBenefitApplicationsRequest)	This is a variant of listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) operation.
default ListBenefitApplicationsIterable	listBenefitApplicationsPaginator(ListBenefitApplicationsRequest listBenefitApplicationsRequest)	This is a variant of listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) operation.
default ListBenefitsResponse	listBenefits(Consumer<ListBenefitsRequest.Builder> listBenefitsRequest)	Retrieves a paginated list of available benefits based on specified filter criteria.
default ListBenefitsResponse	listBenefits(ListBenefitsRequest listBenefitsRequest)	Retrieves a paginated list of available benefits based on specified filter criteria.
default ListBenefitsIterable	listBenefitsPaginator(Consumer<ListBenefitsRequest.Builder> listBenefitsRequest)	This is a variant of listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) operation.
default ListBenefitsIterable	listBenefitsPaginator(ListBenefitsRequest listBenefitsRequest)	This is a variant of listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Retrieves all tags associated with a specific resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Retrieves all tags associated with a specific resource.
default RecallBenefitApplicationResponse	recallBenefitApplication(Consumer<RecallBenefitApplicationRequest.Builder> recallBenefitApplicationRequest)	Recalls a submitted benefit application, returning it to draft status for further modifications.
default RecallBenefitApplicationResponse	recallBenefitApplication(RecallBenefitApplicationRequest recallBenefitApplicationRequest)	Recalls a submitted benefit application, returning it to draft status for further modifications.
default PartnerCentralBenefitsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default SubmitBenefitApplicationResponse	submitBenefitApplication(Consumer<SubmitBenefitApplicationRequest.Builder> submitBenefitApplicationRequest)	Submits a benefit application for review and processing by AWS.
default SubmitBenefitApplicationResponse	submitBenefitApplication(SubmitBenefitApplicationRequest submitBenefitApplicationRequest)	Submits a benefit application for review and processing by AWS.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds or updates tags for a specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or updates tags for a specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes specified tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes specified tags from a resource.
default UpdateBenefitApplicationResponse	updateBenefitApplication(Consumer<UpdateBenefitApplicationRequest.Builder> updateBenefitApplicationRequest)	Updates an existing benefit application with new information while maintaining revision control.
default UpdateBenefitApplicationResponse	updateBenefitApplication(UpdateBenefitApplicationRequest updateBenefitApplicationRequest)	Updates an existing benefit application with new information while maintaining revision control.

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

amendBenefitApplication

default AmendBenefitApplicationResponse amendBenefitApplication(AmendBenefitApplicationRequest amendBenefitApplicationRequest)
                                                         throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.

Parameters:

amendBenefitApplicationRequest -

Returns:

Result of the AmendBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

amendBenefitApplication

default AmendBenefitApplicationResponse amendBenefitApplication(Consumer<AmendBenefitApplicationRequest.Builder> amendBenefitApplicationRequest)
                                                         throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.

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

Parameters:

amendBenefitApplicationRequest - A Consumer that will call methods on AmendBenefitApplicationRequest.Builder to create a request.

Returns:

Result of the AmendBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

associateBenefitApplicationResource

default AssociateBenefitApplicationResourceResponse associateBenefitApplicationResource(AssociateBenefitApplicationResourceRequest associateBenefitApplicationResourceRequest)
                                                                                 throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Links an AWS resource to an existing benefit application for tracking and management purposes.

Parameters:

associateBenefitApplicationResourceRequest -

Returns:

Result of the AssociateBenefitApplicationResource operation returned by the service.

See Also:

• AWS API Documentation

associateBenefitApplicationResource

default AssociateBenefitApplicationResourceResponse associateBenefitApplicationResource(Consumer<AssociateBenefitApplicationResourceRequest.Builder> associateBenefitApplicationResourceRequest)
                                                                                 throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Links an AWS resource to an existing benefit application for tracking and management purposes.

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

Parameters:

associateBenefitApplicationResourceRequest - A Consumer that will call methods on AssociateBenefitApplicationResourceRequest.Builder to create a request.

Returns:

Result of the AssociateBenefitApplicationResource operation returned by the service.

See Also:

• AWS API Documentation

cancelBenefitApplication

default CancelBenefitApplicationResponse cancelBenefitApplication(CancelBenefitApplicationRequest cancelBenefitApplicationRequest)
                                                           throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Cancels a benefit application that is currently in progress, preventing further processing.

Parameters:

cancelBenefitApplicationRequest -

Returns:

Result of the CancelBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

cancelBenefitApplication

default CancelBenefitApplicationResponse cancelBenefitApplication(Consumer<CancelBenefitApplicationRequest.Builder> cancelBenefitApplicationRequest)
                                                           throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Cancels a benefit application that is currently in progress, preventing further processing.

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

Parameters:

cancelBenefitApplicationRequest - A Consumer that will call methods on CancelBenefitApplicationRequest.Builder to create a request.

Returns:

Result of the CancelBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

createBenefitApplication

default CreateBenefitApplicationResponse createBenefitApplication(CreateBenefitApplicationRequest createBenefitApplicationRequest)
                                                           throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Creates a new benefit application for a partner to request access to AWS benefits and programs.

Parameters:

createBenefitApplicationRequest -

Returns:

Result of the CreateBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

createBenefitApplication

default CreateBenefitApplicationResponse createBenefitApplication(Consumer<CreateBenefitApplicationRequest.Builder> createBenefitApplicationRequest)
                                                           throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Creates a new benefit application for a partner to request access to AWS benefits and programs.

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

Parameters:

createBenefitApplicationRequest - A Consumer that will call methods on CreateBenefitApplicationRequest.Builder to create a request.

Returns:

Result of the CreateBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

disassociateBenefitApplicationResource

default DisassociateBenefitApplicationResourceResponse disassociateBenefitApplicationResource(DisassociateBenefitApplicationResourceRequest disassociateBenefitApplicationResourceRequest)
                                                                                       throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Removes the association between an AWS resource and a benefit application.

Parameters:

disassociateBenefitApplicationResourceRequest -

Returns:

Result of the DisassociateBenefitApplicationResource operation returned by the service.

See Also:

• AWS API Documentation

disassociateBenefitApplicationResource

default DisassociateBenefitApplicationResourceResponse disassociateBenefitApplicationResource(Consumer<DisassociateBenefitApplicationResourceRequest.Builder> disassociateBenefitApplicationResourceRequest)
                                                                                       throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Removes the association between an AWS resource and a benefit application.

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

Parameters:

disassociateBenefitApplicationResourceRequest - A Consumer that will call methods on DisassociateBenefitApplicationResourceRequest.Builder to create a request.

Returns:

Result of the DisassociateBenefitApplicationResource operation returned by the service.

See Also:

• AWS API Documentation

getBenefit

default GetBenefitResponse getBenefit(GetBenefitRequest getBenefitRequest)
                               throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves detailed information about a specific benefit available in the partner catalog.

Parameters:

getBenefitRequest -

Returns:

Result of the GetBenefit operation returned by the service.

See Also:

• AWS API Documentation

getBenefit

default GetBenefitResponse getBenefit(Consumer<GetBenefitRequest.Builder> getBenefitRequest)
                               throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves detailed information about a specific benefit available in the partner catalog.

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

Parameters:

getBenefitRequest - A Consumer that will call methods on GetBenefitRequest.Builder to create a request.

Returns:

Result of the GetBenefit operation returned by the service.

See Also:

• AWS API Documentation

getBenefitAllocation

default GetBenefitAllocationResponse getBenefitAllocation(GetBenefitAllocationRequest getBenefitAllocationRequest)
                                                   throws AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

Parameters:

getBenefitAllocationRequest -

Returns:

Result of the GetBenefitAllocation operation returned by the service.

See Also:

• AWS API Documentation

getBenefitAllocation

default GetBenefitAllocationResponse getBenefitAllocation(Consumer<GetBenefitAllocationRequest.Builder> getBenefitAllocationRequest)
                                                   throws AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

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

Parameters:

getBenefitAllocationRequest - A Consumer that will call methods on GetBenefitAllocationRequest.Builder to create a request.

Returns:

Result of the GetBenefitAllocation operation returned by the service.

See Also:

• AWS API Documentation

getBenefitApplication

default GetBenefitApplicationResponse getBenefitApplication(GetBenefitApplicationRequest getBenefitApplicationRequest)
                                                     throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves detailed information about a specific benefit application.

Parameters:

getBenefitApplicationRequest -

Returns:

Result of the GetBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

getBenefitApplication

default GetBenefitApplicationResponse getBenefitApplication(Consumer<GetBenefitApplicationRequest.Builder> getBenefitApplicationRequest)
                                                     throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves detailed information about a specific benefit application.

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

Parameters:

getBenefitApplicationRequest - A Consumer that will call methods on GetBenefitApplicationRequest.Builder to create a request.

Returns:

Result of the GetBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

listBenefitAllocations

default ListBenefitAllocationsResponse listBenefitAllocations(ListBenefitAllocationsRequest listBenefitAllocationsRequest)
                                                       throws AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves a paginated list of benefit allocations based on specified filter criteria.

Parameters:

listBenefitAllocationsRequest -

Returns:

Result of the ListBenefitAllocations operation returned by the service.

See Also:

• AWS API Documentation

listBenefitAllocations

default ListBenefitAllocationsResponse listBenefitAllocations(Consumer<ListBenefitAllocationsRequest.Builder> listBenefitAllocationsRequest)
                                                       throws AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves a paginated list of benefit allocations based on specified filter criteria.

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

Parameters:

listBenefitAllocationsRequest - A Consumer that will call methods on ListBenefitAllocationsRequest.Builder to create a request.

Returns:

Result of the ListBenefitAllocations operation returned by the service.

See Also:

• AWS API Documentation

listBenefitAllocationsPaginator

default ListBenefitAllocationsIterable listBenefitAllocationsPaginator(ListBenefitAllocationsRequest listBenefitAllocationsRequest)
                                                                throws AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

This is a variant of listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) 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.partnercentralbenefits.paginators.ListBenefitAllocationsIterable responses = client.listBenefitAllocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitAllocationsIterable responses = client
             .listBenefitAllocationsPaginator(request);
     for (software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitAllocationsIterable responses = client.listBenefitAllocationsPaginator(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 listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) operation.

Parameters:

listBenefitAllocationsRequest -

Returns:

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

See Also:

• AWS API Documentation

listBenefitAllocationsPaginator

default ListBenefitAllocationsIterable listBenefitAllocationsPaginator(Consumer<ListBenefitAllocationsRequest.Builder> listBenefitAllocationsRequest)
                                                                throws AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

This is a variant of listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) 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.partnercentralbenefits.paginators.ListBenefitAllocationsIterable responses = client.listBenefitAllocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitAllocationsIterable responses = client
             .listBenefitAllocationsPaginator(request);
     for (software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitAllocationsIterable responses = client.listBenefitAllocationsPaginator(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 listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) operation.

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

Parameters:

listBenefitAllocationsRequest - A Consumer that will call methods on ListBenefitAllocationsRequest.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

listBenefitApplications

default ListBenefitApplicationsResponse listBenefitApplications(ListBenefitApplicationsRequest listBenefitApplicationsRequest)
                                                         throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves a paginated list of benefit applications based on specified filter criteria.

Parameters:

listBenefitApplicationsRequest -

Returns:

Result of the ListBenefitApplications operation returned by the service.

See Also:

• AWS API Documentation

listBenefitApplications

default ListBenefitApplicationsResponse listBenefitApplications(Consumer<ListBenefitApplicationsRequest.Builder> listBenefitApplicationsRequest)
                                                         throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves a paginated list of benefit applications based on specified filter criteria.

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

Parameters:

listBenefitApplicationsRequest - A Consumer that will call methods on ListBenefitApplicationsRequest.Builder to create a request.

Returns:

Result of the ListBenefitApplications operation returned by the service.

See Also:

• AWS API Documentation

listBenefitApplicationsPaginator

default ListBenefitApplicationsIterable listBenefitApplicationsPaginator(ListBenefitApplicationsRequest listBenefitApplicationsRequest)
                                                                  throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

This is a variant of listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) 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.partnercentralbenefits.paginators.ListBenefitApplicationsIterable responses = client.listBenefitApplicationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitApplicationsIterable responses = client
             .listBenefitApplicationsPaginator(request);
     for (software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitApplicationsIterable responses = client.listBenefitApplicationsPaginator(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 listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) operation.

Parameters:

listBenefitApplicationsRequest -

Returns:

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

See Also:

• AWS API Documentation

listBenefitApplicationsPaginator

default ListBenefitApplicationsIterable listBenefitApplicationsPaginator(Consumer<ListBenefitApplicationsRequest.Builder> listBenefitApplicationsRequest)
                                                                  throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

This is a variant of listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) 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.partnercentralbenefits.paginators.ListBenefitApplicationsIterable responses = client.listBenefitApplicationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitApplicationsIterable responses = client
             .listBenefitApplicationsPaginator(request);
     for (software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitApplicationsIterable responses = client.listBenefitApplicationsPaginator(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 listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) operation.

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

Parameters:

listBenefitApplicationsRequest - A Consumer that will call methods on ListBenefitApplicationsRequest.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

listBenefits

default ListBenefitsResponse listBenefits(ListBenefitsRequest listBenefitsRequest)
                                   throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves a paginated list of available benefits based on specified filter criteria.

Parameters:

listBenefitsRequest -

Returns:

Result of the ListBenefits operation returned by the service.

See Also:

• AWS API Documentation

listBenefits

default ListBenefitsResponse listBenefits(Consumer<ListBenefitsRequest.Builder> listBenefitsRequest)
                                   throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves a paginated list of available benefits based on specified filter criteria.

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

Parameters:

listBenefitsRequest - A Consumer that will call methods on ListBenefitsRequest.Builder to create a request.

Returns:

Result of the ListBenefits operation returned by the service.

See Also:

• AWS API Documentation

listBenefitsPaginator

default ListBenefitsIterable listBenefitsPaginator(ListBenefitsRequest listBenefitsRequest)
                                            throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

This is a variant of listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) 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.partnercentralbenefits.paginators.ListBenefitsIterable responses = client.listBenefitsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitsIterable responses = client
             .listBenefitsPaginator(request);
     for (software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitsIterable responses = client.listBenefitsPaginator(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 listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) operation.

Parameters:

listBenefitsRequest -

Returns:

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

See Also:

• AWS API Documentation

listBenefitsPaginator

default ListBenefitsIterable listBenefitsPaginator(Consumer<ListBenefitsRequest.Builder> listBenefitsRequest)
                                            throws ValidationException,
AccessDeniedException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

This is a variant of listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) 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.partnercentralbenefits.paginators.ListBenefitsIterable responses = client.listBenefitsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitsIterable responses = client
             .listBenefitsPaginator(request);
     for (software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitsIterable responses = client.listBenefitsPaginator(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 listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) operation.

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

Parameters:

listBenefitsRequest - A Consumer that will call methods on ListBenefitsRequest.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

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ValidationException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves all tags associated with a specific resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ValidationException,
InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Retrieves all tags associated with a specific resource.

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

recallBenefitApplication

default RecallBenefitApplicationResponse recallBenefitApplication(RecallBenefitApplicationRequest recallBenefitApplicationRequest)
                                                           throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Recalls a submitted benefit application, returning it to draft status for further modifications.

Parameters:

recallBenefitApplicationRequest -

Returns:

Result of the RecallBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

recallBenefitApplication

default RecallBenefitApplicationResponse recallBenefitApplication(Consumer<RecallBenefitApplicationRequest.Builder> recallBenefitApplicationRequest)
                                                           throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Recalls a submitted benefit application, returning it to draft status for further modifications.

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

Parameters:

recallBenefitApplicationRequest - A Consumer that will call methods on RecallBenefitApplicationRequest.Builder to create a request.

Returns:

Result of the RecallBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

submitBenefitApplication

default SubmitBenefitApplicationResponse submitBenefitApplication(SubmitBenefitApplicationRequest submitBenefitApplicationRequest)
                                                           throws AccessDeniedException,
ValidationException,
InternalServerException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Submits a benefit application for review and processing by AWS.

Parameters:

submitBenefitApplicationRequest -

Returns:

Result of the SubmitBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

submitBenefitApplication

default SubmitBenefitApplicationResponse submitBenefitApplication(Consumer<SubmitBenefitApplicationRequest.Builder> submitBenefitApplicationRequest)
                                                           throws AccessDeniedException,
ValidationException,
InternalServerException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Submits a benefit application for review and processing by AWS.

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

Parameters:

submitBenefitApplicationRequest - A Consumer that will call methods on SubmitBenefitApplicationRequest.Builder to create a request.

Returns:

Result of the SubmitBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws AccessDeniedException,
ValidationException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Adds or updates tags for a specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws AccessDeniedException,
ValidationException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Adds or updates tags for a specified resource.

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AccessDeniedException,
ValidationException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Removes specified tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws AccessDeniedException,
ValidationException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Removes specified tags from a resource.

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateBenefitApplication

default UpdateBenefitApplicationResponse updateBenefitApplication(UpdateBenefitApplicationRequest updateBenefitApplicationRequest)
                                                           throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Updates an existing benefit application with new information while maintaining revision control.

Parameters:

updateBenefitApplicationRequest -

Returns:

Result of the UpdateBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

updateBenefitApplication

default UpdateBenefitApplicationResponse updateBenefitApplication(Consumer<UpdateBenefitApplicationRequest.Builder> updateBenefitApplicationRequest)
                                                           throws ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PartnerCentralBenefitsException

Updates an existing benefit application with new information while maintaining revision control.

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

Parameters:

updateBenefitApplicationRequest - A Consumer that will call methods on UpdateBenefitApplicationRequest.Builder to create a request.

Returns:

Result of the UpdateBenefitApplication operation returned by the service.

See Also:

• AWS API Documentation

create

static PartnerCentralBenefitsClient create()

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

builder

static PartnerCentralBenefitsClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PartnerCentralBenefitsServiceClientConfiguration 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